Admin No Frameset

From TNG_Wiki
Jump to: navigation, search
Construction This brand-new mod is in a beta testing state, so use it with caution. In particular, since it modifies adminlib.php and affects ALL admin programs, you definitely should back up adminlib.php before installing it.
Robin Richmond 2 May 2020
Construction


Admin No Framset
Summary Adds menus to all Admin pages that effectively replace the upper and left-side frames in the Admin frameset, allowing all admin programs to run outside of the frameset.
Validation
Mod Updated 2 May 2020
Download link 12.0.0.0h.zip
TNG 12.0
Download stats
Author(s) Robin Richmond
Homepage this page
Mod Support My Mod Support form or TNG Community Forums
Contact Developer My Mod Support form
Latest Mod 12.0.0.0h
Min TNG V 12.0
Max TNG V 12.3
Files modified
adminlib.php, admin_genconfig.php, admin_updateconfig.php, English cust_text.php.

Installs rrnoframeset_home.php, rrnoframes_adminlib_include.php, rrnoframes_config_include.php, several icon files.


May Install rrshared_innermodmenu4.php, rrshared_modsettingsblocks4.php, rrshared_wikilogo.gif
Related Mods
Notes

Purpose of the Mod

To allow TNG admins to simplify the Admin menu by limiting it to a set of selected Admin programs (with, of course, the ability to expand to the entire set), and to allow all admin programs to run outside of the standard admin frameset. Among other advantages, running outside of the frameset:

  1. Allows each admin program to be invoked directly,
  2. Puts the admin program's title in the browser's title box, and
  3. Puts the admin program's address in the browser's address bar.

Both the left-hand menu and the upper-right menus are optional and are inside the un-framed admin page, not in frames. In this screen clip

  1. You can see that the left-hand menu looks almost the same as the native frameset's left-hand menu, except that the administrative programs are defined in three submenus:
    • "Operations" - Import/Export, Miscellaneous, Mod Manager, Setup, and Utilities (in alphabetical order)
    • "Objects", which lists 6 of TNG's Admin programs that have been selected by the TNG admin.
    • "More Object", which, when opened, lists all the rest of the admin programs.
  2. In the upper right, the first two buttons are just links to the Admin and End-user home pages, and the other two buttons are pull-down menus that correspond to the "Operations" and "Objects" submenus in the left-hand menu.

Admin no frameset-bothmenus.jpg

Mod Options

This mod's options are implemented as custom TNG settings, in a new 'Mod Settings Block at Admin>>Setup>>General Settings>>Robin's Mods. The options and their effects are described and illustrated here.

[See details]
  1. The default Admin Home Page can be
    • The native framed home page,
    • A custom unframed home page that includes (as the page loads) only a limited set of admin programs, or
    • Any specific admin program.
  2. The status of a "Leave Frameset" box that can be put on the framed admin home page.
  3. The status of a "Leave Frameset" box that can be put on all admin pages that are displayed within the frameset.
  4. The choice of either or both of two sets of menus that provide the navigation choices of the top frame and left-hand from in the standard Admin frameset.]
    • A slide-away left-hand menu that looks very much like the left-hand menu from the frameset.
    • A set of buttons in the upper-right of each admin page. Two of the buttons are simply links to the Admin and End-user home pages, and the other two drop down lists of links to "Operations" (Mod Manager, Setup, Import/Export, Utilities, and Miscellaneous) and "Objects" (People, Places, Media, Users, Reports, etc.)
    • Whether the slide-away left-hand menu should be visible or slid away when an admin program first loads.
    • The set of programs to show in the new Unframed home page and in the two sets of admin menus.
    • Whether to sort the choices in the admin menus, or leave them in the same order as the native admin menus.
Admin no frameset-modsettingsblock.jpg
[Hide details]

Compatibility

No other mods affect adminlib.php, but the effects of mods that change the admin home page may be lost. This mod does incorporate the links installed in the top frame by Prolog and an error log mod by Key Roy whose name escapes me at the moment.

Installation

Files Installed

