Difference between revisions of "Template:Essay/doc"

From blackwiki
Jump to navigation Jump to search
(Blanked the page)
imported>LightandDark2000
m (Reverted edits by 182.0.212.178 (talk) to last version by Feminist)
Line 1: Line 1:
 +
{{documentation subpage}}
 +
{{Do not substitute}}
 +
==Usage==
 +
{{See|WP:Essays}}
 +
This template adds the page to [[:Category:Wikipedia essays]] or to [[:Category:User essays]], depending on [[Wikipedia:Namespace|namespace]].
  
 +
Please do '''not''' [[Wikipedia:Substitution|subst]] this template.
 +
 +
* <code><nowiki>{{essay|WP:SHORTCUT1}}</nowiki></code> becomes:
 +
{{essay|WP:SHORTCUT1}}
 +
 +
===Parameters===
 +
 +
This template has an {{para|interprets}} {{aka}} {{para|pages}} parameter. Replaces "This page is an essay" with "This page is an essay on {{var|[whatever you put in the parameter]}}":
 +
* {{para|interprets|<nowiki>the [[Wikipedia:No original research]]</nowiki> policy}}
 +
* {{para|interprets|<nowiki>the [[Wikipedia:Manual of Style]]</nowiki> guideline}}
 +
* {{para|interprets|<nowiki>the [[Wikipedia:No original research]] and [[Wikipedia:Neutral point of view]]</nowiki> policies}}
 +
* {{para|interprets|<nowiki>the [[Wikipedia:Verifiability]] policy and [[Wikipedia:Identifying reliable sources]]</nowiki> guideline}}
 +
 +
You can have up to 5 shortcuts displayed. The shortcut parameters can also be named as {{para|shortcut}} or {{para|shortcut1}}, {{para|shortcut2}} ... {{para|shortcut5}}.
 +
 +
You can also use {{para|cat}} or {{para|category}} to specify a more specific category than the default [[:Category:Wikipedia essays]] or (in userspace) [[:Category:User essays]]. It can be done with or without "Category:"
 +
* {{para|cat|Wikipedia essays on consensus}}
 +
* {{para|category|<nowiki>Category:Wikipedia essays on consensus</nowiki>}}
 +
* {{para|category|User essays on style‎}}
 +
* {{para|cat|<nowiki>Category:User essays on style‎</nowiki>}}
 +
Userspace essays should remain categorized in [[:Category:User essays]] or one of its subcategories with this template.
 +
 +
Essays are sorted by their page name, or in userspace by subpage name.
 +
 +
If you want to use a different category sort, you can specify an entire category link with a sort key:
 +
* {{para|cat|<nowiki>[[Category:User essays on style|Comprise, Use of]]‎</nowiki>}}
 +
 +
Additional categories (and sort keys) are added at the bottom of the essay page, as at any other page. User essays can be additionally categorized in topical subcategories of [[:Category:Wikipedia essays]] in this way.
 +
 +
===Display===
 +
* <code><nowiki>{{essay|WP:SHORTCUT1|WP:SHORTCUT2|interprets=the [[Wikipedia:Consensus|Consensus]] and [[Wikipedia:Ignore all rules|Ignore all rules]] policies}}</nowiki></code> becomes:
 +
{{essay|WP:SHORTCUT1|WP:SHORTCUT2|interprets=the [[Wikipedia:Consensus|Consensus]] and [[Wikipedia:Ignore all rules|Ignore all rules]] policies|demo=yes}}
 +
 +
===Variant templates===
 +
'''To place essays in appropriate sub-categories by subject, you can use:'''
 +
* {{tlx|Behavioral essay}}
 +
{{Behavioral essay|category=no}}
 +
* {{tlx|Civility essay}}
 +
{{Civility essay|demo=yes}}
 +
* {{tlx|Deletion essay}}
 +
{{Deletion essay|category=no}}
 +
* {{tlx|Notability essay}}
 +
{{Notability essay|category=no}}
 +
*{{tlx|Orphaned essay}}
 +
{{Orphaned essay|demo=yes}}
 +
