Subforms Overview - Revision history

Andydufton at 08:46, 14 November 2008

2008-11-14T08:46:17Z

2008-11-13T12:51:51Z

2008-11-13T12:50:23Z

2008-03-06T11:48:46Z

‎Subform Reference

2008-03-05T13:54:31Z

‎Optional Settings

2008-03-05T13:51:38Z

‎Required Settings

2008-03-05T13:40:31Z

‎Required Settings

2008-03-05T13:34:56Z

‎Required Settings

2008-03-05T13:34:44Z

‎Required Settings

2008-03-05T13:30:06Z

@@ Line 1: / Line 1: @@
 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.
 [[category: Administrator]]

← Older revision		Revision as of 12:51, 13 November 2008
Line 6:		Line 6:
	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.

−
−	~~==Optional Settings==~~
−
−	optional settings ''should'' all be defined using the 'op_' prefix, however some are not. The optional settings described here are generic to all subforms. Other script specific settings should be documented IN THAT SCRIPT.

	==Subform Reference==		==Subform Reference==

@@ Line 1: / Line 1: @@
-==Overview==
+===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.
@@ Line 6: / Line 6: @@
 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.
 ==Optional Settings==

← Older revision		Revision as of 11:48, 6 March 2008
Line 51:		Line 51:

	[[sf_spat]] - a subform to display spatial data about an item		[[sf_spat]] - a subform to display spatial data about an item
		+
		+	[[sf_finds]] - subform to attach attribs of a given type (findtypes) and to set a boolean for each one

	[[category: Administrator]]		[[category: Administrator]]

← Older revision		Revision as of 13:54, 5 March 2008
Line 43:		Line 43:

	==Optional Settings==		==Optional Settings==
		+
		+	optional settings ''should'' all be defined using the 'op_' prefix, however some are not. The optional settings described here are generic to all subforms. Other script specific settings should be documented IN THAT SCRIPT.

	==Subform Reference==		==Subform Reference==

@@ Line 16: / Line 16: @@
 '''Options:''' view, edit
 <pre>
 'view_state' => 'max',

← Older revision		Revision as of 13:40, 5 March 2008
Line 7:		Line 7:

	==Required Settings==		==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>		<pre>

@@ Line 8: / Line 8: @@
 ==Required Settings==
 'view_state' => 'max',
 'edit_state' => 'edit',
@@ Line 14: / Line 15: @@
 'sf_html_id' => 'fst_cd_projection', //the form id tag (must be unique)
 'script' => 'php/mod_fst/subforms/monument.php',
 ==Optional Settings==

← Older revision		Revision as of 13:34, 5 March 2008
Line 7:		Line 7:

	==Required Settings==		==Required Settings==
		+
		+	'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',

	==Optional Settings==		==Optional Settings==

← Older revision		Revision as of 13:30, 5 March 2008
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 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.
		+
		+	==Required Settings==
		+
		+	==Optional Settings==
		+
		+	==Subform Reference==
		+
	[[sf_assemblage]] - a subform to display and edit bulk assemblages		[[sf_assemblage]] - a subform to display and edit bulk assemblages