This mod has two mod subfolders:

  1. admin_no_frameset_v12.0.0.0h - The subfolder that you expect to exist for any mod that installs files. It contains
    1. rrnoframeset_home.php - An stand-alone unframed home page that can have a limited set of admin program options when it first loads.
    2. rrnoframes_adminlib_include.php - An library of PHP functions that is included in adminlib.php. Its functions display the optional administrative menus that this mod adds to admin programs.
    3. rrnoframes_config_include.php - An Include file for admin_genconfig.php (Admin>>Setup>>Generasl Settings) that defines this mod's mod options.
    4. rrnoframes_open.gif & rrnoframes_close.gif - Icons that hide and reveal the left-hand menu.
    5. rrnoframes_whitedown.gif & rrnoframes_whiteright.gif - Icons that hid and open submenus in the left-hand and upper-right menus.
  1. The shared folder RR-shared_mod_includes_v12.0.0.4, which contains files that help to manage mod options in many of my mods. It contains
  2. rrshared_modsettingsblocks4.php, an Include file that builds https://tng.lythgoes.net/wiki/index.php?title=Inner_Mod_Menus Inner Mod Menus] from convention HTML layout tables that my mods place in Admin>>Config programs.
    1. img/rrshared_wikilogo.gif - An icon that links to a mod's TNG Wiki page from a Mod Settings Block

Each mod that contains the shared folder RR-shared_mod_includes_v12.0.0.4 may install both of its files, depending on whether those files have already been installed by another mod that implements Mod Settings Blocks. Once a file from the shared folder has been installed (by any mod), that file will not be overwritten or removed by the subsequent installation or un-installation of any mod (including this one), nor will its presence generate any Mod Manager errors in uninstalled mods.

If you unzip mod distribution files directly into your mods folder, then the presence of the shared subfolder and the installation of its files should be invisible to you. But if you generally copy mod subfolders to your mods folder after you have unzipped the distribution file, then you need to make sure to copy the shared subfolder (well, unless you are confident that it is already in your mods folder because it was part of another mod).
[Show Installation Details]

Requirements

  • A working TNG installation.
  • An installed current version of the Mod Manager.
  • You should backup files listed in the panel on the right.

Procedure

  1. Remove and delete previous version of this mod.
  2. Backup the files updated by this mod. They are listed in the panel at the upper right.
  3. Download the .zip file, Extract its .cfg file to the mods folder.
  4. Follow the normal automated installation for Mod Manager, as shown in the example Mod Manager - Installing Config Files.

Problems?

  1. Try using the Mod Manager Remove capability
  2. Contact me through My Mod Support form.
[Hide Details]

Visualizations

1. The Unframed Admin Home Page showing the programs that have been selected to be displayed in this page and in the Admin menus, plus a link that displays the rest of the Admin programs
Admin no frameset-homepage.jpg
  • This screen clip reveals that the mod options that sort the admin programs alphabetically have been set.
  • All 5 of the "Operations" are always displayed. In this case, 6 "Objects" have been selected.
  • You can see the links that display tiles for the rest of the Objects
  • This left-hand menu is identical to the one that can be displayed on all admin programs. The left-pointing arrow next to the large TNG logo will slide the menu to the left, hiding it except for a sliver with an arrow that can slide it back into view.
2. The Unframed Admin Home Page, showing how the rest of the Objects are displayed in both columns of tiles.
Admin no frameset-homepage-allobjects.jpg
As you might expect, the "Other Objects" in the left-hand column are displayed by clicking on that menu's "Other Objects" subheading.
3. The Left-Hand Menu - Hidden
Admin no frameset-modmanager.jpg
In truth, the left-hand menu is always hidden as Mod Manager programs are displayed, since the Mod Manager headings do not play well with the left-hand menu. When the arrow icon at the very upper left in this screen clip is clicked to slide the menu open, the menu covers the left inch or so of the Mod Manager page. But in other admin pages, the content shift to the right to accommodate the menu.
4. The upper-right "Operations" menu
Admin no frameset-shortleft-operations.jpg
This visualization illustrates two features:
  1. The Operations menu always includes all five "Operations" programs, plus a couple of miscellaneous links (including the logout link for the test site user "a"), and the links from the upper navigation menu in the admin frameset.
  2. When a page, such as this one, is short, the entire left-hand menu is not visible, and (assuming that the administrator has elected not to display the menus in the upper-right), the "More Objects" and "Top-Row Links" sub-menus will initially be invisible. But the "Operations" and "Objects" sub-menus can be closed to allow the other sub-menus to be displayed.
5. The upper-right "Objects" menu showing the six selected Object and a submenu heading for all other objects
Admin no frameset-bothmenus.jpg
Remember that the left-hand menu and/or the upper-right menus can be suppressed by a mod option.

Revision History

Mod Version TNG Version Date Note
12.0.0.0h 12.0-12.3 02 May 2020 Initial beta release.

Sites using this mod

If you download and install this mod, please add your site to the table below.

URL User Note Mod Version TNG Version User language
(Admin program; Not visible) Robin Richmond Mod developer 12.0.0.0h 12.3 English