ConfigPage – Template

From Bohemia Interactive Community
Jump to navigation Jump to search
(Add notoc)
m (Fix notoc doc)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
<includeonly>{{#switch:{{lc:{{{1}}}}}
<includeonly>{{#switch:{{lc:{{{1}}}}}
|start= {{#if:notoc||{{TOC|side|1||nonum}}}}
|start= {{#if:{{{notoc|}}}||{{TOC|side|1||nonum}}}}
<div class="cfg_reference">
<div class="cfg_reference"{{#if:{{{notoc|}}}|<nowiki/> style="width: auto"}}>
{{#switch:{{PAGENAME}}
{{#switch:{{PAGENAME}}
|CfgMoves Config Reference
|CfgMoves Config Reference
Line 29: Line 29:
*** '''level 6''' titles are not stylised
*** '''level 6''' titles are not stylised
** end - to be placed at the bottom of the page, just above categories
** end - to be placed at the bottom of the page, just above categories
|notoc= (named parameter) {{hl|notoc= y}} for ''start'' to avoid providing the TOC
** notoc (named parameter) {{hl|1= notoc= y}} for ''start'' to avoid providing the TOC
|example1= <pre>{{ConfigPage}}</pre>
|example1= <pre>{{ConfigPage}}</pre>
|result1= {{ConfigPage}}
|result1= {{ConfigPage}}

Latest revision as of 18:32, 5 August 2024

This template in three parts (all mandatory) creates and styles a config page. It automatically adds the table of contents (ToC) via {{TOC}} usage.
A special {{TopMenu}} is added to the following pages:

This template is used on these pages.

Usage

{{ConfigPage|type}}

  • type: (case-insensitive) can be one of:
    • start - to be placed at the very top of a Cfg page
    • abc - to be placed above the first letter:
      • a letter index is a level 3 title (e.g === A ===)
      • an entry is a level 4 title ((e.g ==== Apple ====)
      • an entry's subtitle can be a level 5 title ((e.g ===== Details =====)
      • level 6 titles are not stylised
    • end - to be placed at the bottom of the page, just above categories
    • notoc (named parameter) notoc= y for start to avoid providing the TOC
Examples
Code Result
{{ConfigPage}}
Wrong {{ConfigPage}} template usage!
{{ConfigPage|test}}
Wrong {{ConfigPage}} template usage! "test" is an invalid value.
{{ConfigPage|start}}

= Level 1 =

Should not be used unless absolute necessity, e.g on a huge page where '''level 2''' are not enough.

== Level 2 ==

=== Level 3 ===

{{ConfigPage|abc}}

=== A ===

==== Apple ====
A fruit

=== B ===

==== Bee ====
An insect

=== C ===

==== Cow ====
A mammal

===== Details =====
But not just that

====== Level 6 ======
Not stylised.

{{ConfigPage|end}}

Level 1

Should not be used unless absolute necessity, e.g on a huge page where level 2 are not enough.

Level 2

Level 3

A

Apple

A fruit

B

Bee

An insect

C

Cow

A mammal

Details

But not just that

Level 6

Not stylised.