Wikipedia

Module:WikiProject banner/doc: Difference between revisions

Browse history interactively
← Previous edit
Content deleted Content added
VisualWikitext
m Typo fixing, replaced: featue → feature, assesments → assessments
 
(14 intermediate revisions by 5 users not shown)
Line 1:
{{moduleModule rating|protected}}
{{WikiProject banner related}}
{{highHigh-use|all-pages=yes}}
{{Uses TemplateStyles|Module:WikiProject banner/styles.css|Module:Message box/tmbox.css}}
{{Lua|Module:Arguments|Module:Check for unknown parameters|Module:Message box|Module:Pagetype|Module:Template parameter value|Module:WikiProject banner/config|Module:WikiProject banner/templatepage|Module:Wikitext Parsing|Module:Yesno|noprotcat=yes}}
{{See also|Module:Banner shell|Template:WikiProject banner shell}}
 
[[Module:WikiProject banner]] can be used to create [[:Category:WikiProject banner templates|WikiProject banners]], enabling new projects to easily create a banner to place on article [[WP:TALK|talk pages]], ensuring standardisation between projects. A list of all WikiProject banners using this meta-template can be found [https://en.wikipedia.org/w/index.php?title=Special:WhatLinksHere/Module:WikiProject_banner&namespace=10&hidelinks=1&hideredirs=1&limit=250 here].
Line 26 ⟶ 27:
|PROJECT =
|substcheck=<includeonly>{{subst:</includeonly><includeonly>substcheck}}</includeonly>
|category={{{category|}}}
|listas={{{listas|}}}
|DOC = auto
Line 59:
**{{para|DOC|none}} &ndash; (or left blank) will not include any documentation.-->
*<code>'''substcheck'''</code> &ndash; this allows the template to detect if it has been substituted instead of transcluded and give an error message. '''''<syntaxhighlight lang="wikitext" inline>substcheck=<includeonly>{{subst:</includeonly><includeonly>substcheck}}</includeonly></syntaxhighlight>'''''
*<code>'''category'''</code> ''(Required)'' &ndash; the 'category' parameter ''must'' be passed through the template to enable category optout. ''E.g.: '''<code><nowiki>category={{{category|}}}</nowiki></code>'''''.
*<code>'''listas'''</code> ''(Required)'' &ndash; the 'listas' parameter ''must'' be passed through the template. {{nowrap|''Eg: '''<code><nowiki>listas={{{listas|}}}</nowiki></code>'''''}}
*<code>'''IMAGE_LEFT'''</code> &ndash; the ___location of an image to use in the top-left corner of the banner. '''''Do not''''' include the "''File:''" prefix. Images used on WikiProject banners '''''must''''' be free images&nbsp;– [[WP:FU|fair use]] images are '''''not''''' permitted. {{nowrap|''Eg: '''<code>[[:File:Tulipa suaveolens floriade to Canberra.jpg|Tulipa suaveolens floriade to Canberra.jpg]]</code>'''''}}
Line 69 ⟶ 68:
*<code>'''PORTAL'''</code> &ndash; if the WikiProject maintains a [[WP:Portal|portal]], define this parameter with the portal name. The associated image is held centrally at [[Module:Portal/images]]. {{nowrap|''Eg: '''<code><nowiki>Tulips</nowiki></code>'''''}}
*<code>'''MAIN_CAT'''</code> &ndash; the default is ''no'' main category created; if defined, all pages displaying the template will be sorted into [[:Category:MAIN_CAT|Category:<code>MAIN_CAT</code>]]. {{nowrap|''Eg: '''<code><nowiki>WikiProject Tulips articles</nowiki></code>''' → [[:Category:WikiProject Tulips articles]]''}}
*<code>'''BOTTOM_TEXT'''</code> &ndash; if defined, contains text that will appear across the bottom of the banner and above the [[#Collapsed|collapsed section]] (if one is present). Please '''''do not''''' use this parameter to '[[hooking|hook]]' extra code to the bottom of the template &ndash; see the [[#Hooks|''hooks'']] section below for a better solution.
{{-}}
 
Line 78 ⟶ 77:
|PROJECT = Tulips
|substcheck=<includeonly>{{subst:</includeonly><includeonly>substcheck}}</includeonly>
|category={{{category|}}}
|listas={{{listas|}}}
|PROJECT_LINK = Wikipedia:Somewhere about tulips
Line 91 ⟶ 89:
|PROJECT_LINK = Wikipedia:Somewhere about tulips
|IMAGE_LEFT = Tulipa suaveolens floriade to Canberra.jpg
|IMAGE_LEFT_SIZE = 50px
|MAIN_ARTICLE = [[tulip]]s, [[liliaceae]] and related articles
|category=no
Line 119 ⟶ 117:
|PROJECT = Tulips
|substcheck=<includeonly>{{subst:</includeonly><includeonly>substcheck}}</includeonly>
|category={{{category|}}}
|listas={{{listas|}}}
|IMAGE_LEFT = Tulipa suaveolens floriade to Canberra.jpg
Line 165 ⟶ 162:
|PROJECT = Tulips
|substcheck=<includeonly>{{subst:</includeonly><includeonly>substcheck}}</includeonly>
|category={{{category|}}}
|listas={{{listas|}}}
|IMAGE_LEFT = Tulipa suaveolens floriade to Canberra.jpg
Line 228 ⟶ 224:
|PROJECT = Tulips
|substcheck=<includeonly>{{subst:</includeonly><includeonly>substcheck}}</includeonly>
|category={{{category|}}}
|listas={{{listas|}}}
|IMAGE_LEFT = Tulipa suaveolens floriade to Canberra.jpg
Line 261 ⟶ 256:
|category=no
}}
 
====Inactive task force====
If a task force has been deemed inactive, then the following parameter and text can be used:
 
|TF_{{red|''N''}}_TEXT = This _PAGETYPE_ is within the scope of the <nowiki>[[Wikipedia:WikiProject</nowiki> {{red|(name of project)}}/{{red|(name of task force)}}|{{red|(name of task force)}}]], a task force which is currently considered to be <nowiki>'''[[Wikipedia:WikiProject Council/Guide#Dealing with inactive WikiProjects|inactive]]'''</nowiki>.
 
:where "{{red|''N''}}{{thin space}}" is the number of the task force, and the project and task force names are included where indicated.
 
==Advanced features==
Line 312 ⟶ 314:
|TODO_TEXT =
|TODO_TITLE =
|TODO_STYLE =
|TODO_TITLE_STYLE=
|TODO_EDITLINKS =
</syntaxhighlight>
|}
There are two main parameters, {{para|TODO_LINK}} and {{para|TODO_TEXT}}. Only one should be used at any time. If the to-do list is located on a different page then <code>TODO_LINK</code> should be used. However, if you've just got some text to include then you can use the <code>TODO_TEXT</code> option instead.
 
