Template:Backlog progress bar/doc: Difference between revisions

From Portals of Phereon Wiki
Content added Content deleted
portalsofphereon>Olaroll
(Created page with "{{Documentation subpage}} == Usage == This template draws a progress bar using {{t|Progression}} and displays a statistics box. It differs from the original bar in that is d...")
 
m (7 revisions imported)
 
(6 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{Documentation subpage}}

== Usage ==
== Usage ==


This template draws a progress bar using {{t|Progression}} and displays a statistics box. It differs from the original bar in that is designed for use in backlog category elimination drives; as articles are ''removed'' from the category specified, the percentage goes ''up'' based on the original population (e.g., at the start of the drive) and the goal.
This template draws a progress bar using {{t|Progression}} and displays a statistics box. It differs from the original bar in that is designed for use in backlog category elimination drives; as articles are ''removed'' from the category specified, the percentage goes ''up'' based on the original population (e.g., at the start of the drive) and the goal.


At the end of the drive, if the statistics are to be preserved as they are, one must first |substitute the template, then substitute the two PAGESINCATEGORY [https://www.mediawiki.org/wiki/Help:Magic_words magic words] within. Invisible comments have been added to the code to make this process easier.
At the end of the drive, if the statistics are to be preserved as they are, one must first |substitute the template, then substitute all the PAGESINCATEGORY [https://www.mediawiki.org/wiki/Help:Magic_words magic words] within. Invisible comments have been added to the code to make this process easier.


==Parameters==
==Parameters==
Line 17: Line 15:
*'''goal''': Target category population, defaults to "0"
*'''goal''': Target category population, defaults to "0"
*'''unit''': Unit used, defaults to "articles"
*'''unit''': Unit used, defaults to "articles"
*'''title''': Replaces progress bar title text (link remains same)
*'''extra''': Adds an extra operation to the current value (example: +34)


=== See also ===
=== See also ===
* {{t|Progress}}
* {{t|Progression}}


<includeonly>[[Category:Templates|{{PAGENAME}}]]</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
<includeonly>[[Category:Templates|{{PAGENAME}}]]</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>

Latest revision as of 18:52, 12 December 2020

Usage[]

This template draws a progress bar using {{Progression}} and displays a statistics box. It differs from the original bar in that is designed for use in backlog category elimination drives; as articles are removed from the category specified, the percentage goes up based on the original population (e.g., at the start of the drive) and the goal.

At the end of the drive, if the statistics are to be preserved as they are, one must first |substitute the template, then substitute all the PAGESINCATEGORY magic words within. Invisible comments have been added to the code to make this process easier.

Parameters[]

Full version
{{Backlog progress bar|initial= |goal= |category= |unit= }}
Required fields
  • initial: Initial backlog population (e.g., at the start of the drive)
  • category: Backlog category, omitting the "Category:" prefix
Optional fields
  • goal: Target category population, defaults to "0"
  • unit: Unit used, defaults to "articles"
  • title: Replaces progress bar title text (link remains same)
  • extra: Adds an extra operation to the current value (example: +34)

See also[]