Jump to content

Template:Supplement/doc: Difference between revisions

From BattleIntelligence
imported>Deadfire
m Updating
 
m Text replacement - "BattleTechWiki" to "BattleIntelligence"
 
Line 5: Line 5:
'''Use this template carefully''', only when there is a well-established consensus at the relevant policy or guideline page to use this template on an essay that links from the relevant policy or guideline.  
'''Use this template carefully''', only when there is a well-established consensus at the relevant policy or guideline page to use this template on an essay that links from the relevant policy or guideline.  


The noun ''[[wikt:supplement|supplement]]'' does not mean "an interpretation" nor just "something added". It means precisely '''"something added, especially to make up for a {{em|deficiency}}",''' in this case a lack or gap in an official BattleTechWiki's policy or guideline. '''The intent is to further elaborate on  BattleTechWiki's policies or guidelines in an impartial and informative manner.'''
The noun ''[[wikt:supplement|supplement]]'' does not mean "an interpretation" nor just "something added". It means precisely '''"something added, especially to make up for a {{em|deficiency}}",''' in this case a lack or gap in an official BattleIntelligence's policy or guideline. '''The intent is to further elaborate on  BattleIntelligence's policies or guidelines in an impartial and informative manner.'''


:'''Note''': this template does not indicate a "higher status" within the community  for an essay, but is used to denote  that the essay in question has wide acceptance to be linked from said policy or guideline page. If consensus changes or content is outdated and the essay is no longer referenced in a policy or guideline, change the tag to the more common  {{tlx|Essay|interprets{{=}}}} or {{tlx|Information page}} template, as appropriate.
:'''Note''': this template does not indicate a "higher status" within the community  for an essay, but is used to denote  that the essay in question has wide acceptance to be linked from said policy or guideline page. If consensus changes or content is outdated and the essay is no longer referenced in a policy or guideline, change the tag to the more common  {{tlx|Essay|interprets{{=}}}} or {{tlx|Information page}} template, as appropriate.
Line 11: Line 11:
==Parameters==  
==Parameters==  
'''This template has an {{para|interprets}} a.k.a. {{para|pages}} parameter that must be used'''. Replaces "such guidance" with "the {{var|foo}}" where "{{var|foo}}" is a link to one or more policies or guidelines {{em|and}} label(s) for what they are, e.g.:
'''This template has an {{para|interprets}} a.k.a. {{para|pages}} parameter that must be used'''. Replaces "such guidance" with "the {{var|foo}}" where "{{var|foo}}" is a link to one or more policies or guidelines {{em|and}} label(s) for what they are, e.g.:
* {{para|interprets|<nowiki>[[BattleTechWiki:No original research]]</nowiki> policy}}
* {{para|interprets|<nowiki>[[BattleIntelligence:No original research]]</nowiki> policy}}
* {{para|interprets|<nowiki>[[BattleTechWiki:Manual of Style]]</nowiki> guideline}}
* {{para|interprets|<nowiki>[[BattleIntelligence:Manual of Style]]</nowiki> guideline}}
* {{para|interprets|<nowiki>[[BattleTechWiki:No original research]] and [[BattleTechWiki:Neutral point of view]]</nowiki> policies}}
* {{para|interprets|<nowiki>[[BattleIntelligence:No original research]] and [[BattleIntelligence:Neutral point of view]]</nowiki> policies}}
* {{para|interprets|<nowiki>[[BattleTechWiki:Verifiability]] policy and [[BattleTechWiki:Identifying reliable sources]]</nowiki> guideline}}
* {{para|interprets|<nowiki>[[BattleIntelligence:Verifiability]] policy and [[BattleIntelligence:Identifying reliable sources]]</nowiki> guideline}}