Styling can be adjusted using the {{para|TODO_STYLE}} and {{para|TODO_TITLE_STYLE}} parameters.
 
If you are using {{para|TODO_LINK}} and don't want to see the edit links at the top of the textbox, set <code>TODO_EDITLINKS=no</code>.
Line 328 ⟶ 326:
{{#invoke:WikiProject banner|main
|PROJECT = Tulips
|category={{{category|}}}
|listas={{{listas|}}}
|NAME = The Tulip taskforce
Line 411 ⟶ 408:
</syntaxhighlight>
|}
This featuefeature enables a project collaboration system to be integrated into a project banner. The following parameters are used:
 
==== Required parameters ====
Line 437 ⟶ 434:
|ACR_FAIL_CAT =
|ACR_CURRENT_CAT =
|ACR_PRELOAD =
</syntaxhighlight>
|}
Line 453 ⟶ 451:
*<code>'''ACR_SIZE'''</code> &ndash; a custom image size can be set, using the usual note syntax. {{nowrap|''Eg: '''<code><nowiki>20x20px</nowiki></code>''' ''}}
*<code>'''ACR_INVALID_CAT'''</code> &ndash; pages specifying the A Class parameter without a valid SUBPAGE_LINK page existing will be categorised into this category.
*<code>'''ACR_PRELOAD'''</code> &ndash; preload template, to be used when creating a new A-class review discussion page ([[Wikipedia:WikiProject Military history/Review/A-Class review preload boilerplate|example]]).
 
