Difference between revisions of "Subform Requirements"

From ARK
Jump to: navigation, search
 
 
(5 intermediate revisions by one other user not shown)
Line 1: Line 1:
−
===Required Settings===
 
−
 
 
All subforms have a number of required settings.  A list of the current required settings for subforms follows:
 
All subforms have a number of required settings.  A list of the current required settings for subforms follows:
 +
*'''view_state''' - the default view state (min or max)
 +
*'''edit_state''' - the default edit state (edit or entry or view)
 +
*'''sf_nav_type''' - how to display the navigation in the subform (none, full, name, nmedit, nmmm, nmeditmm) - see below for details
 +
*'''sf_title''' - this is the nickname of markup to display in the title bar of the sf
 +
*'''sf_html_id''' - the form id tag (must be unique)
 +
*'''script''' - the script to use on this subform
  
−
*'''view_state'''
+
It is important when creating subforms to also insert the corresponding markup into ARK (the sf_title).  This can be accomplished using the [[Markup Administration]] tools.
−
This controls the initial view state of the subform
 
−
'''Options:''' max, min
 
  
−
*'''edit_state'''
+
===sf_nav_type===
−
This controls the initial edit state of the subform
 
−
'''Options:''' view, edit
 
  
−
*'''sf_nav_type'''
+
This variable controls how the navigation bar for each subform will be displayed. These are as follows:
−
This sets the type of navigation bar to put in at the top of the subform. 'full' gives you the full bar with navigational tools. 'name' give just the name and 'none' gives none at all.
 
−
'''Options:''' full, name, none
 
  
−
*'''sf_title'''
+
* '''none''' - Nothing will be displayed, no div will be used
−
This sets the title of the form. This value should be the nickname of a piece of [[markup]].
+
* '''full''' - Uses a div containing: The Title (h4) (markup), Edit options, Min Max options, arrows to move the sf around
−
'''Options:''' markup nickname
+
* '''name''' - Uses a div containing only the title (h4)
 +
* '''nmedit''' - Uses a div containing the title of the sf (h4) plus edit options
 +
* '''nmmm''' - Uses a div containing the title of the sf (h4) plus min-max options
 +
* '''nmeditmm''' - Uses a div containing the title of the sf (h4) plus edit options plus min-max options
  
−
*'''sf_html_id'''
+
====Example====
−
This sets the id attribute of the form tag and must be unique.
 
−
'''Options:''' string all lowercase
 
−
 
 
−
*'''script'''
 
−
This defines the script to be used.
 
−
'''Options:''' path/to/file.php
 
−
 
 
−
*'''Example
 
 
<pre>
 
<pre>
 
'view_state' => 'max',
 
'view_state' => 'max',
Line 36: Line 29:
 
'script' => 'php/mod_fst/subforms/monument.php',
 
'script' => 'php/mod_fst/subforms/monument.php',
 
</pre>
 
</pre>
 +
 +
 +
[[category: Administrator]]

Latest revision as of 14:41, 8 October 2009

All subforms have a number of required settings. A list of the current required settings for subforms follows:

  • view_state - the default view state (min or max)
  • edit_state - the default edit state (edit or entry or view)
  • sf_nav_type - how to display the navigation in the subform (none, full, name, nmedit, nmmm, nmeditmm) - see below for details
  • sf_title - this is the nickname of markup to display in the title bar of the sf
  • sf_html_id - the form id tag (must be unique)
  • script - the script to use on this subform

It is important when creating subforms to also insert the corresponding markup into ARK (the sf_title). This can be accomplished using the Markup Administration tools.

sf_nav_type

This variable controls how the navigation bar for each subform will be displayed. These are as follows:

  • none - Nothing will be displayed, no div will be used
  • full - Uses a div containing: The Title (h4) (markup), Edit options, Min Max options, arrows to move the sf around
  • name - Uses a div containing only the title (h4)
  • nmedit - Uses a div containing the title of the sf (h4) plus edit options
  • nmmm - Uses a div containing the title of the sf (h4) plus min-max options
  • nmeditmm - Uses a div containing the title of the sf (h4) plus edit options plus min-max options

Example

'view_state' => 'max',
'edit_state' => 'edit',
'sf_nav_type' => 'none',
'sf_title' => 'projection', //appears in the titlebar of the subform (mk nname)
'sf_html_id' => 'fst_cd_projection', //the form id tag (must be unique)
'script' => 'php/mod_fst/subforms/monument.php',
Retrieved from "https://ark.lparchaeology.com/wiki/index.php?title=Subform_Requirements&oldid=2097"