Template:Deptree set/doc

From Ring of Brodgar
Jump to navigation Jump to search
Description
This template is used to fill Dependency-Tree(dpt) SMW property sub-objects.
Which in turn can be used to draw dependency-tree gfx-boxes (See:Skills & Credo pages)
In generally this is not intended to be done on subject pages themself. But inside infobox related templates. (Credo page being the exception in this case.)


Syntax
General syntax: {{deptree_set|<dpt-id-name>|p=<parent>|<List_of_names>}}.
Where:
  • dpt-id-name: Mandatory short id name, which should be the same for all data related to the same dependency-tree.
    This name is used as part of the property-names to save this data-set.
    (always first).
  • p=<parent>: Optional input to specify the parent page.
    Normally not needed, in which case the name of the initial source page is used.
    (best used as second parameter for readability sake.)
  • List_of_names: Comma separated list of related child names. (aaa,bbb,ccc,...)
    Normally these should be names of existing pages. (In the Credo-exception case they jump to the related credo-section, due to related redirects.)
    (always after dpt-id-name input. Best used last.)


Inside some called template, like an infobox templates, one would use {{deptree_set|<dpt-id-name>|{{List_normalize| {{{<var>}}} }}}}.
Where the {{{<var>}}} input parameter would contain the list. (The 'List_normalize' part is a general list-cleaner template.)


Technical info
Used property names: "dpt_<dpt-id-name>_prt"(parent) & "dpt_<dpt-id-name>_chl"(child). (properties best setup as keyword types.)
The Skill and Credo data could technically be saved in the same parent+child properties because both sets don't overlap. (ie: neither set uses a name that is used in the other set) (Might be potentially useful in some cases.)