Template:Header: Difference between revisions

Latest revision as of 10:37, 9 March 2024

This page has been put into protection by a PZwiki administrator.

Only users in the sysop user group may edit this page.

Template Documentation

This template is used to add a breadcrumb, to assist the reader in navigating around the wiki.

Usage

This template should be placed at the top of a page, beneath the level 1 heading (page name). As a page can have several categories, it's best to use the 'best fit' or most logical for the article in question.

{{Header|First-level category|Second-level category|Third-level category|etc.}}

Parameters

1 - 6: The name of each category leading up to the page, omitting Category:. The page will be added to the last category in the list, or the top-level category of the wiki if all parameters are empty.
hidecat: If not empty the template will not add the page to the categories defined in 1 to 6.

Background color

The background color will be set automatically based on the category in the first level (1).

Red (default)

Blue (community)

The following categories will result in the blue color scheme.

DISPLAYTITLE magic word

The name of a page (known as the display title) can be customized using the {{DISPLAYTITLE}} magic word. This template will automatically display the name of a category/page with a custom display title.

Examples

Template with Project Zomboid at the first level, resulting in a red theme.

{{Header|Project Zomboid|Items|Weapons}}

Result

Template with PZwiki at the first level, resulting in a blue theme.

{{Header|PZwiki|Site maintenance}}

Result

How to translate

This template is translatable.

Template code

