Jump to content

Template:WikiProject Portals/doc: Difference between revisions

From Wikipedia, the free encyclopedia
Content deleted Content added
revert
improve documentation
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
__NOTOC__
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
== Usage ==
<!-- Shamelessly copying skeleton from [[Template:WikiProject_Computing/doc]] -->
When you create or find a new page within the scope of [[WP:WikiProject Portals|WikiProject Portals]] please add any of the following to the top of its talk page: <source lang=moin>{{WikiProject Portals |class= |importance= }}</source><source lang=moin>{{WikiProject Portals |class= |importance= |historical= |small= |listas= }}</source><source lang=moin>{{WikiProject Portals
===Project banner=== <!-- PLEASE DON'T CHANGE THE LEVEL OF THIS HEADING, AS IT IS NECESSARY FOR PROPER TRANSCLUSION. -->
|class =
The '''{{tl|WikiProject Portals}}''' project banner template should be added (''not'' [[WP:SUBST|subst:ed]]) to the talk page of every portal within the scope of the project.
|importance =
|historical =
|small =
|listas =
}}</source> Unused parameters may be omitted. This template automatically adds pages to {{cl|Portals}}.


=== Usage ===
===Optional parameters===
{{WPBannerDoc|class|PROJECT=Portals |PROJECT_LINK= |ASSESSMENT_LINK= |BANNER_NAME=Template:WikiProject Portals |QUALITY_SCALE=inline |class_values={{WPBannerDoc/class mask
While the template does not require any additional parameters, it has a number of optional ones that add various extra features to the banner.&nbsp; The full syntax is as follows:
|portal=yes
<!-- You can keep these manually in sync, or just replace the below with: {{subst:#tag:pre|{{subst:Parameters|code|base={{subst:BASEPAGENAME}}}}|style=overflow: auto;}} -->
|category=yes
<pre style="overflow: auto;">{{WikiProject Portals
|redirect=yes
| small =
|project=yes
| category =
|template=yes
| listas =
|draft=yes
| class =
|file=yes
| importance =
|fa=no
| historical =
|fl=no
}}</pre>
|a=no
|ga=no
|b=no
|c=no
|start=no
|stub=no
|list=no
}}}}
{{WPBannerDoc/note|historical|NOTE_TEXT=if the page is currently inactive and is retained for historical reference. |NOTE_CAT=Historical Portal pages }}
{{WPBannerDoc|importance|PROJECT=Portals |PROJECT_LINK= |ASSESSMENT_LINK= |BANNER_NAME=Template:WikiProject Portals |IMPORTANCE_SCALE=inline |importance_values=top, high, mid, low, na }}
{{WPBannerDoc|listas|first=The |last=Beatles }}
{{WPBannerDoc|small}}
{{WPBannerDoc|category}}


=== Parameters ===
== Redirects ==
<!-- Maybe we should just show the TemplateData block instead? -->
* <code>small</code> - Shows the reduced size template
* <code>category</code> - Flag the page as a category
* <code>listas</code> - Name used to list the page in categories, if different from PAGENAME
* <code>importance</code> - Page priority rating on the assessment scale
* <code>class</code> - Page quality rating on the assessment scale
* <code>historical</code> - Marks a page as historical

=== Redirects ===
* {{tl|WP Portals}}
* {{tl|WP Portals}}


=== See Also ===
== See also ==
{{cl|WikiProject Portals templates}}
{{cl|WikiProject Portals templates}}


=== TemplateData ===
== TemplateData ==
<templatedata>
<templatedata>
{
{

Revision as of 13:52, 1 June 2018

Usage

When you create or find a new page within the scope of WikiProject Portals please add any of the following to the top of its talk page:

{{WikiProject Portals |class= |importance= }}
{{WikiProject Portals |class= |importance= |historical= |small= |listas= }}
{{WikiProject Portals
|class      = 
|importance = 
|historical = 
|small      = 
|listas     = 
}}

Unused parameters may be omitted. This template automatically adds pages to Category:Portals.

Optional parameters

  • class – valid values are category, draft, file, portal, project, redirect, template, na (case-insensitive). See the project's quality scale for details. Setting an explicit value of NA is rarely necessary; for this, either leave |class= blank or omit the parameter.
  • historical – set |historical=yes if the page is currently inactive and is retained for historical reference.
  • importance – valid values are: top, high, mid, low, na (case-insensitive). See the project's importance scale for details. Setting an explicit value of NA is rarely necessary; for this, either leave |importance= blank or omit the parameter.
  • listas – This parameter, which is the equivalent of the DEFAULTSORT sortkey that should be placed on all biographical articles, is a sortkey for the article talk page (e.g. for The Beatles, use |listas=Beatles, The so that the talk page will show up in the B's and not the T's of the various assessment and administrative categories). This is important because it is one source used by those who set DEFAULTSORT on the article; consider also setting the DEFAULTSORT for the article when setting this parameter. For more information about this, please see Wikipedia:Categorization of people § Ordering names in a category.
    If the article is using {{WikiProject banner shell}} then it is preferable to add |listas= to that template instead of a project banner template. Putting the parameter on more than one template is not required.
  • small – this parameter is no longer supported and can safely be removed from the template.
  • category – set |category=no if, and only if, a banner is being used for demonstration or testing purposes, to prevent unnecessary or undesirable categorization. Otherwise, omit this parameter.

Redirects

See also

Category:WikiProject Portals templates

TemplateData

Banner for tagging and assessing pages related to WikiProject Portals

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Smallsmall

Shows the reduced size template

Example
small=yes, small=y
Booleanoptional
Categorycategory

Flag the page as a category

Default
no
Example
category=yes, cat=y
Booleanoptional
ListAslistas

Name used to list the page in categories, if different from PAGENAME

Example
listas="Doe, John"
Stringoptional
Classclass

Page quality rating on the assessment scale

Example
class=start, class=B
Stringsuggested
Importanceimportance

Page priority rating on the assessment scale

Example
importance=top, importance=low
Stringsuggested
Historicalhistorical

Marks a page as historical

Default
no
Example
historical=yes
Booleanoptional