Template:WikiProject Energy/doc
This is a documentation subpage for Template:WikiProject Energy. It may contain usage information, categories and other content that is not part of the original template page. |
This template is used on approximately 27,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
This template adds articles to Category:WikiProject Energy articles. This template is a self-reference. Please add it to the article's talk page.
Usage
[edit]To add an article to the list, simply add the template to the talk page of the article with the following parameters:
{{WikiProject Energy
|class=
|importance=
|needs-infobox=
|attention=
|needs-image=
|listas=
}}
Optional parameters
[edit]- attention – set
|attention=yes
if the article needs immediate attention from experienced editors. Use only if another parameter does not cover the need for attention; this should be used sparingly. It is strongly encouraged to also add a section to the talk page explaining what needs attention.- This parameter populates Category:Energy articles needing attention.
- class – valid values are fa, a, ga, b, c, start, stub, fl, list, category, disambig, draft, file, portal, project, 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. - 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 Albert Einstein, use
|listas=Einstein, Albert
so that the talk page will show up in the E's and not the A'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. - needs-image – set
|needs-image=yes
to mark the page as needing an image.- This parameter populates Category:Energy articles needing images.
- needs-infobox – set
|needs-infobox=yes
if the article needs an infobox. Remember that infoboxes are not suitable for all articles, and can overwhelm short articles.- This parameter populates Category:Energy articles needing infoboxes.
- auto – This parameter is for the use of bots and indicates that the article has been automatically rated:
|auto=length
– based on the length of the article|auto=inherit
– because one or more other projects use this class|auto=yes
(or|auto=stub
), in conjunction with|class=stub
– as Stub-Class because it uses a stub template- Use of the above values (or value combinations) with this parameter populates Category:Automatically assessed Energy articles.
- 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.
Aliases
[edit]- The parameter
|needs-photo=
is recognised as an alias for|needs-image=
. If both|needs-image=
and|needs-photo=
are present,|needs-photo=
is ignored.
How to
[edit]Tag a page
[edit]Just add {{WikiProject Energy|class=|importance=}}
to an article at the top of the talk (discussion) page.
Rate an article with a class
[edit]... that's already tagged with {{WikiProject Energy}}
[edit]Edit the talk page, change the |class=
parameter to the appropriate rating, or add |class=
if not already present, and save the page.
See above for available ratings. Please leave comments about how to improve the article on the talk page once you've rated the article.
... that isn't
[edit]Edit the talk page, add {{WikiProject Energy|class=|importance=}}
, and change the |class=
parameter as appropriate before saving the page.
See above for available ratings. Please leave comments about how to improve the article on the talk page once you've rated the article.
Rate an article with an importance
[edit]... that's already tagged with {{WikiProject Energy}}
[edit]Edit the talk page, change the |importance=
parameter to the appropriate rating, or add |importance=
if not already present, and save the page.
See above for available ratings.
... that isn't
[edit]Edit the talk page, add {{WikiProject Energy|class=|importance=}}
, and change the |importance=
parameter as appropriate, and save the page.
See above for available ratings.
Agree that the stub rating is appropriate where the page was auto-tagged
[edit]Remove the |auto=yes
parameter from within {{WikiProject Energy}}
, such that the rating reads {{WikiProject Energy|class=stub|importance=}}
. Please also update the |importance=
parameter if appropriate.