Template:INITOC: Difference between revisions

Latest revision as of 15:50, August 2, 2021

Purpose & Usage

This template provides a method for laying out a custom table of contents listing subpage links to respective INI parameters.

Parameters

Required

parameter 1: This should be a bulleted list of all the sections.

Optional

columns: This specifies the number of columns. Default is 5.
fontsize: This specifies the font size. Default is 15pt.

Examples

Code:

{{INITOC|columns=5|
*:Controls
*Actor
*Animation
*Archive
*Audio
*BackgroundLoad
*bLightAttenuation
*BSPathing
*BudgetCaps
*Camera
*CameraPath
*Cart
*Clouds
*Combat
*Controls
*CopyProtectionStrings
*Debug
*Decals
*Dialogue
*Display
*FaceGen
*Fonts
*FootIK
*Gameplay
*General
*GeneralWarnings
*GethitShader
*GrabIK
*Grass
*HAVOK
*HeadTracking
*Imagespace
*Interface
*Kinect
*Landscape
*LANGUAGE
*Light
*LightingShader
*LOD
*LookIK
*MAIN
*MapMenu
*Menu
*MESSAGES
*NavMeshGeneration
*Papyrus
*Pathfinding
*Pathing
*RagdollAnim
*RagdollFeedback
*SaveGame
*ScreenSplatter
*SpeedTree
*Terrain
*TerrainManager
*TestAllCells
*Trees
*VATS
*Verlet
*Voice
*Water
*Weather}}

Result:

@@ Line 1: / Line 1: @@
-<includeonly><h3>INI Parameters by Section</h3><div style="padding:12px 12px; border:{{{borderSize|1px}}} solid {{{borderColor|#555}}}; width:{{{width|65%}}}; -webkit-column-count:{{{columns|3}}}; -moz-column-count:{{{columns|3}}}; column-count:{{{columns|3}}}; -webkit-column-gap:{{{gapSize|25px}}}; -moz-column-gap:{{{gapSize|25px}}}; column-gap:{{{gapSize|25px}}}; -webkit-column-rule:{{{borderSize|0px}}} solid {{{borderColor|#555}}}; -moz-column-rule:{{{borderSize|0px}}} solid {{{borderColor|#555}}}; column-rule:{{{borderSize|0px}}} solid {{{borderColor|#555}}};">{{{text|}}}</div></includeonly><noinclude>__NOTOC__
+<includeonly><div class="toc" style="column-count:{{{columns|5}}};display:inline-block;font-size:{{{fontsize|15pt}}};padding:1rem;">{{#arraymap:{{{1}}}|*|x|[[/x|[x]]]<br />|}}</div></includeonly><noinclude>__NOTOC__ [[Category:Guide Templates]][https://stepmodifications.org/forum/topic/98292-initoc/ '''Forum Topic''']
 == Purpose & Usage ==
-This template should be used in conjunction with the helper template, {{tl|INISectionLabel}}. 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 {{tl|INISectionLabel}}.
+This template provides a method for laying out a custom table of contents listing subpage links to respective INI parameters.
 ===Parameters===
 ====Required====
-*''text'': List of {{tl|INISectionLabel}} 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 <code><nowiki><br /></nowiki></code> or <code><nowiki><br></nowiki></code> HTML tags.
+*''parameter 1'': This should be a bulleted list of all the sections.
 ====Optional====
-*''borderColor'': Sets the color of the borders. Enter the hex code (excluding # prefix) Default is #555.
+*''columns'': This specifies the number of columns. Default is 5.
-*''width'': Sets the width of the entire block of columned content. Enter an integer in pixels. Default is 65%.
+*''fontsize'': This specifies the font size. Default is 15pt.
-*''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.
 == Examples ==
-'''Code:''' (normal use with the helper template)
+'''Code:'''
-<pre>{{INIColumns|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}}
+<pre>{{INITOC|columns=5|
-}}</pre>
+*:Controls
-'''Result:'''
+*Actor
-{{INIColumns|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}}
+*Animation
-}}
+*Archive
+*Audio
+*BackgroundLoad
+*bLightAttenuation
+*BSPathing
+*BudgetCaps
+*Camera
+*CameraPath
+*Cart
+*Clouds
+*Combat
+*Controls
+*CopyProtectionStrings
+*Debug
+*Decals
+*Dialogue
+*Display
+*FaceGen
+*Fonts
+*FootIK
+*Gameplay
+*General
+*GeneralWarnings
+*GethitShader
+*GrabIK
+*Grass
+*HAVOK
+*HeadTracking
+*Imagespace
+*Interface
+*Kinect
+*Landscape
+*LANGUAGE
+*Light
+*LightingShader
+*LOD
+*LookIK
+*MAIN
+*MapMenu
+*Menu
+*MESSAGES
+*NavMeshGeneration
+*Papyrus
+*Pathfinding
+*Pathing
+*RagdollAnim
+*RagdollFeedback
+*SaveGame
+*ScreenSplatter
+*SpeedTree
+*Terrain
+*TerrainManager
+*TestAllCells
+*Trees
+*VATS
+*Verlet
+*Voice
+*Water
+*Weather}}</pre>
-'''Code:''' (
+''Result:''
-<pre>{{INIColumns
+{{INITOC|columns=5|
-|borderColor=#55aa55
+*:Controls
-|borderSize=1px
+*Actor
-|columns=4
+*Animation
-|width=100%
+*Archive
-|gapSize=10px
+*Audio
-|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}}
+*BackgroundLoad
-}}</pre>
+*bLightAttenuation
-'''Result:'''
+*BSPathing
-{{INIColumns
+*BudgetCaps
-|borderColor=#55aa55
+*Camera
-|borderSize=1px
+*CameraPath
-|columns=4
+*Cart
-|width=100%
+*Clouds
-|gapSize=10px
+*Combat
-|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}}
+*Controls
-}}
+*CopyProtectionStrings
+*Debug
+*Decals
+*Dialogue
+*Display
+*FaceGen
+*Fonts
+*FootIK
+*Gameplay
+*General
+*GeneralWarnings
+*GethitShader
+*GrabIK
+*Grass
+*HAVOK
+*HeadTracking
+*Imagespace
+*Interface
+*Kinect
+*Landscape
+*LANGUAGE
+*Light
+*LightingShader
+*LOD
+*LookIK
+*MAIN
+*MapMenu
+*Menu
+*MESSAGES
+*NavMeshGeneration
+*Papyrus
+*Pathfinding
+*Pathing
+*RagdollAnim
+*RagdollFeedback
+*SaveGame
+*ScreenSplatter
+*SpeedTree
+*Terrain
+*TerrainManager
+*TestAllCells
+*Trees
+*VATS
+*Verlet
+*Voice
+*Water
+*Weather}}
-'''Code:''' (can be used without helper template)
+== See Also ==
-<pre>{{INIColumns|text=ParamHead1<br />ParamHead2<br />ParamHead3}}</pre>
+None
-'''Result:'''
-{{INIColumns|text=ParamHead1<br />ParamHead2<br />ParamHead3}}
-== See Also ==
-*[[Template:INISectionLabel]]
 </noinclude>