Page settings.php

From ARK
Revision as of 13:52, 24 February 2011 by Jessogden (talk | contribs)

Jump to: navigation, search

Include Server Settings

And include the settings related to your server environment contained within the env_settings.php:

// Include settings related to your server environment


Navigation Pages

Unless listed in this array, all pages will appear in the main nav.

$conf_hide_pages =

Navigation Links

Configure to state what links will appear in the end of the navigation bar.

$conf_linklist =
        'file' => 'index.php',
        'vars' => 'logout=true',
        'label' => 'logout'

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.

Example of left panel in data entry configured with linklist

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)
Example of left panel in data entry configured with subforms (sf_module and sf_linklist)

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.

User Home

These settings control the subforms and left panel in the user home. The user home needs configuration both for the left panel and for the subforms included in the main area.

User Home Left Panel

Configures the left panel in the user home pages, requires the administrator to configure the lpanel with either Option 1 (linklists) or Option 2 (subforms). Requires the $uhlpoutput to be set, and when using the subform option requires the 'ark_page' to be set to 'user_home' in the sf_module.

Subforms Option Example

Define the configuration type:

$uhlpoutput = 'subforms';

Configure the subform:

$uhlp_subform_module =
        'view_state' => 'max',
        'edit_state' => 'view',
        'sf_nav_type' => 'none',
        'sf_title' => 'mvlpmodlist', 
        'sf_html_id' => 'mvlpmodlist', // Must be unique
        'script' => 'php/subforms/sf_module.php',
        'ark_page'=> 'user_home',
        'fields' => array (

Load the subform:

$user_home_left_panel =
        'col_id' => 'mvlp',
        'col_alias' => FALSE,
        'col_type' => 'primary_col',
        'subforms' =>