Difference between revisions of "Template:Maintenance category/doc"

From blackwiki
Jump to navigation Jump to search
(Undid revision 998255324 by 104.255.207.51 (talk) was accident)
Line 1: Line 1:
{{Documentation subpage}}
+
documentation subpage
{{High-risk| ≈ 29615 }}
+
high risknosubstusagetemplate redirectWikipedia category
{{nosubst}}
+
ghis template should be placed at the topcategories used in the maintenance wikipedia rather than as partthe encyclopedia nbsp for example at the top Category wikipedia administration parameters
 
+
The following descriptions assume the template is Wikipediatransclusion transcluded on a page in thewikipedia category namespacecategory namespace.
== Usage ==
+
aligned table
{{Template redirect|Wikipedia category}}
+
col1stylelineheight:1.4empaddingright:1.5empaddingbottom:0.5emcolstylelineheight:1.4em;paddingbottom:0.5em;parashortcutenables a wp:shortcutshortcut to the category to be displayed by the templatemultiple shortcuts are supported:parashortcutup toparashortcutparatrackingtrue
 
+
yes on causes the template to add the pagethe category to Categorytracking categoriesand include atlxtracking categorystyle messagesmallsup<br>to add a short explanation the tracking category after the message usepara purposeshort explanation
This template should be placed at the top of categories used in the maintenance of Wikipedia rather than as part of the encyclopedia&nbsp;– for example, at the top of [[:Category:Wikipedia administration]].
+
parahiddentrueyesoncauses the template to hide the pagethe category add it to:categoryhidden categoriesand to include atlxhidden category style message can only be used if para tracking issince tracking categories are always hidden.paracontainer causes the template to add the pagethe categorytocategory:container categoriesand include atlxcontainer categorystyle messagesmallsupparaemptyinclude a tlxpossibly empty categorystyle message<br>to add a short explanationthe empty category after the message use paraemptytextShort explanationparapollutedexclude categories that legitimately contain pages in both themainwikipedia:namespacenamespace and the user namespace from Wikipedia:Database reportspolluted categories
 
+
paradesc or para orfirstHelp:Template Parametersunnamed parameter Text supplied will be placed below the template with a boldfaced headerdescription:brThe word descriptioncan be replaced by something else with paraaltSomethingubliststylefontsizepadding:0.5em;
===Parameters===
+
supcategory:Contents categorisation and Category:Tracking categories self-categorisation is prevented by settingparatrackingcategorytruesup category:Container categories selfcategorisation is prevented by settingparacontainercategorytrueonexamplecenterbigcodepre styleposition:relativebottom9px>
The following descriptions assume the template is [[Wikipedia:Transclusion|transcluded]] on a page in the [[Wikipedia:Category namespace|Category namespace]].
+
Maintenance categoryshortcutwcathidden=truetrackingpurposeghis category tracks pages tagged with tlCitation needed this text will not display sincetracking is set todescCategory for articlesand other pages such as portals and mainspace intended templatestagged as needing or more citations for verification using the tlxcitation neededtemplate Does not include discussion pages tagged withtlxTalkfactpremaintenance categoryshortcutcatwcathiddentruetrackingpurposeghis category tracks pages tagged withtlCitation neededdesc=Category for articlesand other pages, such as portals and mainspace-intended templates) tagged as needing or more citations for verificationusing thetlx citation neededtemplate does not include discussion pages tagged withtlxtalkfacttrackingcategoryno|containercategory=
 
