Difference between revisions of "Subforms Overview"

From ARK
Jump to: navigation, search
(Required Settings)
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
==Overview==
 
 
Subforms are a key building block of the ARK interface. Subforms are short php scripts that may have been written by either the core ARK team or as plugins. Please take care to read the inline documentation for each form.
 
Subforms are a key building block of the ARK interface. Subforms are short php scripts that may have been written by either the core ARK team or as plugins. Please take care to read the inline documentation for each form.
  
Line 5: Line 4:
  
 
Subforms may contain one or many fields and may contain mixed field types. Some subforms are more generic than others. sf_txt for instance is a very generic and multiuse subform whilst other subforms have a single very specific purpose and may require their own configuration options.
 
Subforms may contain one or many fields and may contain mixed field types. Some subforms are more generic than others. sf_txt for instance is a very generic and multiuse subform whilst other subforms have a single very specific purpose and may require their own configuration options.
 
==Required Settings==
 
 
*'''view_state'''
 
This controls the initial view state of the subform
 
'''Options:''' max, min
 
 
*'''edit_state'''
 
This controls the initial edit state of the subform
 
'''Options:''' view, edit
 
 
<pre>
 
'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',
 
</pre>
 
 
==Optional Settings==
 
 
==Subform Reference==
 
 
[[sf_assemblage]] - a subform to display and edit bulk assemblages
 
 
[[sf_spat]] - a subform to display spatial data about an item
 
  
 
[[category: Administrator]]
 
[[category: Administrator]]

Latest revision as of 08:46, 14 November 2008

Subforms are a key building block of the ARK interface. Subforms are short php scripts that may have been written by either the core ARK team or as plugins. Please take care to read the inline documentation for each form.

Subforms are configured on a 'use by use' basis by means of php arrays which are normally held in the mod_settings files. Each subform contains information about how it should display itself under default circumstances. It is highly likely that the same subform script may be used many times over within a given configuration but with different set up. Therefore each use of the subform requires a new config array.

Subforms may contain one or many fields and may contain mixed field types. Some subforms are more generic than others. sf_txt for instance is a very generic and multiuse subform whilst other subforms have a single very specific purpose and may require their own configuration options.