You can also use {{tlx|section link}} to produce better-looking links to page sections, e.g.: {{para|interprets|<nowiki>{{section link|BattleTechWiki:Article titles#Deciding on an article title}} policy</nowiki>}}, which renders as "the {{section link|BattleTechWiki:Article titles#Deciding on an article title}} policy".
You can also use {{tlx|section link}} to produce better-looking links to page sections, e.g.: {{para|interprets|<nowiki>{{section link|BattleIntelligence:Article titles#Deciding on an article title}} policy</nowiki>}}, which renders as "the {{section link|BattleIntelligence:Article titles#Deciding on an article title}} policy".


The template also has optional {{para|shortcut}}, {{para|shortcut2}}, {{para|shortcut3}}, and {{para|shortcut4}} parameters that can be used to add a ''Shortcut:'' box to the right-side, with up to four [[BTW:SHORTCUT|shortcuts]].
The template also has optional {{para|shortcut}}, {{para|shortcut2}}, {{para|shortcut3}}, and {{para|shortcut4}} parameters that can be used to add a ''Shortcut:'' box to the right-side, with up to four [[BTW:SHORTCUT|shortcuts]].
Line 41: Line 41:
"label": "Interprets",
"label": "Interprets",
"description": "Parameter that must be used'''. Replaces \"such guidance\" with \"the {{var|foo}}\" where \"{{var|foo}}\" is a link to one or more policies or guidelines {{em|and}} label(s) for what they are",
"description": "Parameter that must be used'''. Replaces \"such guidance\" with \"the {{var|foo}}\" where \"{{var|foo}}\" is a link to one or more policies or guidelines {{em|and}} label(s) for what they are",
"example": "[[BattleTechWiki:Verifiability]] policy",
"example": "[[BattleIntelligence:Verifiability]] policy",
"type": "string",
"type": "string",
"required": true
"required": true
Line 67: Line 67:


===Examples===
===Examples===
* {{tlx|supplement|interprets{{=}}[<nowiki />[BattleTechWiki:Neutral point of view]] policy}}
* {{tlx|supplement|interprets{{=}}[<nowiki />[BattleIntelligence:Neutral point of view]] policy}}
::becomes:
::becomes:
{{supplement|interprets=[[BattleTechWiki:Neutral point of view]] policy}}
{{supplement|interprets=[[BattleIntelligence:Neutral point of view]] policy}}
* {{tlx|supplement|interprets{{=}}[<nowiki />[BattleTechWiki:Neutral point of view]] policy|shortcut{{=}}BTW:SHORTCUT|shortcut2{{=}}BTW:SHORTCUT2}}
* {{tlx|supplement|interprets{{=}}[<nowiki />[BattleIntelligence:Neutral point of view]] policy|shortcut{{=}}BTW:SHORTCUT|shortcut2{{=}}BTW:SHORTCUT2}}
::becomes:
::becomes:
{{supplement|interprets=[[BattleTechWiki:Neutral point of view]] policy|shortcut=BTW:SHORTCUT|shortcut2=BTW:SHORTCUT2}}
{{supplement|interprets=[[BattleIntelligence:Neutral point of view]] policy|shortcut=BTW:SHORTCUT|shortcut2=BTW:SHORTCUT2}}
* {{tlx|supplement|interprets{{=}}[<nowiki />[BattleTechWiki:Neutral point of view]] and [<nowiki />[Policy:Real People]] }}
* {{tlx|supplement|interprets{{=}}[<nowiki />[BattleIntelligence:Neutral point of view]] and [<nowiki />[Policy:Real People]] }}
::becomes:
::becomes:
{{supplement|interprets=[[BattleTechWiki:Neutral point of view]] and [[Policy:Real People]]}}
{{supplement|interprets=[[BattleIntelligence:Neutral point of view]] and [[Policy:Real People]]}}


== Categorization==
== Categorization==
Line 81: Line 81:


If there is a need to put the page in an eventual more-specific subcategory, this can be accomplished with {{para|category}}, using a fully wikilinked category as input. E.g.:<br />
If there is a need to put the page in an eventual more-specific subcategory, this can be accomplished with {{para|category}}, using a fully wikilinked category as input. E.g.:<br />
{{in5}}{{tlx|Supplement |interprets{{=}}<nowiki>[[BattleTechWiki:Manual of Style]] guideline</nowiki>&#32;|'''category{{=}}<nowiki></nowiki>'''}}
{{in5}}{{tlx|Supplement |interprets{{=}}<nowiki>[[BattleIntelligence:Manual of Style]] guideline</nowiki>&#32;|'''category{{=}}<nowiki></nowiki>'''}}


This feature should not be used to add an additional category (as this would remove inclusion in [[:Category:Supplemental pages]] or any subcategory thereof).  To add additional categories, simply put them at page-bottom, as usual.
This feature should not be used to add an additional category (as this would remove inclusion in [[:Category:Supplemental pages]] or any subcategory thereof).  To add additional categories, simply put them at page-bottom, as usual.
Line 87: Line 87:
==See also==
==See also==
* {{tlx|Information page}} – the banner template for pages that are more just informational and non-opinionated
* {{tlx|Information page}} – the banner template for pages that are more just informational and non-opinionated
* {{tlx|BattleTechWiki how-to}} – the banner template for pages that are more directly instructional and non-opinionated.
* {{tlx|BattleIntelligence how-to}} – the banner template for pages that are more directly instructional and non-opinionated.
*{{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.
<includeonly>{{Sandbox other||
<includeonly>{{Sandbox other||

Latest revision as of 01:11, 1 May 2025

Usage

Use this template carefully, only when there is a well-established consensus at the relevant policy or guideline page to use this template on an essay that links from the relevant policy or guideline.

The noun supplement does not mean "an interpretation" nor just "something added". It means precisely "something added, especially to make up for a deficiency", in this case a lack or gap in an official BattleIntelligence's policy or guideline. The intent is to further elaborate on BattleIntelligence's policies or guidelines in an impartial and informative manner.

Note: this template does not indicate a "higher status" within the community for an essay, but is used to denote that the essay in question has wide acceptance to be linked from said policy or guideline page. If consensus changes or content is outdated and the essay is no longer referenced in a policy or guideline, change the tag to the more common {{Essay|interprets=}} or {{Information page}} template, as appropriate.

Parameters

This template has an |interprets= a.k.a. |pages= parameter that must be used. Replaces "such guidance" with "the foo" where "foo" is a link to one or more policies or guidelines and label(s) for what they are, e.g.:

  • |interprets=[[BattleIntelligence:No original research]] policy
  • |interprets=[[BattleIntelligence:Manual of Style]] guideline
  • |interprets=[[BattleIntelligence:No original research]] and [[BattleIntelligence:Neutral point of view]] policies
  • |interprets=[[BattleIntelligence:Verifiability]] policy and [[BattleIntelligence:Identifying reliable sources]] guideline

You can also use {{section link}} to produce better-looking links to page sections, e.g.: |interprets={{section link|BattleIntelligence:Article titles#Deciding on an article title}} policy, which renders as "the BattleIntelligence:Article titles § Deciding on an article title policy".

The template also has optional |shortcut=, |shortcut2=, |shortcut3=, and |shortcut4= parameters that can be used to add a Shortcut: box to the right-side, with up to four shortcuts.

No description.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
11 shortcut1

first shortcut

Example
BTW:PGE
Stringsuggested
22

no description

Unknownoptional
33

no description

Unknownoptional
44

no description

Unknownoptional
pagespages

no description

Unknownoptional
Interpretsinterprets pages

Parameter that must be used'''. Replaces "such guidance" with "the {{var|foo}}" where "{{var|foo}}" is a link to one or more policies or guidelines {{em|and}} label(s) for what they are

Example
[[BattleIntelligence:Verifiability]] policy
Stringrequired
Shortcutshortcut

Parameters that can be used to add a ''Shortcut:'' box to the right-side

Example
BTW:DRAFT
Unknownoptional
shortcut1shortcut1

no description

Unknownoptional
Shortcut2shortcut2

no description

Unknownoptional
Shortcut3shortcut3

no description

Unknownoptional
Shortcut4shortcut4

no description

Unknownoptional
categorycategory

no description

Unknownoptional

Examples

  • {{supplement|interprets=[[BattleIntelligence:Neutral point of view]] policy}}
becomes:
  • {{supplement|interprets=[[BattleIntelligence:Neutral point of view]] policy|shortcut=BTW:SHORTCUT|shortcut2=BTW:SHORTCUT2}}
becomes:
  • {{supplement|interprets=[[BattleIntelligence:Neutral point of view]] and [[Policy:Real People]]}}
becomes:


Categorization

This template adds a page to Category:Supplemental pages, by default. If the page is in userspace (e.g. is a draft of a supplement, or is a mistaken use of the template for something intended to remain a user essay), it will instead be put into Category:User essays.

If there is a need to put the page in an eventual more-specific subcategory, this can be accomplished with |category=, using a fully wikilinked category as input. E.g.:
     {{Supplement|interprets=[[BattleIntelligence:Manual of Style]] guideline |category=}}

This feature should not be used to add an additional category (as this would remove inclusion in Category:Supplemental pages or any subcategory thereof). To add additional categories, simply put them at page-bottom, as usual.

See also

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