+
nocenterbigcodepre styleposition:relative;bottom9pxMaintenance categorytracking=truepurposethis category tracks pages that use tlx|albumchartBillboard200premaintenance categorytracking=truepurpose=This category tracks pages that use tlxalbumchartbillboard200trackingcategorynocontainercategoryno
{{Aligned table
+
centerbig codepre styleposition:relative;bottom:9px;Maintenance categoryempty=trueemptytextthis category is tracking academic journals by the parafrequency parameter theirtl infobox journal  This category should ideally be empty but will be populated when non-standardparafrequency parameters are usedpremaintenance categoryemptytruemptytext this category is trackingacademic journals by theparafrequency parameter theirtlInfobox journal  This category should ideally be empty but will be populated when non-standardparafrequencyparameters are usedtrackingcategorynocontainercategoryno
|col1style=line-height:1.4em;padding-right:1.5em;padding-bottom:0.5em;
+
Seek
|col2style=line-height:1.4em;padding-bottom:0.5em;
+
other categoryheader templates
 
+
includeonly sandbox otherADD categories below this line plase category:category namespace templatescategorytracking templatesincludeonly
| {{para|shortcut}}
 
| Enables a [[WP:Shortcut|shortcut]] to the category to be displayed by the template.<br />Multiple shortcuts are supported: {{para|shortcut1}} up to {{para|shortcut5}}.
 
 
 
| {{para|tracking|true/yes/on}}
 
| Causes the template to add the page (the category) to [[:Category:Tracking categories]] and include a {{tlx|Tracking category}}-style message.{{smallsup|1}}<br />To add a short explanation of the tracking category after the message, use {{para|purpose|<var>Short explanation.</var>}}
 
 
| {{para|hidden|true/yes/on}}
 
| Causes the template to hide the page (the category), add it to [[:Category:Hidden categories]] and to include a {{tlx|Hidden category}}-style message. Can only be used if {{para|tracking}} is false since tracking categories are always hidden.
 
 
 
| {{para|container|false/off}}
 
| Causes the template to add the page (the category) to [[:Category:Container categories]] and include a {{tlx|Container category}}-style message.{{smallsup|2}}
 
 
 
| {{para|empty|false/off}}
 
| Include a {{tlx|Possibly empty category}}-style message.<br />To add a short explanation of the empty category after the message, use {{para|empty_text|<var>Short explanation.</var>}}
 
 
 
| {{para|polluted|false/off}}
 
| Exclude categories that legitimately contain pages in both the (Main) [[Wikipedia:Namespace|namespace]] and the user namespace from [[Wikipedia:Database reports/Polluted categories]].
 
 
| {{para|desc}} or {{para|1}} or {{!}} (first [[Help:Template#Parameters|unnamed parameter]])
 
| Text supplied will be placed below the template with a boldfaced header of "Description:".<br />(The word "Description" can be replaced by something else, with {{para|alt|Something else}}).
 
}}
 
{{ublist |style=font-size:95%;padding:0.5em;
 
| {{sup|1}} [[:Category:Contents]] categorisation and [[:Category:Tracking categories]] self-categorisation is prevented by setting {{para|tracking_category|true/on}}.
 
| {{sup|2}} [[:Category:Container categories]] self-categorisation is prevented by setting {{para|container_category|true/on}}.
 
}}
 
 
 
== Example ==
 
 
 
{{center|{{big|'''Code'''}}}}
 
<pre style="position:relative;bottom:9px;">
 
{{Maintenance category
 
|shortcut=CAT:WCAT
 
|hidden=true
 
|tracking=false
 
|purpose=This category tracks pages tagged with {{tl|Citation needed}}.<!-- This text will not display since "tracking" is set to "false"-->
 
|desc=Category for articles (and other pages, such as portals and mainspace-intended templates) tagged as needing or more citations for verification, using the {{tlx|Citation needed}} template. Does not include discussion pages tagged with {{tlx|Talkfact}}.
 
}}
 
</pre>
 
{{Maintenance category
 
|shortcut=CAT:WCAT
 
|hidden=true
 
|tracking=false
 
|purpose=This category tracks pages tagged with {{tl|Citation needed}}.
 
|desc=Category for articles (and other pages, such as portals and mainspace-intended templates) tagged as needing or more citations for verification, using the {{tlx|Citation needed}} template. Does not include discussion pages tagged with {{tlx|Talkfact}}.
 
|tracking_category=no|container_category=no
 
}}
 
 
 
{{center|{{big|'''Code'''}}}}
 
<pre style="position:relative;bottom:9px;">
 
{{Maintenance category
 
|tracking=true
 
|purpose=This category tracks pages that use {{tlx|albumchart|Billboard200}}.
 
}}
 
</pre>
 
{{Maintenance category
 
|tracking=true
 
|purpose=This category tracks pages that use {{tlx|albumchart|Billboard200}}.
 
|tracking_category=no|container_category=no
 
}}
 
 
 
{{center|{{big|'''Code'''}}}}
 
<pre style="position:relative;bottom:9px;">
 
{{Maintenance category
 
|empty=true
 
|empty_text =This category is tracking [[academic journal]]s by the {{para|frequency}} parameter of their {{tl|Infobox journal}}. This category should ideally be empty, but will be populated when non-standard {{para|frequency}} parameters are used.
 
}}
 
</pre>
 
{{Maintenance category
 
|empty=true
 
|empty_text =This category is tracking [[academic journal]]s by the {{para|frequency}} parameter of their {{tl|Infobox journal}}. This category should ideally be empty, but will be populated when non-standard {{para|frequency}} parameters are used.
 
|tracking_category=no|container_category=no
 
}}
 
 
 
== See also ==
 
 
 
{{Other category-header templates}}
 
 
 
<includeonly>{{Sandbox other||
 
<!----ADD CATEGORIES BELOW THIS LINE, PLEASE:---->
 
[[Category:Category namespace templates]]
 
[[Category:Tracking templates]]
 
}}</includeonly>
 

Revision as of 21:54, 13 January 2021

documentation subpage high risknosubstusagetemplate redirectWikipedia category ghis template should be placed at the topcategories used in the maintenance wikipedia rather than as partthe encyclopedia nbsp for example at the top Category wikipedia administration parameters The following descriptions assume the template is Wikipediatransclusion transcluded on a page in thewikipedia category namespacecategory namespace. aligned table col1stylelineheight:1.4empaddingright:1.5empaddingbottom:0.5emcolstylelineheight:1.4em;paddingbottom:0.5em;parashortcutenables a wp:shortcutshortcut to the category to be displayed by the templatemultiple shortcuts are supported:parashortcutup toparashortcutparatrackingtrue yes on causes the template to add the pagethe category to Categorytracking categoriesand include atlxtracking categorystyle messagesmallsup
to add a short explanation the tracking category after the message usepara purposeshort explanation parahiddentrueyesoncauses the template to hide the pagethe category add it to:categoryhidden categoriesand to include atlxhidden category style message can only be used if para tracking issince tracking categories are always hidden.paracontainer causes the template to add the pagethe categorytocategory:container categoriesand include atlxcontainer categorystyle messagesmallsupparaemptyinclude a tlxpossibly empty categorystyle message
to add a short explanationthe empty category after the message use paraemptytextShort explanationparapollutedexclude categories that legitimately contain pages in both themainwikipedia:namespacenamespace and the user namespace from Wikipedia:Database reportspolluted categories paradesc or para orfirstHelp:Template Parametersunnamed parameter Text supplied will be placed below the template with a boldfaced headerdescription:brThe word descriptioncan be replaced by something else with paraaltSomethingubliststylefontsizepadding:0.5em; supcategory:Contents categorisation and Category:Tracking categories self-categorisation is prevented by settingparatrackingcategorytruesup category:Container categories selfcategorisation is prevented by settingparacontainercategorytrueonexamplecenterbigcodepre styleposition:relativebottom9px> Maintenance categoryshortcutwcathidden=truetrackingpurposeghis category tracks pages tagged with tlCitation needed this text will not display sincetracking is set todescCategory for articlesand other pages such as portals and mainspace intended templatestagged as needing or more citations for verification using the tlxcitation neededtemplate Does not include discussion pages tagged withtlxTalkfactpremaintenance categoryshortcutcatwcathiddentruetrackingpurposeghis category tracks pages tagged withtlCitation neededdesc=Category for articlesand other pages, such as portals and mainspace-intended templates) tagged as needing or more citations for verificationusing thetlx citation neededtemplate does not include discussion pages tagged withtlxtalkfacttrackingcategoryno|containercategory= nocenterbigcodepre styleposition:relative;bottom9pxMaintenance categorytracking=truepurposethis category tracks pages that use tlx|albumchartBillboard200premaintenance categorytracking=truepurpose=This category tracks pages that use tlxalbumchartbillboard200trackingcategorynocontainercategoryno centerbig codepre styleposition:relative;bottom:9px;Maintenance categoryempty=trueemptytextthis category is tracking academic journals by the parafrequency parameter theirtl infobox journal This category should ideally be empty but will be populated when non-standardparafrequency parameters are usedpremaintenance categoryemptytruemptytext this category is trackingacademic journals by theparafrequency parameter theirtlInfobox journal This category should ideally be empty but will be populated when non-standardparafrequencyparameters are usedtrackingcategorynocontainercategoryno Seek other categoryheader templates includeonly sandbox otherADD categories below this line plase category:category namespace templatescategorytracking templatesincludeonly