Difference between revisions of "The ARK Help System"

Revision as of 14:38, 9 June 2014

As of version 1.2 - a field-level help system has been introduced to ARK.

The help system works by using the Markup system to attach chunks of Markup to specific fields. There is very little configuration needed to enable the help system.

A new subform conf will need to be entered in the settings.php file:

$conf_mcd_help =
    array(
        'view_state' => 'max',
        'edit_state' => 'view',
        'sf_nav_type' => 'nmedit',
        'sf_title' => 'help', 
        'sf_html_id' => 'help', // Must be unique
        'script' => 'php/subforms/sf_help.php',
        'op_modtype' => FALSE, //if each modtype uses same fields (see below)
        'fields' =>
            array(
        )
);

This needs to be named $conf_mcd_help, otherwise the help system will not be able to find it. The subform has one 'op' value that can be applied:

'op_textile' => TRUE

If this op is specified, then the help will be printed using the Textile tool - which means it can be used to print complex formatted HTML (along with images, etc.). For more information on Textile see this link: http://txstyle.org/