Subform Options

From ARK
Revision as of 11:31, 14 November 2008 by Andydufton (talk | contribs)

Jump to: navigation, search

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 - embedded registers need this
  • op_subform_style - embedded registers need this set TRUE to display like an sf
  • op_modtype - TRUE (using different fields for each modtype) or FALSE (using one fields list for all different modtypes)
  • op_lightbox - using lightbox in this subform (TRUE/FALSE)

  • Spans:
  • op_fancylabels = fancy labels for a span or not (off or on)
  • op_fancylabel_dir = direction of the span (topdown or centric)
  • op_spantype = name of the spantype (table: cor_lut_spantype, field: spantype)


  • Name: op_xmi_sorting
  • Type: Subform Specific
  • Subform: sf_xmi
  • Requires: op_xmi_sort_field

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.


  • 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.


  • Name: op_src_meta_display
  • 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.