Template:Guideline/doc: Difference between revisions
imported>Deadfire m updating cat |
Tungstenchan (talk | contribs) m Text replacement - "BattleTechWiki" to "BattleIntelligence" |
||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
{{Template notes |style=margin-bottom:1.0em; | {{Template notes |style=margin-bottom:1.0em; | ||
| This template should only be used on pages that are formal [[BTW:Policies and guidelines| | | This template should only be used on pages that are formal [[BTW:Policies and guidelines|BattleIntelligence guidelines]]. | ||
| For advice that is {{em|not}} a | | For advice that is {{em|not}} a BattleIntelligence guideline, use the {{tl|Essay}} or one of its variants, instead. | ||
| Please do not apply this template to any page without first advertising your [[BTW:PROPOSAL|proposal]] to other editors via a [[BTW:RFC|request for comments]], as described below. | | Please do not apply this template to any page without first advertising your [[BTW:PROPOSAL|proposal]] to other editors via a [[BTW:RFC|request for comments]], as described below. | ||
}} | }} | ||
This template is for [[BTW:Policies and guidelines|formal | This template is for [[BTW:Policies and guidelines|formal BattleIntelligence guidelines]] that can be classified more specifically by topic. For the rare case of a guideline that does not suit any of these categorizations, you can use {{tl|Guideline}}. | ||
==Usage== | ==Usage== | ||
| Line 21: | Line 21: | ||
*For <kbd>{{var|category sort key}}</kbd> such as notability or naming conventions guidelines, use what is in the parenthetical disambiguator, and capitalise it. | *For <kbd>{{var|category sort key}}</kbd> such as notability or naming conventions guidelines, use what is in the parenthetical disambiguator, and capitalise it. | ||
*For the optional <kbd>{{var|shortcut}}</kbd>, use an established [[ | *For the optional <kbd>{{var|shortcut}}</kbd>, use an established [[BattleIntelligence:Shortcut|shortcut]]; it is not necessary to wrap it in <code><nowiki>[[...]]</nowiki></code>. For example: '''<kbd>BTW:{{var|FOO}}</kbd>''' | ||
**For the next optional shortcut, use another established shortcut. You can use up to five shortcuts in total, each as a separate parameter. | **For the next optional shortcut, use another established shortcut. You can use up to five shortcuts in total, each as a separate parameter. | ||
*The parameter {{para|section|y}} can be used to tweak the wording to refer to a section instead of the whole page. This is only used when an guideline of a particular sort (e.g. a naming convention) is a section in a larger combined guideline, it is not to be used for each section in guideline page that is all of the same category. | *The parameter {{para|section|y}} can be used to tweak the wording to refer to a section instead of the whole page. This is only used when an guideline of a particular sort (e.g. a naming convention) is a section in a larger combined guideline, it is not to be used for each section in guideline page that is all of the same category. | ||
==New or greatly modified guidelines require community approval== | ==New or greatly modified guidelines require community approval== | ||
If you or a wikiproject have drafted a new guideline or substantially revised one, the | If you or a wikiproject have drafted a new guideline or substantially revised one, the BattleIntelligence community must have significant time to consider the proposal and arrive at a [[BTW:Consensus|consensus]] about it. See the [[BTW:PROPOSAL]] policy for the current best practices on neutrally soliciting input on a proposal from as wide a selection of the community as is practical. | ||
For more suggestions and background on how to go from a proposal to a | For more suggestions and background on how to go from a proposal to a BattleIntelligence guideline, see [[:Category:Proposals]] and [[BattleIntelligence:How to contribute to BattleIntelligence guidance]]. | ||
==See also== | ==See also== | ||
* {{tl|MoS-guideline}} – for the style guidelines that are part of our wiki's [[BTW:MOS|Manual of Style]] | * {{tl|MoS-guideline}} – for the style guidelines that are part of our wiki's [[BTW:MOS|Manual of Style]] | ||
* {{tl|Proposed}} – to solicit comments from the wider community before declaring a page to be a guideline | * {{tl|Proposed}} – to solicit comments from the wider community before declaring a page to be a guideline | ||
* For other [[:Category:Header templates|header templates]], see [[ | * For other [[:Category:Header templates|header templates]], see [[BattleIntelligence:Template index/Project namespaces|Template index/Project namespaces]]. | ||
{{When on basepage | {{When on basepage | ||
Latest revision as of 01:03, 1 May 2025
 | This is a documentation subpage for Template:Guideline. It may contain usage information, categories and other content that is not part of the original template page. |
 | Template usage notes
|
This template is for formal BattleIntelligence guidelines that can be classified more specifically by topic. For the rare case of a guideline that does not suit any of these categorizations, you can use {{Guideline}}.
Usage
{{Guideline/doc|section=|guideline category|category sort key|shortcut|...|shortcut5}}
Template parameters
- For guideline category, use one of the following:
- behavioral guideline
- content guideline
- deletion guideline
- editing guideline
- naming convention
- notability guideline
- For category sort key such as notability or naming conventions guidelines, use what is in the parenthetical disambiguator, and capitalise it.
- For the optional shortcut, use an established shortcut; it is not necessary to wrap it in
[[...]]. For example: BTW:FOO- For the next optional shortcut, use another established shortcut. You can use up to five shortcuts in total, each as a separate parameter.
- The parameter
|section=ycan be used to tweak the wording to refer to a section instead of the whole page. This is only used when an guideline of a particular sort (e.g. a naming convention) is a section in a larger combined guideline, it is not to be used for each section in guideline page that is all of the same category.
New or greatly modified guidelines require community approval
If you or a wikiproject have drafted a new guideline or substantially revised one, the BattleIntelligence community must have significant time to consider the proposal and arrive at a consensus about it. See the BTW:PROPOSAL policy for the current best practices on neutrally soliciting input on a proposal from as wide a selection of the community as is practical.
For more suggestions and background on how to go from a proposal to a BattleIntelligence guideline, see Category:Proposals and BattleIntelligence:How to contribute to BattleIntelligence guidance.
See also
- {{MoS-guideline}} – for the style guidelines that are part of our wiki's Manual of Style
- {{Proposed}} – to solicit comments from the wider community before declaring a page to be a guideline
- For other header templates, see Template index/Project namespaces.