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>{{#if:{{{title|}}}|<h3>{{{title}}}</h3>
+<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''']
-}}<div style="padding:0 7px; border:{{{borderSize|1px}}} solid {{{borderColor|#666}}}; width:{{{width|80%}}}; -webkit-column-count:{{{columns|5}}}; -moz-column-count:{{{columns|5}}}; column-count:{{{columns|5}}}; -webkit-column-rule:{{{borderSize|1px}}} solid {{{borderColor|#666}}}; -moz-column-rule:{{{borderSize|1px}}} solid {{{borderColor|#666}}}; column-rule:{{{borderSize|1px}}} solid {{{borderColor|#666}}};">{{{text|}}}</div></includeonly><noinclude>__NOTOC__
 == Purpose & Usage ==
-This template allows text to be displayed and automatically arranged through several columns. It is used on the some INI Guides to help create a custom TOC.
+This template provides a method for laying out a custom table of contents listing subpage links to respective INI parameters.
 ===Parameters===
-*''text'' (required) is the content within the columns
+====Required====
-*''title'' (optional) adds a title right before the column that is an level 3 header. Required for some INI Guides
+*''parameter 1'': This should be a bulleted list of all the sections.
-*''borderSize'' (optional) adjusts the size of the border around the columns. Setting it to 0 disables the border. Default is 1px.
-*''borderColor'' (optional) sets the color of the borders. Default is #666.
+====Optional====
-*''width'' (optional) sets the width of the entire block of columned content. Default is 80%.
+*''columns'': This specifies the number of columns. Default is 5.
-*''columns'' (optional) sets the number of columns to use. Default is 5.
+*''fontsize'': This specifies the font size. Default is 15pt.
 == Examples ==
 '''Code:'''
-<pre>{{Columns
+<pre>{{INITOC|columns=5|
-|text=Love<br />is<br />columns!
+*:Controls
-}}</pre>
+*Actor
-'''Result:'''
+*Animation
-{{Columns
+*Archive
-|text=Love<br />is<br />columns!
+*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>{{Columns
+{{INITOC|columns=5|
-|text=Love<br />is<br />columns!<br />Love<br />is<br />columns!<br />Love<br />is<br />columns!<br />Love<br />is<br />columns!<br />Love<br />is<br />columns!<br />Love<br />is<br />columns!<br />Love<br />is<br />columns!<br />
+*:Controls
-}}</pre>
+*Actor
-'''Result:'''
+*Animation
-{{Columns
+*Archive
-|text=Love<br />is<br />columns!<br />Love<br />is<br />columns!<br />Love<br />is<br />columns!<br />Love<br />is<br />columns!<br />Love<br />is<br />columns!<br />Love<br />is<br />columns!<br />Love<br />is<br />columns!<br />
+*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}}
-'''Code:'''
+== See Also ==
-<pre>{{Columns
+None
-|title=Love
-|borderSize=0
-|columns=3
-|width=100%
-|text=Love<br />is<br />columns!<br />Love<br />is<br />columns!<br />Love<br />is<br />columns!<br />Love<br />is<br />columns!<br />Love<br />is<br />columns!<br />Love<br />is<br />columns!<br />Love<br />is<br />columns!<br />
-}}</pre>
-'''Result:'''
-{{Columns
-|title=Love
-|borderSize=0
-|columns=3
-|width=100%
-|text=Love<br />is<br />columns!<br />Love<br />is<br />columns!<br />Love<br />is<br />columns!<br />Love<br />is<br />columns!<br />Love<br />is<br />columns!<br />Love<br />is<br />columns!<br />Love<br />is<br />columns!<br />
-}}
-== See Also ==
-*[[Template:INI Guide/Custom TOC]]
 </noinclude>