Simple Groupware sgsML reference guide

This guide describes all aspects of sgsML. Starting from tags and attributes to custom trigger functions, modifiers, formatters and validators.

Tag structure


  • <table>
    • <view>
      • <sqlwhere> (optional)
      • <showonly> (optional, not multiple)
    • <tab>
    • <viewbutton> (optional)
    • <singlebutton> (optional)
    • <rowfilter> (optional)
    • <rowvalidate> (optional)
    • <field>
      • <data> (optional)
      • <filter> (optional)
      • <validate> (optional)
      • <store>, <restore> (optional)
      • <link>, <linktext> (optional)
      • <notin>, <onlyin>, <readonlyin> (optional)
      • <description> (optional)


<table> tag


Attributes:

  • modulename: name of the module in the GUI, e.g. modulename="Contacts"
  • TODO:
  • load_library="VALUE"
  • cust_name="VALUE"
  • name="VALUE"
  • default_view="VALUE"
  • orderby="VALUE"
  • order="VALUE"
  • groupby="VALUE"
  • group="VALUE"
  • limit="VALUE"
  • where="VALUE"
  • sql_handler="VALUE"
  • default_sql="none|no_select"
  • template="VALUE"
  • enable_new="true"
  • enable_edit="true"
  • enable_delete="true"
  • enable_empty="true"
  • enable_purge="true"
  • enable_purgeall="true"
  • disable_{history|index|schema|search|copy|structure|rights|etc}="true"
  • enable_calendar="VALUE"
  • show_calendar="false"
  • trigger_new|trigger_new_ccp|trigger_edit|trigger_delete|trigger_delete_ccp="{trigger_}VALUE"
  • no_search_index="true"


<view> tag


Attributes:

  • name: alphanumeric identifier of a view (required), example: name="display"
  • TODO:
  • displayname: VALUE
  • default_sql="none|no_select"
  • template="VALUE"
  • schema="sys_nosql_structure"
  • sql_handler="VALUE"
  • schema_mode="edit|create|edit_as_new"
  • showinsingleview="true"
  • image_width="VALUE"
  • image_height="VALUE"
  • show_preview="true"
  • orderby="VALUE"
  • order="VALUE"
  • limit="VALUE"
  • where="VALUE"
  • visibility="hidden|active|bottom"
  • groupby="VALUE"
  • group="VALUE"
  • nosinglebuttons="true|VALUES"
  • singlebuttons="VALUES"
  • noviewbuttons="true|VALUES"
  • viewbuttons="VALUES"
  • nosqllimit="true"
  • function="{custom_}FUNCTION"
  • doubleclick="VALUE|none"
  • nosqlorder="true"
  • nosqlwhere="true"
  • nosqlfolder="true"
  • template_mode="{details}small|flat|noheader"
  • tfield_1="{details}VALUE"
  • tfield_2="{details}VALUE"
  • disable_tabs="true"
  • hide_tabs="VALUES"

Sub-tags:

  • <sqlwhere> (optional)
  • <showonly> (optional, not multiple)


<field> tag


Attributes:

  • TODO:
  • name="VALUE"
  • width="VALUE"
  • displayname="VALUE"
  • simple_default="VALUE"
  • simple_size="VALUE"
  • simple_default_function="{modify::}FUNCTION|ARGS2_1|ARGS2_2"
  • simple_tab="VALUES"
  • allow_custom="true"
  • required="true"
  • notinall="true"
  • no_search_index="true"
  • db_size="VALUE"
  • db_type="VALUE" {multiple}
  • simple_type="int|float|text|password|id|select |dateselect|wikiarea|textarea|htmlarea |spreadsheet|checkbox|file|file_image|date |time|datetime"
  • width="VALUE"
  • is_unique="true"
  • is_unique_ccp="true"
  • nowrap="true"
  • nodb="true"
  • hidden="true"
  • editable="true"{with hidden=true}
  • readonlyall="true"
  • sum="true"
  • disable_ccp="true"

Sub-tags:

  • <data> (optional)
  • <filter> (optional)
  • <validate> (optional)
  • <store>, <restore> (optional)
  • <link>, <linktext> (optional)
  • <notin>, <onlyin>, <readonlyin> (optional)
  • <description> (optional)
  • <KEY>, <INDEX>, <INEX_FULLTEXT>


more coming up soon ...