*{{tlx|Essay in development}}
 +
{{Essay in development|demo=yes}}
 +
 +
'''The following templates are available to WikiProjects for clarifying the distinction between WikiProject guidance and other essays and [[WP:INFOPAGES|information pages]]:'''
 +
* {{tlx|WikiProject content advice}}
 +
{{WikiProject content advice|categories=no}}
 +
* {{tlx|Wikiproject notability essay}}
 +
{{Wikiproject notability essay|categories=no}}
 +
* {{tlx|WikiProject style advice}}
 +
{{WikiProject style advice|categories=no}}
 +
 +
== See also ==
 +
* {{tlx|Information page}} – the banner template for pages that are more just informational and non-opinionated like [[WP:GOV]].
 +
* {{tlx|Wikipedia how-to}} – the banner template for pages that are more directly instructional and non-opinionated like [[H:EDIT]].
 +
* {{tlx|Supplement|interprets{{=}}}}  – to tag a well-established page that adds something to a policy or guideline, to make up for a deficiency, and when it is referenced in the guideline or policy like  [[WP:BRD]].
 +
* {{tlx|Essay-like}} – designed for the main namespace, not "Wikipedia:" namespace; use if an <em>article</em> reads like an essay.
 +
* [[Wikipedia:Template messages/Wikipedia namespace|Template messages/Wikipedia namespace]], for more examples of related  templates.
 +
<includeonly>
 +
{{Sandbox other||
 +
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
 +
[[Category:Essay header templates|{{PAGENAME}}]]
 +
}}
 +
</includeonly>

Revision as of 22:48, 6 July 2019

  1. REDIRECT Template:Never substitute

Usage

This template adds the page to Category:Wikipedia essays or to Category:User essays, depending on namespace.

Please do not subst this template.

  • {{essay|WP:SHORTCUT1}} becomes:

Parameters

This template has an |interprets= a.k.a. |pages= parameter. Replaces "This page is an essay" with "This page is an essay on [whatever you put in the parameter]":

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

You can have up to 5 shortcuts displayed. The shortcut parameters can also be named as |shortcut= or |shortcut1=, |shortcut2= ... |shortcut5=.

You can also use |cat= or |category= to specify a more specific category than the default Category:Wikipedia essays or (in userspace) Category:User essays. It can be done with or without "Category:"

  • |cat=Wikipedia essays on consensus
  • |category=Category:Wikipedia essays on consensus
  • |category=User essays on style‎
  • |cat=Category:User essays on style‎

Userspace essays should remain categorized in Category:User essays or one of its subcategories with this template.

Essays are sorted by their page name, or in userspace by subpage name.

If you want to use a different category sort, you can specify an entire category link with a sort key:

  • |cat=[[Category:User essays on style|Comprise, Use of]]‎

Additional categories (and sort keys) are added at the bottom of the essay page, as at any other page. User essays can be additionally categorized in topical subcategories of Category:Wikipedia essays in this way.

Display

  • {{essay|WP:SHORTCUT1|WP:SHORTCUT2|interprets=the [[Wikipedia:Consensus|Consensus]] and [[Wikipedia:Ignore all rules|Ignore all rules]] policies}} becomes:

Variant templates

To place essays in appropriate sub-categories by subject, you can use:

Template:Notability essay

Template:Orphaned essay

The following templates are available to WikiProjects for clarifying the distinction between WikiProject guidance and other essays and information pages:

Template:WikiProject content advice

Template:Wikiproject notability essay

Template:WikiProject style advice

See also

  • {{Information page}} – the banner template for pages that are more just informational and non-opinionated like WP:GOV.
  • {{Wikipedia how-to}} – the banner template for pages that are more directly instructional and non-opinionated like H:EDIT.
  • {{Supplement|interprets=}} – to tag a well-established page that adds something to a policy or guideline, to make up for a deficiency, and when it is referenced in the guideline or policy like WP:BRD.
  • {{Essay-like}} – designed for the main namespace, not "Wikipedia:" namespace; use if an article reads like an essay.
  • Template messages/Wikipedia namespace, for more examples of related templates.