Loading...
 
Skip to main content

History: Module Handler

Source of version: 10 (current)

Copy to clipboard
            This is a ((Handler)) which allows to assign modules on the left and right columns of Tiki.

! Complete sample for Translation module
{CODE(caption=>YAML)}
preferences:
 enable: [ feature_multilingual, feature_wiki ]
objects:
 -
  type: module
  data:
   name: translation
   position: left
   order: 1
   groups: [ Editors, Translators ]
   params:
    pivot_language: en
{CODE}

! Module Object
||__Field Name__|__Mandatory__|__Value__
name|yes|The name of the module as listed in the administration panel, or any name if __custom__ is used.
position|yes|''left'' or ''right''
order|yes|Numeric value, lower values are displayed above
cache| |Default ''0'', time to cache in seconds
rows| |Amount of rows to display
groups| |List of group names allowed to view the module
params| |Generic list of key value pairs. Options depend on the module definition.
custom| |String containing the body of a user module. When this option is used, a user module with the same name will be created.
parse| |Wiki parse custom module data. ''(Tiki 9.1+)''
||

__Notes:__
*''custom:'' can support multiple lines of content if you use html for line breaks (no returns allowed), or format as a [http://yaml.org/spec/current.html#id2540046|YAML "Literal Block"]