ConfigPage – Template

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<tt>([^ ]+)<\/tt>" to "{{hl|c= $1}}")
m (Fix the fix)
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<includeonly>{{#switch:{{lc:{{{1}}}}}
<includeonly>{{#switch:{{lc:{{{1}}}}}
|start= {{TOC|side|1||nonum}}<div class{{=}}"cfg_reference">
|start= {{#if:{{{notoc|}}}||{{TOC|side|1||nonum}}}}
<div class="cfg_reference"{{#if:{{{notoc|}}}|<nowiki/> style="width: auto"}}>
{{#switch:{{PAGENAME}}
{{#switch:{{PAGENAME}}
|CfgMagazines Config Reference={{Hatnote|'''See also''': [[CfgMoves Config Reference]], [[CfgWeapons Config Reference]], [[CfgAmmo Config Reference]] and [[CfgVehicles Config Reference]]}}
|CfgMoves Config Reference
|CfgMoves Config Reference={{Hatnote|'''See also''': [[CfgMagazines Config Reference]], [[CfgWeapons Config Reference]], [[CfgAmmo Config Reference]], [[Arma 3: CfgMovesFatigue]] and [[CfgVehicles Config Reference]]}}
|CfgVehicles Config Reference
|CfgMoves Config Reference={{Hatnote|'''See also''': [[CfgMoves Config Reference]] and [[CfgVehicles Config Reference]]}}
|CfgWeapons Config Reference
|CfgWeapons Config Reference={{Hatnote|'''See also''': [[CfgMagazines Config Reference]], [[CfgMoves Config Reference]], [[CfgAmmo Config Reference]] and [[CfgVehicles Config Reference]]}}
|CfgMagazines Config Reference
|CfgAmmo Config Reference={{Hatnote|'''See also''': [[CfgMagazines Config Reference]], [[CfgMoves Config Reference]], [[CfgWeapons Config Reference]] and [[CfgVehicles Config Reference]]}}
|CfgAmmo Config Reference= {{TopMenu|[[CfgMoves Config Reference]] {{#ifeq:{{PAGENAME}}|CfgMoves Config Reference|[[Arma 3: CfgMovesFatigue]]}} [[CfgVehicles Config Reference]] [[CfgWeapons Config Reference]] [[CfgMagazines Config Reference]] [[CfgAmmo Config Reference]]}}
|CfgVehicles Config Reference={{Hatnote|'''See also''': [[CfgMagazines Config Reference]], [[CfgMoves Config Reference]], [[CfgWeapons Config Reference]] and [[CfgAmmo Config Reference]]}}
}}
}}
|abc= <div class{{=}}"abc">
|abc= <div class="abc">
|end= </div></div>}}</includeonly><noinclude>{{Doc/Template
|end= </div></div>
|descr= This template in (all) three (mandatory) parts creates and styles a config page.
|#default= <div>Wrong {{Template|ConfigPage}} template usage!{{#if:{{{1|}}}|<nowiki/> "{{{1}}}" is an invalid value.}}{{TemplateCase||[[Category:ConfigPage template usage error]]}}</div>
}}</includeonly><noinclude>{{Doc/Template
|descr= This template in three parts (all mandatory) creates and styles a config page. It automatically adds the table of contents (ToC) ''via'' {{Template|TOC}} usage.<br>
A special {{Template|TopMenu}} is added to the following pages:
* [[CfgMoves Config Reference]]
* [[CfgVehicles Config Reference]]
* [[CfgWeapons Config Reference]]
* [[CfgMagazines Config Reference]]
* [[CfgAmmo Config Reference]]
|param1= type
|param1= type
|descr1= (case-insensitive) can be one of:
|descr1= (case-insensitive) can be one of:
** start - to be placed at the very top of a Cfg page
** start - to be placed at the very top of a Cfg page
** abc - to be placed '''above''' the first alphabetical entry ({{hl|c= ==== A ====}})
** abc - to be placed '''above''' the first letter:
*** a letter index is a '''level 3''' title (e.g {{hl|c= === A ===}})
*** an entry is a '''level 4''' title ((e.g {{hl|c= ==== Apple ====}})
*** an entry's subtitle can be a '''level 5''' title ((e.g {{hl|c= ===== Details =====}})
*** '''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
|example1= <pre>{{ConfigPage}}</pre>
|result1= {{ConfigPage}}
|example2= <pre>{{ConfigPage|test}}</pre>
|result2= {{ConfigPage|test}}
|example3= <pre>{{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}}</pre>
|result3= {{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}}
}}
}}
</noinclude>
</noinclude>

Revision as of 12:35, 4 December 2023

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
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.