Difference between revisions of "Left panel"
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
| + | The left panel is used in every page, and configured using various subforms and linklists to output relevant links in all pages. The left panel configuration options as described below, currently primarily apply to the user home, data entry, and micro view pages. | ||
==Left Panel Configuration== | ==Left Panel Configuration== | ||
As of v0.8 there are two configuration options (Option 1: Link list or Option 2: Subform) which may be used to provide users with links in the left panel. The left panel now follows the subform-linklist options for all views including the user home, data entry and micro view (record view) left panels- not including the search-data view). Both options require the option to be defined first, i.e. $delpoutput = 'subforms'; OR $delpoutput = 'linklist'; (this example is for data entry). It should be noted that if this is not set, the left panel sets this to 'linklist' by default. | As of v0.8 there are two configuration options (Option 1: Link list or Option 2: Subform) which may be used to provide users with links in the left panel. The left panel now follows the subform-linklist options for all views including the user home, data entry and micro view (record view) left panels- not including the search-data view). Both options require the option to be defined first, i.e. $delpoutput = 'subforms'; OR $delpoutput = 'linklist'; (this example is for data entry). It should be noted that if this is not set, the left panel sets this to 'linklist' by default. | ||
Latest revision as of 16:24, 24 February 2011
The left panel is used in every page, and configured using various subforms and linklists to output relevant links in all pages. The left panel configuration options as described below, currently primarily apply to the user home, data entry, and micro view pages.
Left Panel Configuration
As of v0.8 there are two configuration options (Option 1: Link list or Option 2: Subform) which may be used to provide users with links in the left panel. The left panel now follows the subform-linklist options for all views including the user home, data entry and micro view (record view) left panels- not including the search-data view). Both options require the option to be defined first, i.e. $delpoutput = 'subforms'; OR $delpoutput = 'linklist'; (this example is for data entry). It should be noted that if this is not set, the left panel sets this to 'linklist' by default.
Option 1 - Link list
This is a simple list of links that will be formatted and outputted into the left panel, and has been the default mechanism for configuring links in the left panel to date. This usually requires administrators to configure individual links for registers and detailed forms (view). Each link requires the following:
- href - link to the output
- mknname - mark-up nickname will search the markup table for this nickname and print the markup
- img - link to an image used
within the 'href' the following vars need to be set up (see example below):
- view - the view the link should point to (regist, detfrm, files or a custom view)
- item_key - itemkey to point to if any (cxt_cd, smp_cd)
Option 2 - Subform
As of v0.8 subforms can be executed within the left panel. This opens the door for a range of custom subforms to be written providing useful user interface features. This also permits us to use conditional behaviours for the panel.
In order to set this up correctly, you need to set up a subform and place it within a column as you would in data entry or micro view. In order to use the sf_linklist (as in the above example) create a link list array according to the criteria for option 1 (see above) and then put this into the 'fields' element of the subform instead of an array of fields. This is documented within the page for this subform as this is now a behaviour specific to this subform. The example below also uses the sf_module to define the modules to display in the left panel, which gives the option of inserting icons for the detailed forms and registers if they are configured in the mod_settings.
