by IWR Consultancy
 

Command Parameters

Hyperframe supports a number of parameters which can be appended to the page URL, and which cause specific changes to the way in which the page is handled. These can be used in permanent links, but they are typically aimed at developers, as a quick way of testing changes without altering the default setup.

?frame=[frame_name]
This will cause the frame for this page to be loaded from a different subdirectory in the frame collection. As of v3.1 this change is now 'sticky' and will last for the current browser session, or until another ?frame= parameter is encountered. This overrides the 'frame=' setting in siteini.php. Note that by design it cannot override any 'hf_frame' meta tag in the page head, therefore some pages may still display with a hardcoded frame setting. A value of '?frame=default' will clear the user frame selection.

?hide=[banner,top,left,content,right,bottom]
The listed page sections, separated by commas, will not be displayed.
Relies on the respective IDs being present in frame.php, eg id='hf_top'.
'all' can be used to display the page on its own without a frame, although with the frame stylesheet still applying.
This change is not sticky. See the Page Head item for how to make these changes permanent.

?menu=top
Overrides the default cascading menu placement, which is normally side. Does not remove the sidebar, but turns the top quicklink menu into a full menu. Normally used in conjunction with &hide=left in testing pages which require full width. Only effective on pages where the principal menu is at the side. 

?style=[style]
Presently the only option is ?style=print which presents the content only, for printing. May be expanded to allow sylesheet testing. 

?noadmin=true
Causes the page to be displayed as if in viewing mode, even if  you are in edit mode. Mainly useful when viewing a page in a separate browser tab to see how scripted content will render. No effect in view mode. Effectively similar to pressing the Preview button in the editing toolbar.

?debug=1 (or 2)
Displays various pieces of information about ajax data transfers when in admin mode. Mainly useful for system development.  No effect in view mode, or if the user is not a site admin (Privelege 5). 

Example of usage:

  parameters.php?hide=banner,left&menu=top

 

 

Powered by Hyperframe