Template:Information page/doc: Difference between revisions

From Zoophilia Wiki
Jump to navigationJump to search
meta>Swpb
No edit summary
meta>SMcCandlish
documenting
Line 1: Line 1:
<br />
<!-- ******************************************************************************
    ****  This is the documentation for both Template:Information_page and    ****
    ****  Template:Wikipedia_how-to (it uses #if statements to distinguish).  ****
    ******************************************************************************
-->
{{Documentation subpage}}
{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE; INTERWIKIS GO IN WIKIDATA. -->
{{#if:{{{howto|}}}
|{{distinguish2|the article tone dispute tag, [[Template:Howto]]}}
|<!-- 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 page}}]] essays.
It can be placed on top of (non-article) pages when appropriate. 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:{{#if:{{{howto|}}}|Wikipedia how-to|Wikipedia 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.
== 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:SHORT2}}
Then it looks like this:
{{<nowiki />{{BASEPAGENAME}}|WP:SHORT|WP:SHORT2|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:
{{blockindent|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}}) – name of page (policy, process, etc.) that this essay provides advice about. Don't 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}}". <small>[The deprecated old parameter name {{para|pages}} also works, but this feature only support a single page reference, so the plural makes no sense here.]</small>
* {{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:{{#if:{{{howto|}}}|Wikipedia how-to|Wikipedia 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:{{#if:{{{howto|}}}|Wikipedia how-to|Wikipedia 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]] metatemplate this template uses (this should never be necessary except in complicated [[WP:WikiProject|wikiproject]] layouts)
== TemplateData ==
<templatedata>
<templatedata>
{
{
"description": "",
"description": "",
         "params": {
         "params": {
             "pages": {"required": true,"type": "wiki-page-name","description": "Guideline being summarized",},
             "page": {"type": "wiki-page-name","description": "Guideline or other page being interpreted",},
             "shortcut1" : {"type": "wiki-page-name","description": "Shortcut to this page",},
             "shortcut1" : {"type": "wiki-page-name","description": "Shortcut to this page",},
             "shortcut2" : {"type": "wiki-page-name","description": "Shortcut to this page",},
             "shortcut2" : {"type": "wiki-page-name","description": "Shortcut to this page",},
Line 13: Line 66:
}
}
</templatedata>
</templatedata>
== See also ==
{{#if:{{{howto|}}}|
* {{tl|Howto}} – the how-to cleanup/dispute tag for articles.
* {{tl|Information page}} – the banner template for essays that are more just informational than directly instructional
|
* {{tl|Wikipedia how-to}} – the banner template for essays that are more directly instructional than just informational
}}
* [[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>

Revision as of 02:10, 23 June 2016


This is the page banner template for Wikipedia information page essays.

It can be placed on top of (non-article) pages when appropriate. 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:SHORT2}}

Then it looks like this:

{{Information page|WP:SHORT|WP:SHORT2|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 {{shortcut}} box directly below this template, like this:

Template:Blockindent

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=) – name of page (policy, process, etc.) that this essay provides advice about. Don't include [[...]] linking brackets. This will replace the wording "Wikipedia's norms and practices". [The deprecated old parameter name |pages= also works, but this feature only support a single page reference, so the plural makes no sense here.]
  • |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 metatemplate this template uses (this should never be necessary except in complicated wikiproject layouts)

TemplateData

Syntax error in JSON.

See also