Jump to content

Template:Information page/doc: Difference between revisions

From BattleIntelligence
imported>Deadfire
 
m Text replacement - "BattleTechWiki" to "BattleIntelligence"
 
Line 1: Line 1:
<!-- ******************************************************************************
<!-- ******************************************************************************
     ****  This is the documentation for both Template:Information_page and    ****
     ****  This is the documentation for both Template:Information_page and    ****
     ****  Template:BattleTechWiki_how-to (it uses #if statements to distinguish).  ****
     ****  Template:BattleIntelligence_how-to (it uses #if statements to distinguish).  ****
     ******************************************************************************
     ******************************************************************************
-->
-->
Line 10: Line 10:
This is the page banner template for [[:Category:{{#if:{{{howto|}}}|how-to{{!}}How-to|information pages{{!}}information pages}}]].
This is the page banner template for [[:Category:{{#if:{{{howto|}}}|how-to{{!}}How-to|information pages{{!}}information pages}}]].


It can be placed on top of administration pages (not-articles) when appropriate. This usually means pages in the "BattleTechWiki:" and "Help:" namespaces, but sometimes {{#if:{{{howto|}}}|how-to guides|information pages}} also exist as user subpages.
It can be placed on top of administration pages (not-articles) when appropriate. This usually means pages in the "BattleIntelligence:" and "Help:" namespaces, but sometimes {{#if:{{{howto|}}}|how-to guides|information pages}} also exist as user subpages.


== Categorization ==
== Categorization ==
If a page that uses this template is in the "BattleTechWiki:" or "Help:" [[BattleTechWiki:Namespace|namespace]], then this template adds [[:Category:{{#if:{{{howto|}}}|how-to|information pages}}]] to the page.
If a page that uses this template is in the "BattleIntelligence:" or "Help:" [[BattleIntelligence:Namespace|namespace]], then this template adds [[:Category:{{#if:{{{howto|}}}|how-to|information pages}}]] to the page.


If the page is in the "User:" namespace, it will be put into [[:Category:User Essays]].  If your page is just a draft, please use the {{para|nocat}} parameter to prevent categorization, until it is finished.
If the page is in the "User:" namespace, it will be put into [[:Category:User Essays]].  If your page is just a draft, please use the {{para|nocat}} parameter to prevent categorization, until it is finished.
Line 25: Line 25:
:{{tlc|{{BASEPAGENAME}}}}
:{{tlc|{{BASEPAGENAME}}}}


But it can also take up to three [[BattleTechWiki:Shortcut|shortcuts]] as parameters. It then displays a small shortcut box inside it. Like this:
But it can also take up to three [[BattleIntelligence:Shortcut|shortcuts]] as parameters. It then displays a small shortcut box inside it. Like this:


:{{tlc|{{BASEPAGENAME}}|BTW:SHORT|BTW:LONG}}
:{{tlc|{{BASEPAGENAME}}|BTW:SHORT|BTW:LONG}}
Line 44: Line 44:
* {{para|2}} or {{para|sc2}}, {{para|shortcut2}}, or first unnamed parameter – Second shortcut
* {{para|2}} or {{para|sc2}}, {{para|shortcut2}}, or first unnamed parameter – Second shortcut
* {{para|3}} or {{para|sc3}}, {{para|shortcut3}}, or first unnamed parameter – Third shortcut (deprecated; please use separate [[Template:Shortcut]] for three or more)
* {{para|3}} or {{para|sc3}}, {{para|shortcut3}}, or first unnamed parameter – Third shortcut (deprecated; please use separate [[Template:Shortcut]] for three or more)
* {{para|interprets}} or {{para|page}} or {{para|pages}} – Specify name of page (policy, process, etc.) that this essay provides advice about. For a single page, it is not necessary to include <code><nowiki>[[...]]</nowiki></code> linking brackets;. This will replace the wording "{{#if:{{{howto|}}}|some aspect or aspects of BattleTechWiki's norms and practices|BattleTechWiki's norms and practices}}". If more than one page and/or any notes are intended, links must be manually coded, e.g.: {{para|interprets|<nowiki>[[BattleTechWiki:Verifiability]] policy and the [[BattleTechWiki:Identifying reliable sources]] guideline</nowiki>}}
* {{para|interprets}} or {{para|page}} or {{para|pages}} – Specify name of page (policy, process, etc.) that this essay provides advice about. For a single page, it is not necessary to include <code><nowiki>[[...]]</nowiki></code> linking brackets;. This will replace the wording "{{#if:{{{howto|}}}|some aspect or aspects of BattleIntelligence's norms and practices|BattleIntelligence's norms and practices}}". If more than one page and/or any notes are intended, links must be manually coded, e.g.: {{para|interprets|<nowiki>[[BattleIntelligence:Verifiability]] policy and the [[BattleIntelligence:Identifying reliable sources]] guideline</nowiki>}}
* {{para|sort-by}} – Specify a sort key for the category. This has no effect on the user essays category.
* {{para|sort-by}} – Specify a sort key for the category. This has no effect on the user essays category.
* {{para|category}} – Specify a complete wikilink (i.e, {{em|do}} include the <code><nowiki>[[...]]</nowiki></code> linking brackets) to one or more categories to override the default [[:Category:{{#if:{{{howto|}}}|how-to|information pages}}]]. May include a category sort; example: <code><nowiki>[[Category:WikiProject Underwater Basketweaving|Article structure advice]]</nowiki></code> This parameter does not replace the [[:Category:Essays]] categorization for pages in the "User:" namespace, but can be used to add them manually to [[:Category:{{#if:{{{howto|}}}|how-to|information pages}}]], in addition to the automatic user category.
* {{para|category}} – Specify a complete wikilink (i.e, {{em|do}} include the <code><nowiki>[[...]]</nowiki></code> linking brackets) to one or more categories to override the default [[:Category:{{#if:{{{howto|}}}|how-to|information pages}}]]. May include a category sort; example: <code><nowiki>[[Category:WikiProject Underwater Basketweaving|Article structure advice]]</nowiki></code> This parameter does not replace the [[:Category:Essays]] categorization for pages in the "User:" namespace, but can be used to add them manually to [[:Category:{{#if:{{{howto|}}}|how-to|information pages}}]], in addition to the automatic user category.
Line 70: Line 70:
* {{tlx|Information page}} – the banner template for pages that are more just informational than directly instructional.
* {{tlx|Information page}} – the banner template for pages that are more just informational than directly instructional.
|
|
* {{tlx|BattleTechWiki how-to}} – the banner template for pages that are more directly instructional than just informational.
* {{tlx|BattleIntelligence how-to}} – the banner template for pages that are more directly instructional than just informational.
}}
}}
* {{tlx|Essay|interprets{{=}}}} – the banner template for pages that are more opinionated then instructional or technical; there are several parameters and variations.
* {{tlx|Essay|interprets{{=}}}} – the banner template for pages that are more opinionated then instructional or technical; there are several parameters and variations.

Latest revision as of 01:13, 1 May 2025

This is the page banner template for information pages.

It can be placed on top of administration pages (not-articles) when appropriate. This usually means pages in the "BattleIntelligence:" and "Help:" namespaces, but sometimes information pages also exist as user subpages.

Categorization

If a page that uses this template is in the "BattleIntelligence:" or "Help:" namespace, then this template adds Category:information pages to the page.

If the page is in the "User:" namespace, it will be put into Category:User Essays. If your page is just a draft, please use the |nocat= parameter to prevent categorization, until it is finished.

If it is in some other namespace, it will not be auto-categorized, and it may be in the wrong place.

Usage

This template can be used as is, like this:

{{Information page}}

But it can also take up to three shortcuts as parameters. It then displays a small shortcut box inside it. Like this:

{{Information page|BTW:SHORT|BTW:LONG}}

Then it looks like this:

If you want to feed more than one or two shortcuts then the shortcut box becomes too high, which doesn't look good. In such a case it is better to use a {{shortcut}} box directly below this template, like this:

{{Information page}}
{{shortcut|BTW:SHORT|BTW:SHORT2|BTW:SHORT3|BTW:SHORT4}}

Optional parameters

  • |1= or |sc1=, |shortcut1=, |shortcut=, or first unnamed parameter – First shortcut. Don't include [[...]] linking brackets in this or other shortcut parameters.
  • |2= or |sc2=, |shortcut2=, or first unnamed parameter – Second shortcut
  • |3= or |sc3=, |shortcut3=, or first unnamed parameter – Third shortcut (deprecated; please use separate Template:Shortcut for three or more)
  • |interprets= or |page= or |pages= – Specify name of page (policy, process, etc.) that this essay provides advice about. For a single page, it is not necessary to include [[...]] linking brackets;. This will replace the wording "BattleIntelligence's norms and practices". If more than one page and/or any notes are intended, links must be manually coded, e.g.: |interprets=[[BattleIntelligence:Verifiability]] policy and the [[BattleIntelligence:Identifying reliable sources]] guideline
  • |sort-by= – Specify a sort key for the category. This has no effect on the user essays category.
  • |category= – Specify a complete wikilink (i.e, do include the [[...]] linking brackets) to one or more categories to override the default Category:information pages. May include a category sort; example: [[Category:WikiProject Underwater Basketweaving|Article structure advice]] This parameter does not replace the Category:Essays categorization for pages in the "User:" namespace, but can be used to add them manually to Category:information pages, in addition to the automatic user category.
  • |nocat=y or |demo=y – Bypass all categorization, when the template is used for demo purposes, e.g. in template documentation, on talk pages, etc.
  • |style= – Pass arbitrary CSS to the Template:Ombox base template that this template uses.

TemplateData

TemplateData for Information page

Template parameters

ParameterDescriptionTypeStatus
pagepage

Guideline or other page being interpreted

Page nameoptional
shortcut1shortcut1

Shortcut to this page

Page nameoptional
shortcut2shortcut2

Shortcut to this page

Page nameoptional
shortcut3shortcut3

Shortcut to this page

Page nameoptional
nocatnocat

Any value prevents addition of project category

Stringoptional

See also

  • {{BattleIntelligence how-to}} – the banner template for pages that are more directly instructional than just informational.
  • {{Essay|interprets=}} – the banner template for pages that are more opinionated then instructional or technical; there are several parameters and variations.