Paste the following code into the <includeonly> tag of the translated template and translate the text after each = sign (except for #default =).

{{#switch: {{{1|}}}
| navigation = Navigation
| #default = [[Category:Incorrect template usage]]
}}

Template documentation

Copy the code wrapped in the <noinclude> tag in this template and translate the text after doc = in the {{Documentation}} template.

{{Translation guide}} template should be removed from the translated documentation.

@@ Line 1: / Line 1: @@
-<noinclude>{{Languages}}{{Documentation}}[[Category:Templates]]</noinclude><includeonly><table class="tp-header" style="clear: both; border: 1px solid #000000; background: #{{#switch:{{{1|{{ROOTPAGENAME}}}}}|Community|PZwiki|Modding|The Indie Stone={{Infobox_nc|Community}}|#default={{Infobox_nc|default}}}}; text-align: left; width: 100%;" cellspacing="0">
+<noinclude>
-  <tr>
+{{Protection}}
-    <th style="width: 99px; padding: 6px; border-right: 1px solid #000000; color: #ffffff;">{{Translation|Navigation}}:</th>
+{{Documentation/sandbox|doc =
-    <th style="padding: 6px; font-weight: normal; color: #ffffff; min-width: 120px;"><!--
+This template is used to add a [[Wikipedia:Breadcrumb navigation|breadcrumb]], to assist the reader in navigating around the wiki.
+<span class="toclimit-3">__TOC__</span>
+==Usage==
+This template should be placed at the top of a page, beneath the level 1 heading (page name). As a page can have several categories, it's best to use the 'best fit' or most logical for the article in question.
+<pre>
+{{Header|First-level category|Second-level category|Third-level category|etc.}}
+</pre>
-      ## Main Index Category - check if current page = "Category:Main"##
+===Parameters===
-      -->{{#ifeq:{{FULLROOTPAGENAME}}|Category:Main<!--
+;<code>1</code> - <code>6</code>
-        -->|'''{{Check title|{{FULLPAGENAME}}|true={{CATBASEPAGENAME}}}}'''<!--
+:The name of each category leading up to the page, omitting <code>Category:</code>. The page will be added to the last category in the list, or the {{ll|:Category:Main|top-level category}} of the wiki if all parameters are empty.
+;<code>hidecat</code>
+:If not empty the template will not add the page to the categories defined in <code>1</code> to <code>6</code>.
-        ## Otherwise ##
+===Background color===
-        -->|{{Header/category|{{{1}}}|Main}}<!--
+The background color will be set automatically based on the category in the first level (<code>1</code>).
-        -->{{#if:{{{1|}}}|<span style="padding: 0px 9px;"><small>></small></span><!--
-        ## First Category ##
+====Red (default)====
-        -->{{Header/category|{{{1}}}|{{{1}}}}}}}<!--
+<div style="width:32px; height:32px; background-color:var(--color-red); border:var(--border-red); border-radius:var(--border-radius)"> </div>
-        -->{{#if:{{{2|}}}|<span style="padding: 0px 9px;"><small>></small></span><!--
-        ## Second Category ##
+====Blue (community)====
-        -->{{Header/category|{{{1}}}|{{{2}}}}}}}<!--
+<div style="width:32px; height:32px; background-color:var(--color-blue); border:var(--border-blue); border-radius:var(--border-radius)"> </div>
-        -->{{#if:{{{3|}}}|<span style="padding: 0px 9px;"><small>></small></span><!--
+The following categories will result in the blue color scheme.
+*{{ll|:Category:PZwiki|PZwiki}}
+*{{ll|:Category:Modding|Modding}}
+*{{ll|:Category:The Indie Stone|The Indie Stone}}
-        ## Third Category ##
+===DISPLAYTITLE magic word===
-        -->{{Header/category|{{{1}}}|{{{3}}}}}}}<!--
+The name of a page (known as the display title) can be customized using the {{tll|DISPLAYTITLE}} magic word. This template will automatically display the name of a category/page with a custom display title.
-        -->{{#if:{{{4|}}}|<span style="padding: 0px 9px;"><small>></small></span><!--
-        ## Fourth Category ##
+==Examples==
-        -->{{Header/category|{{{1}}}|{{{4}}}}}}}<!--
+Template with {{ll|:Category:Project Zomboid|<code>Project Zomboid</code>}} at the first level, resulting in a red theme.
-        -->{{#if:{{{5|}}}|<span style="padding: 0px 9px;"><small>></small></span><!--
+<pre>{{Header|Project Zomboid|Items|Weapons}}</pre>
+;Result:
+{{Header|Project Zomboid|Items|Weapons|hidecat=true}}
-        ## Fifth Category ##
-        -->{{Header/category|{{{1}}}|{{{5}}}}}}}<!--
-        -->{{#if:{{{6|}}}|<span style="padding: 0px 9px;"><small>></small></span><!--
-        ## Sixth Category ##
+Template with {{ll|:Category:PZwiki|<code>PZwiki</code>}} at the first level, resulting in a blue theme.
-        -->{{Header/category|{{{1}}}|{{{6}}}}}}}<!--
+<pre>{{Header|PZwiki|Site maintenance}}</pre>
-        --><span style="padding: 0px 9px;"><small>></small></span><!--
+;Result:
+{{Header|PZwiki|Site maintenance|hidecat=true}}
-        ## Page Name ##
+{{Translation guide|<syntaxhighlight lang="html">
-        -->'''{{Check title|{{FULLPAGENAME}}|true={{CATBASEPAGENAME}}}}'''<!--
+{{#switch: {{{1|}}}
-    -->}}<!--
+| navigation = Navigation
-  --></th><!--
+| #default = [[Category:Incorrect template usage]]
+}}
+</syntaxhighlight>}}
-    ## Page Version ##
+==See also==
-    --><th style="padding: 6px; text-align:right; color: #ffffff; font-weight: normal;"><!--
+*{{ll|Template:Page version}}
-      --><span style="float:right; padding-right: 5px; color: #ffffff"><!--
+}}
-        -->{{#if: {{{hidever|}}}||'''{{Translation|Page updated}}:''' [[Version history|<span style="color:#{{#switch:{{{1|{{ROOTPAGENAME}}}}}|Community|PZwiki|Modding|The Indie Stone={{Infobox_nc|Community|Link}}}};"><!--
+{{ll|Category:Templates}}
-          -->{{{version|{{Translation|Unknown Version}}}}}<!--
+</noinclude><includeonly><div class="header theme-{{#switch:{{{1|{{ROOTPAGENAME}}}}}|PZwiki|Community|Modding|The Indie Stone=blue|#default=red}}">
-          -->{{#if:{{{version|}}}|{{#if:{{{incver|}}}|.{{{incver|}}} }} }}<!--
+  <div>{{ll|:Category:Main|{{tt|name=Header|default=Navigation|arg1=navigation}}}}:</div>
-        --></span>]]}}<!--
+  <div><!--
-      --></span><!--
+  -->{{#if: {{{1|}}}|{{ll|:Category:{{{1}}}|{{#if:{{lcs}}|{{#getdisplaytitle: Category:{{{1}}}{{lcs}} }}|{{{1}}}}}
-    --></th>
+   }} >&nbsp;}}{{#if: {{{2|}}}|{{ll|:Category:{{{2}}}|{{#if:{{lcs}}|{{#getdisplaytitle: Category:{{{2}}}{{lcs}} }}|{{{2}}}}}
-   </tr>
+  }} >&nbsp;}}{{#if: {{{3|}}}|{{ll|:Category:{{{3}}}|{{#if:{{lcs}}|{{#getdisplaytitle: Category:{{{3}}}{{lcs}} }}|{{{3}}}}}
-</table><!--
+  }} >&nbsp;}}{{#if: {{{4|}}}|{{ll|:Category:{{{4}}}|{{#if:{{lcs}}|{{#getdisplaytitle: Category:{{{4}}}{{lcs}} }}|{{{4}}}}}
+   }} >&nbsp;}}{{#if: {{{5|}}}|{{ll|:Category:{{{5}}}|{{#if:{{lcs}}|{{#getdisplaytitle: Category:{{{5}}}{{lcs}} }}|{{{5}}}}}
-## Body ##
+  }} >&nbsp;}}{{#if: {{{6|}}}|{{ll|:Category:{{{6}}}|{{#if:{{lcs}}|{{#getdisplaytitle: Category:{{{6}}}{{lcs}} }}|{{{6}}}}}
--->{{#if:{{{hidebody|}}}||<div style="background: #{{#switch:{{{1|{{ROOTPAGENAME}}}}}|Community|PZwiki|Modding|The Indie Stone={{Infobox_nc|Community|Body}}|#default={{Infobox_nc|default|Body}}}}; border-left: 1px solid #000000; border-right: 1px solid #000000; border-bottom: 1px solid #000000; padding: 10px; min-width: 516px;">}}<!--
+  }} >&nbsp;}}'''{{#if:{{lcs}}|{{#getdisplaytitle: {{FULLPAGENAME}} }}|{{PAGENAME}}}}'''<!--
+   --></div>
-## Hide Category and Version ##
+{{#if: {{{hidecat|}}}|
--->{{#if: {{{hidecat|}}}||
+| {{#ifeq: {{FULLROOTPAGENAME}}|Category:Main
-   {{#if: {{{hidever|}}}||[[Category:{{#if:{{{version|}}}|{{{version}}}{{#if:{{{incver|}}}|.{{{incver}}}}}{{#ifeq:{{Language code|{{Subpage|slash=false}}}}|true|{{Subpage}}|}}|Unknown Version}}]]}}<!--
+| <!-- if current page equals `Category:Main(/xx)`, don't add category -->
+| {{ll|Category:<!--
-  ## Categories ##
+  -->{{#if:{{{6|}}}|{{{6}}}
-   -->{{#if:{{{6|}}}|[[Category:{{{6}}}{{Subpage}}]]
+   |{{#if:{{{5|}}}|{{{5}}}
-   |{{#if:{{{5|}}}|[[Category:{{{5}}}{{Subpage}}]]
+   |{{#if:{{{4|}}}|{{{4}}}
-   |{{#if:{{{4|}}}|[[Category:{{{4}}}{{Subpage}}]]
+   |{{#if:{{{3|}}}|{{{3}}}
-   |{{#if:{{{3|}}}|[[Category:{{{3}}}{{Subpage}}]]
+   |{{#if:{{{2|}}}|{{{2}}}
-   |{{#if:{{{2|}}}|[[Category:{{{2}}}{{Subpage}}]]
+   |{{#if:{{{1|}}}|{{{1}}}
-   |{{#if:{{{1|}}}|[[Category:{{{1}}}{{Subpage}}]]
+   |Main}} }} }} }} }} }}}}
-   |[[Category:Main{{Subpage}}]]}} }} }} }} }} }}
+  }}{{Language code category}} <!-- if hidecat is blank, add page to language code category -->
-}}<!--
+}}</div></includeonly>
---></includeonly>