Template:Documentation itemlist

Template documentation

[view] [edit] [history] [purge]

Function

This template and it's co-working templates produce a formatted description list for general purpose use.

Please note that this method in a makeshift manner and are in need of some inprovements, e.g. using CSS, being closed in a single template, etc. Therefore, your contributions are highly appreciated.

Usage

{{documentation itemlist/begin}}
{{documentation itemlist
|name= item_name_1
|desc= item_description_1
|opt=  optional / mandatory / blank
|def=  default value_1
}}
{{documentation itemlist
|name= item_name_2
|desc= item_description_2
|opt=  optional / mandatory / blank
|def=  default value_2
}}
:
{{documentation itemlist/end}}

Parameters

name	–	the name of this item.
desc	–	A description of this item.
opt	–	Describs that this item is mandatory or optional.
def	–	The default value of this item.

Examples

The code of "Parameters" section above is:

{{documentation itemlist/begin}}
{{documentation itemlist
|name= name
|desc= the name of this item.
|opt=  mandatory
|def=
}}
{{documentation itemlist
|name= desc
|desc= A description of this item.
|opt=  mandatory
|def=
}}
{{documentation itemlist
|name= opt
|desc= Describs that this item is mandatory or optional.
|opt=  optional
|def=  ''blank''
}}
{{documentation itemlist
|name= def
|desc= The default value of this item.
|opt=  optional
|def=  ''blank''
}}
{{documentation itemlist/end}}

Related templates

• Template:Documentation itemlist/begin – the opener tag of {{documentation itemlist}}.
• Template:Documentation itemlist/end – the closer tag of {{documentation itemlist}}.
• Template:Documentation – displays a template documentation.

The above documentation is transcluded from Template:Documentation itemlist/doc. (edit | history)
Editors can experiment in this template’s sandbox (create | mirror) and testcases (create) pages.
Please add categories to the /doc subpage. Subpages of this template.