Difference between revisions of "Template:Infobox/doc"

From Salem Wiki
Jump to: navigation, search
m (→‎Helper-templates: adding new helpers used)
m (Protected "Template:Infobox/doc": Documentation of key-feature ([edit=sysop] (indefinite) [move=sysop] (indefinite)))
 
(13 intermediate revisions by the same user not shown)
Line 3: Line 3:
 
: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.
 
: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}}.
 
:It relies on properties set using {{t|SetProp}}.
 +
:It uses [[Template:Infobox/Stylesheet.css|Infobox/Stylesheet.css]] as CSS-Stylesheet, which is site-wide included.
  
 
==Syntax==
 
==Syntax==
 
:Type the below code at the top of the page, with values assigned to relevant parameters.
 
: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.
+
:See {{t|SetProp}} for easy copy&paste code to use on pages.
: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>
 
<pre>
 
{{SetProp
 
{{SetProp
|IsinGameMenu=
+
|...
|Caption=
 
|Has fullview={{SUBPAGENAME}}.png
 
|RequiresTech=
 
|RequiresObj=
 
|RepairedWith=
 
|IsLiftable=y/n (or IsLiftableWhenEmpty=y)
 
|HP=0
 
|Soak=0
 
 
}}{{Infobox}}
 
}}{{Infobox}}
  
Line 31: Line 22:
 
|-
 
|-
 
| style="text-align:center; vertical-align:top; font-style:italic;" | page
 
| style="text-align:center; vertical-align:top; font-style:italic;" | page
| optional, name of item to display at top.<br/>Defaults to 'pagename'.
+
| optional, pagename of item to display info for.<br/>Defaults to <code><nowiki>{{PAGENAME}}</nowiki> or <nowiki>{{FULLPAGENAME}}</nowiki></code> when appropriate.
 +
|-
 +
| style="text-align:center; vertical-align:top; font-style:italic;" | catsort
 +
| optional, sortkey of page inside category listings.<br/>Defaults to <code><nowiki>{{PAGENAME}}</nowiki> or something different when appropriate depending on special cases.<br/>See: [[mw:Help:Categories#Sort_key|Sort key]]
 
|}
 
|}
  
 
==Examples==
 
==Examples==
:See the [[User:©TriMoon™/PropVals testdata|test-data]] page.
+
:See the [[Help:Infobox]] or [[Help:Infobox/testdata|test-data]] pages.
 +
 
 
==Helper-templates==
 
==Helper-templates==
 
*{{t|SetProp}}
 
*{{t|SetProp}}
 
*{{t|HasProp}}
 
*{{t|HasProp}}
*{{tPropVals}}
+
*{{t|PropVals}}
*{{tPropVals/List RequiredBy}}
+
*{{t|PropVals/getIcon}} to display icon at top.
 +
*{{t|PropVals/Print Entry}} to display icons with name links.
 +
*{{t|List Locations}} to display Locations info.
 +
*{{t|Infobox/List Skillvals}} to display Skill values.
 +
*{{t|Infobox/List RequiredBys}} to display [[Property:RequiredBy|RequiredBy]]'s.
  
==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 -->
 
<includeonly>[[Category:Infobox templates|{{PAGENAME}}]]<!-- Any categories for the template itself -->
 
[[Category:Templates/©TriMoon™|{{SUBPAGENAME}}]]</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
 
[[Category:Templates/©TriMoon™|{{SUBPAGENAME}}]]</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>

Latest revision as of 18:29, 25 July 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}}.
It uses Infobox/Stylesheet.css as CSS-Stylesheet, which is site-wide included.

Syntax

Type the below code at the top of the page, with values assigned to relevant parameters.
See {{SetProp}} for easy copy&paste code to use on pages.
{{SetProp
|...
}}{{Infobox}}

==About==
The possible named-parameters for {{Infobox}} are:
name description
nocat optional, auto-categorization will be inhibited when used with any non-empty value.
page optional, pagename of item to display info for.
Defaults to {{PAGENAME}} or {{FULLPAGENAME}} when appropriate.
catsort optional, sortkey of page inside category listings.
Defaults to {{PAGENAME}} or something different when appropriate depending on special cases.
See: Sort key

Examples

See the Help:Infobox or test-data pages.

Helper-templates