Template:INITOC: Difference between revisions

From Step Mods | Change The Game
No edit summary
m (Z929669 moved page Template:INIColumns to Template:INITOC)
(No difference)

Revision as of 19:07, July 1, 2015

Purpose & Usage

This template should be used in conjunction with the helper template, Template:Tl. This template provides a method for laying out a custom table of contents listing subpage links to respective INI parameters. These subpage links are, in turn, handled using Template:Tl.

Parameters

Required

  • text: List of Template:Tl helper template calls (no breaks or spaces in between). If for some reason this is used with out the helper template, enter parameter-heading labels separated by <br /> or <br> HTML tags.

Optional

  • borderColor: Sets the color of the borders. Enter the hex code (excluding # prefix) Default is #555.
  • width: Sets the width of the entire block of columned content. Enter an integer in pixels. Default is 65%.
  • columns: Sets the number of columns to use. Enter an integer. Default is 3.
  • gapSize: Sets the whitespace width between columns (analogous to padding). Enter an integer in pixels. Default is 25px.
  • borderSize: Sets the border width between columns (placed in center of the gap). Enter an integer in pixels. Default is 1px.
  • notitle" Omits the default h3 title for the TOC box. Enter any text, but a single integer ('0' or '1') is suggested.

Examples

Code: (normal use with the helper template)

{{INITOC
|text={{INISectionLabel
|ParamHead1}}{{INISectionLabel
|ParamHead2}}{{INISectionLabel
|ParamHead3}}{{INISectionLabel
|ParamHead4}}{{INISectionLabel
|ParamHead5}}{{INISectionLabel
|ParamHead6}}{{INISectionLabel
|ParamHead7}}{{INISectionLabel
|ParamHead8}}{{INISectionLabel
|ParamHead9}}{{INISectionLabel
|ParamHead10}}{{INISectionLabel
|ParamHead11}}{{INISectionLabel
|ParamHead12}}
}}

Result:

INI Parameters by Section


Code: (fully parameterized)

{{INITOC
|borderColor=#55aa55
|borderSize=1px
|columns=4
|width=90%
|gapSize=10px
|text={{INISectionLabel
|ParamHead1}}{{INISectionLabel
|ParamHead2}}{{INISectionLabel
|ParamHead3}}{{INISectionLabel
|ParamHead4}}{{INISectionLabel
|ParamHead5}}{{INISectionLabel
|ParamHead6}}{{INISectionLabel
|ParamHead7}}{{INISectionLabel
|ParamHead8}}{{INISectionLabel
|ParamHead9}}{{INISectionLabel
|ParamHead10}}{{INISectionLabel
|ParamHead11}}{{INISectionLabel
|ParamHead12}}{{INISectionLabel
|ParamHead13}}{{INISectionLabel
|ParamHead14}}{{INISectionLabel
|ParamHead15}}{{INISectionLabel
|ParamHead16}}{{INISectionLabel
|ParamHead17}}{{INISectionLabel
|ParamHead18}}{{INISectionLabel
|ParamHead19}}{{INISectionLabel
|ParamHead20}}
}}

Result:

INI Parameters by Section


Code: (title omitted; without helper template)

{{INITOC
|notitle=1
|text=ParamHead1<br />ParamHead2<br />ParamHead3<br />ParamHead4<br />ParamHead5<br />ParamHead6<br />ParamHead7<br />ParamHead8<br />ParamHead9}

Result:

ParamHead1
ParamHead2
ParamHead3
ParamHead4
ParamHead5
ParamHead6
ParamHead7
ParamHead8
ParamHead9

See Also