Template:Information page/doc: Difference between revisions
meta>Astrologer Dr.Naveen mNo edit summary |
m 2 revisions imported |
||
(104 intermediate revisions by 60 users not shown) | |||
Line 1: | Line 1: | ||
<!-- ****************************************************************************** | |||
**** This is the documentation for both Template:Information_page and **** | |||
**** Template:Wikipedia_how-to (it uses #if statements to distinguish). **** | |||
****************************************************************************** | |||
--> | |||
{{Documentation subpage}} | |||
{{Auto short description|conditions=when it is used in Wikipedia, Help, or User space}} | |||
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE; INTERWIKIS GO IN WIKIDATA. --> | |||
{{#if:{{{howto|}}} | |||
|{{distinguish|text = the article tone dispute tag, [[Template:How-to]]}} | |||
|<!-- hatnote space for Template:Information_page/doc --> | |||
}} | |||
This is the page banner template for [[:Category:Wikipedia {{#if:{{{howto|}}}|how-to{{!}}Wikipedia how-to|information pages{{!}}Wikipedia information pages}}]]. | |||
It can be placed on top of [[WP:GOVPS|administration pages]] (not-articles) when appropriate (see [[WP:INFOPAGES]] for details). This usually means pages in the "Wikipedia:" and "Help:" namespaces, but sometimes {{#if:{{{howto|}}}|how-to guides|information pages}} also exist as user subpages. | |||
== Categorization == | |||
If a page that uses this template is in the "Wikipedia:" or "Help:" [[WP:Namespace|namespace]], then this template adds [[:Category:Wikipedia {{#if:{{{howto|}}}|how-to|information pages}}]] to the page. | |||
If the page is in the [[WP:User pages|"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 it is in some other namespace, it will not be auto-categorized, and it may be in the wrong place. | |||
3 | == Usage == | ||
This template can be used as is, like this: | |||
:{{tlc|{{BASEPAGENAME}}}} | |||
But it can also take up to three [[Wikipedia:Shortcut|shortcuts]] as parameters. It then displays a small shortcut box inside it. Like this: | |||
:{{tlc|{{BASEPAGENAME}}|WP:SHORT|WP:LONG}} | |||
Then it looks like this: | |||
{{ {{BASEPAGENAME}}|WP:SHORT|WP:LONG|demo=y}} | |||
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 {{tlc|shortcut}} box directly {{em|below}} this template, like this: | |||
{{block indent|1= | |||
{{tlx|{{BASEPAGENAME}}}}<br /> | |||
{{tlx|shortcut|WP:SHORT|WP:SHORT2|WP:SHORT3|WP:SHORT4}} | |||
}} | |||
=== Optional parameters === | |||
* {{para|1}} or {{para|sc1}}, {{para|shortcut1}}, {{para|shortcut}}, or first unnamed parameter – First [[WP:Shortcut|shortcut]]. Don't include <code><nowiki>[[...]]</nowiki></code> linking brackets in this or other shortcut parameters. | |||
* {{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|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 Wikipedia's norms and practices|Wikipedia'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>[[Wikipedia:Verifiability]] policy and the [[Wikipedia:Identifying reliable sources]] guideline</nowiki>}} | |||
* {{para|sort-by}} – Specify a [[WP:Categorization#Sort keys|sort key]] for the category. For example, if the how-to page is [[Wikipedia:Producing maps with xplanet]] and you want it category-sorted to appear under "X", use {{para|sort-by|Xplanet, Producing maps with}}. 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:Wikipedia {{#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:User essays]] categorization for pages in the "User:" namespace, but can be used to add them manually to [[:Category:Wikipedia {{#if:{{{howto|}}}|how-to|information pages}}]], in addition to the automatic user category. | |||
* {{para|nocat|y}} or {{para|demo|y}} – Bypass all categorization, when the template is used for demo purposes, e.g. in template documentation, on talk pages, etc. | |||
* {{para|style}} – Pass arbitrary CSS to the [[Template:Ombox]] base template that this template uses. | |||
== TemplateData == | |||
{{collapse top|[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}} | |||
{{TemplateData header|noheader=1}} | |||
<templatedata> | |||
{ | |||
"description": "", | |||
"params": { | |||
"page": {"type": "wiki-page-name","description": "Guideline or other page being interpreted"}, | |||
"shortcut1" : {"type": "wiki-page-name","description": "Shortcut to this page"}, | |||
"shortcut2" : {"type": "wiki-page-name","description": "Shortcut to this page"}, | |||
"shortcut3" : {"type": "wiki-page-name","description": "Shortcut to this page"}, | |||
"nocat" : {"type": "string","description": "Any value prevents addition of project category"} | |||
} | |||
} | |||
</templatedata> | |||
{{collapse bottom}} | |||
== See also == | |||
{{#if:{{{howto|}}}| | |||
* {{tlx|How-to}} – the cleanup/dispute tag for articles written in a "how-to" style. | |||
* {{tlx|Information page}} – the banner template for pages that are more just informational than directly instructional like [[WP:GOV]]. | |||
| | |||
* {{tlx|Wikipedia how-to}} – the banner template for pages that are more directly instructional than just informational like [[H:EDIT]]. | |||
}} | |||
* {{tlx|Essay|interprets{{=}}}} – the banner template for pages that are more opinionated then instructional or technical; there are several parameters and variations. | |||
* {{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]]. | |||
* [[Wikipedia:Template messages/Project namespace]] – for other "Wikipedia:"-namespace banner templates. | |||
<includeonly>{{sandbox other|| | |||
<!-- Categories below this line, please; interwikis at Wikidata --> | |||
[[Category:Wikipedia header templates]] | |||
}}</includeonly> |
Latest revision as of 17:26, 3 September 2020
This is a documentation subpage for Template:Information page. It may contain usage information, categories and other content that is not part of the original template page. |
This template adds an automatically generated short description when it is used in Wikipedia, Help, or User space. If the automatic short description is not optimal, replace it by adding {{Short description}} at the top of the article. |
This is the page banner template for Wikipedia information pages.
It can be placed on top of administration pages (not-articles) when appropriate (see WP:INFOPAGES for details). This usually means pages in the "Wikipedia:" and "Help:" namespaces, but sometimes information pages also exist as user subpages.
Categorization
If a page that uses this template is in the "Wikipedia:" or "Help:" namespace, then this template adds Category:Wikipedia 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|WP:SHORT|WP:LONG}}
Then it looks like this:
This is an information page. It is not one of Wikipedia's policies or guidelines, but rather intends to describe some aspect(s) of Wikipedia's norms, customs, technicalities, or practices. It may reflect varying levels of vetting and consensus. |
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:
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 "Wikipedia's norms and practices". If more than one page and/or any notes are intended, links must be manually coded, e.g.:|interprets=[[Wikipedia:Verifiability]] policy and the [[Wikipedia:Identifying reliable sources]] guideline
|sort-by=
– Specify a sort key for the category. For example, if the how-to page is Wikipedia:Producing maps with xplanet and you want it category-sorted to appear under "X", use|sort-by=Xplanet, Producing maps with
. 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:Wikipedia information pages. May include a category sort; example:[[Category:WikiProject Underwater Basketweaving|Article structure advice]]
This parameter does not replace the Category:User essays categorization for pages in the "User:" namespace, but can be used to add them manually to Category:Wikipedia 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 documentation used by VisualEditor and other tools
| ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
See a monthly parameter usage report for this template in articles based on this TemplateData.
TemplateData for Information page
|
See also
{{Wikipedia how-to}}
– the banner template for pages that are more directly instructional than just informational like H:EDIT.{{Essay|interprets=}}
– the banner template for pages that are more opinionated then instructional or technical; there are several parameters and variations.{{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.- Wikipedia:Template messages/Project namespace – for other "Wikipedia:"-namespace banner templates.