=== Additional task force categories ===
Line 501 ⟶ 500:
*<code>'''peer review title'''</code> &ndash; If the page has been moved since it was reviewed, pass this parameter to specify the old page title (the one the review was archived under) to make the link point correctly to the review.
*<code>'''PR_INVALID_CAT'''</code> &ndash; if defined, pages without a valid existing peer review page will be categorised into this category.
 
=== Other hooks===
{{deprecated|WPBannerMeta/hooks}}
WPBannerMeta incorporates a number of '[[hooking|hooks]]' where advanced or customised features can be added. These should take the form of a subtemplate passed to the relevant hook parameter. Any relevant parameters should then be passed to the hook template &ndash; it may be necessary to repeat parameters that are already passed to the main template ({{para|category|<nowiki>{{{category|}}}</nowiki>}} and {{para|class|<nowiki>{{{class|}}}</nowiki>}} are commonly used).
 
===Custom masks===
{{selfref|For further details, see: [[Template:Class mask/doc]]}}
The module uses a [[mask (computing)|mask]] to normalise the values given to the {{para|class}} parameter, to ensure that invalid inputs are discarded (e.g. {{para|class|cheesecake}}) and that equivalent inputs appear the same (e.g. {{para|class|FA}} and {{para|class|fA}}). This mask effectively controls which extended assessment scale values are accepted by the template (e.g. "Template-Class", "Redirect-Class", etc.). Projects which want to use more obscure assessment classes (e.g. "Future-Class", "Bplus-Class", etc.) or to ''not'' use all of the standard classes (e.g. not using "C-Class") can define their own custom mask, which will override the default. To achieve this, create the mask template in the /class subpage of your project banner template and set {{para|QUALITY_CRITERIA|custom}}. Note that this will remove the project from [[WP:PIQA|project-independent quality assesmentsassessments]], and so no assessments will be inherited from other projects.
 
== Inactive WikiProject banners ==
Line 523 ⟶ 518:
<syntaxhighlight lang="wikitext">{{#invoke:WikiProject banner|inactive
|PROJECT = Extreme sports
|category={{{category|}}}
}}</syntaxhighlight>
:produces:
{{#invoke:WikiProject banner|inactive|PROJECT=Extreme sports|category=no}}
:When inside a banner shell the result is:
{{WikiProjectBannerShellWikiProject banner shell|
{{#invoke:WikiProject banner|inactive|PROJECT=Extreme sports|category=no}}
}}
 
<syntaxhighlight lang="wikitext">{{#invoke:WikiProject banner|inactive
Line 535 ⟶ 531:
}}</syntaxhighlight>
:produces:
{{#invoke:WikiProject banner|inactive|PROJECT=Policy and Guidelines|PROJECT_STATUS=defunct|category=no}}
:When inside a banner shell the result is:
{{WikiProjectBannerShellWikiProject banner shell|
{{#invoke:WikiProject banner|inactive|PROJECT=Policy and Guidelines|PROJECT_STATUS=defunct}}|category=no}}
}}
 
==See also==
Line 550 ⟶ 548:
[[Category:WikiProject banner templates|*]]
[[Category:Template metamodules]]
[[Category:Pages related to the WikiProject meta banner|*]]
 
}}</includeonly>
Retrieved from "https://en.wikipedia.org/wiki/Module:WikiProject_banner/doc"