Difference between revisions of "Subform Options"

From ARK
Jump to: navigation, search
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
This is a rough and ready list of op_ setting that can be added to subforms. Options are by their nature optional. Do NOT add any options that must be set (these should be given proper names and descibed
+
Optional settings should all be defined using the 'op_' prefix. The optional settings described here are generic to all subforms. Other script specific settings should be documented IN THAT SCRIPT.
  
===op_xmi_sorting===
+
This is a rough and ready list of op_ setting that can be added to subforms. Options are by their nature optional. Do NOT add any options that must be set (these should be given proper names and descibed under [[Subform Requirements]]).
  
* Name: op_xmi_sorting
+
*'''op_label''' - the label for the options row of the form (markup nname)
* Type: Subform Specific
+
*'''op_input''' - the label to appear in the button (markup nname)
* Subform: sf_xmi
+
*'''op_register_mod''' - used to change sf_key of the register sf, embedded registers need this (note this is fundamental in overlays as you would only use this to add records in a different module)
* Requires: op_xmi_sort_field
+
*'''op_modtype''' - TRUE (using different fields for each modtype) or FALSE (using one fields list for all different modtypes)
 +
*'''op_src_meta_display''' - required in any subform with a mini search box made by mkSearchSimple(), requires an array ($conf_''mod''_res_meta_fields) to be setup for the module being searched, this option switches on the display of meta fields for the module being searched (eg always show a contact's name when searching the ABK)
  
This is a switch to allow sorting of XMIed items by some field connected to the item. The default is to sort by the itemval.
+
[[Category: Developer]][[Category: Administrator]]
 
 
===op_xmi_sort_field===
 
 
 
* Name: op_xmi_sort_field
 
* Type: Subform Specific
 
* Subform: sf_xmi
 
* Requires: op_xmi_sorting
 
 
 
This option requires 'op_xmi_sorting' to be set TRUE. This should be populated with the full field array that is desired.
 
 
 
===op_xmi_sort_field===
 
 
 
* Name: op_src_meta_dsiplay
 
* Type: Subform Specific
 
* Subform: anything with a mini search box made by mkSearchSimple()
 
* Requires: an array ($conf_''mod''_res_meta_fields) to be setup for the mod being searched
 
 
 
This option switches on the display of meta fields for the module being searched. eg always show a contact's name when searching the ABK.
 
 
 
[[Category: Developer]]
 

Latest revision as of 12:41, 20 November 2011

Optional settings should all be defined using the 'op_' prefix. The optional settings described here are generic to all subforms. Other script specific settings should be documented IN THAT SCRIPT.

This is a rough and ready list of op_ setting that can be added to subforms. Options are by their nature optional. Do NOT add any options that must be set (these should be given proper names and descibed under Subform Requirements).

  • op_label - the label for the options row of the form (markup nname)
  • op_input - the label to appear in the button (markup nname)
  • op_register_mod - used to change sf_key of the register sf, embedded registers need this (note this is fundamental in overlays as you would only use this to add records in a different module)
  • op_modtype - TRUE (using different fields for each modtype) or FALSE (using one fields list for all different modtypes)
  • op_src_meta_display - required in any subform with a mini search box made by mkSearchSimple(), requires an array ($conf_mod_res_meta_fields) to be setup for the module being searched, this option switches on the display of meta fields for the module being searched (eg always show a contact's name when searching the ABK)