Difference between revisions of "Template:Infobox/doc"
From Salem Wiki
(moved Template:Infobox/doc to Template:Infobox/doc old: This was related to the old manual way, now with auto-info things changed) |
m (New documentation) |
||
| Line 1: | Line 1: | ||
| − | + | {{tocright}} | |
| + | ==Description== | ||
| + | :This template is used to create an information-box to automatically display different kinds of info, depending on properties set on the page it is displaying this info for. | ||
| + | :It relies on properties set using {{t|SetProp}}. | ||
| + | |||
| + | ==Syntax== | ||
| + | :Type the below code at the top of the page, with values assigned to relevant parameters. | ||
| + | :Parameters can be in any order, and not all need to be used. | ||
| + | :The shown parameters to {{t|SetProp}} are examples and most used, see its documentation for all propname's. | ||
| + | :You can remove the unused ones if they are not likely to be set for your page. | ||
| + | <pre> | ||
| + | {{SetProp | ||
| + | |IsinGameMenu= | ||
| + | |Caption= | ||
| + | |Has fullview={{SUBPAGENAME}}.png | ||
| + | |RequiresTech= | ||
| + | |RequiresObj= | ||
| + | |RepairedWith= | ||
| + | |IsLiftable=y/n (or IsLiftableWhenEmpty=y) | ||
| + | |HP=0 | ||
| + | |Soak=0 | ||
| + | }}{{Infobox}} | ||
| + | |||
| + | ==About==</pre> | ||
| + | {| class="wikitable" | ||
| + | |+ The possible named-parameters for {{t|Infobox}} are: | ||
| + | ! name !! description | ||
| + | |- | ||
| + | | style="text-align:center; vertical-align:top; font-style:italic;" | nocat | ||
| + | | optional, auto-categorization will be inhibited when used with '''any''' non-empty value. | ||
| + | |- | ||
| + | | style="text-align:center; vertical-align:top; font-style:italic;" | page | ||
| + | | optional, name of item to display at top.<br/>Defaults to 'pagename'. | ||
| + | |} | ||
| + | |||
| + | ==Examples== | ||
| + | :See the [[User:©TriMoon™/PropVals testdata|test-data]] page. | ||
| + | ==Helper-templates== | ||
| + | *{{t|SetProp}} | ||
| + | *{{t|HasProp}} | ||
| + | ==Old documentation== | ||
| + | ;For the documentation of the old manual-info version see [[Template:Infobox/doc old|old doc]]. | ||
| + | <includeonly>[[Category:Infobox templates|{{PAGENAME}}]]<!-- Any categories for the template itself --> | ||
| + | [[Category:Templates/©TriMoon™|{{SUBPAGENAME}}]]</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude> | ||
Revision as of 05:42, 30 June 2012
Description
- This template is used to create an information-box to automatically display different kinds of info, depending on properties set on the page it is displaying this info for.
- It relies on properties set using {{SetProp}}.
Syntax
- Type the below code at the top of the page, with values assigned to relevant parameters.
- Parameters can be in any order, and not all need to be used.
- The shown parameters to {{SetProp}} are examples and most used, see its documentation for all propname's.
- You can remove the unused ones if they are not likely to be set for your page.
{{SetProp
|IsinGameMenu=
|Caption=
|Has fullview={{SUBPAGENAME}}.png
|RequiresTech=
|RequiresObj=
|RepairedWith=
|IsLiftable=y/n (or IsLiftableWhenEmpty=y)
|HP=0
|Soak=0
}}{{Infobox}}
==About==
| name | description |
|---|---|
| nocat | optional, auto-categorization will be inhibited when used with any non-empty value. |
| page | optional, name of item to display at top. Defaults to 'pagename'. |
Examples
- See the test-data page.
Helper-templates
Old documentation
- For the documentation of the old manual-info version see old doc.
