View source for Template:NUMBEROF/doc

{{Documentation subpage}}
{{lua|Module:NUMBEROF}}
<!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE -->

'''NUMBEROF''' shows statistics for a language.project (eg. en.wikipedia, cs.wikiquote, commons.wikimedia, etc.).  Statistics update every 6 hours, except for your local wiki (enwiki) which are real-time.

Statistics are available for:
* Total Articles (main-space pages)
* Total Pages (articles + redirects + talk etc)
* Total Users (ever registered)
* Total Active Users (recently active)
* Total Edits
* Total Files (images)
* Total Admins
* Total for any of the above across all Wikipedia languages

=== Usage ===
There are 2 required parameters, and an optional third:
* '''First parameter:''' <code><nowiki>articles</nowiki></code>, <code><nowiki>pages</nowiki></code>, <code><nowiki>edits</nowiki></code>, <code><nowiki>users</nowiki></code>, <code><nowiki>activeusers</nowiki></code>, <code><nowiki>admins</nowiki></code> or <code><nowiki>files</nowiki></code>
* '''Second parameter (lang.project):''' <code><nowiki>en.wikipedia</nowiki></code>, <code><nowiki>en.wikiquote</nowiki></code>, <code><nowiki>commons.wikimedia</nowiki></code>, etc.. if there is no ".<project_name>" it defaults to <code><nowiki>.wikipedia</nowiki></code> thus <code><nowiki>en</nowiki></code> or <code><nowiki>uk</nowiki></code> are acceptable shortcuts
* Third parameter: If not empty (such as 'N') it will add a comma. For example "1000" becomes "1,000". For Wikis that use non-Latin digits, 'N' will also display numbers in the native script.

==== Examples ====

To show the number of articles of the [[French Wikipedia]] in format ''raw'':
* <code><nowiki>{{NUMBEROF|articles|fr}}</nowiki></code> → {{NUMBEROF|articles|fr}}
To show the number of pages on Commons with comma:
* <code><nowiki>{{NUMBEROF|pages|commons.wikimedia|N}}</nowiki></code> → {{NUMBEROF|pages|commons.wikimedia|N}}

=== Totals ===
Totals for first parameter stats (<code><nowiki>articles</nowiki></code>, <code><nowiki>pages</nowiki></code>, <code><nowiki>edits</nowiki></code>, <code><nowiki>users</nowiki></code>, <code><nowiki>activeusers</nowiki></code>, <code><nowiki>admins</nowiki></code> or <code><nowiki>files</nowiki></code>) are available in three types: <code><nowiki>totalactive</nowiki></code>, <code><nowiki>totalclosed</nowiki></code> and <code><nowiki>total</nowiki></code> (ie. totalactive + totalclosed). "Active" or "closed" indicate the status of the Wikipedia, as some wikis are no longer active, but old stats are still available.

To show the total of all active sites, on wikipedia, for pages:
* <code><nowiki>{{NUMBEROF|pages|totalactive.wikipedia|N}}</nowiki></code> → {{NUMBEROF|pages|totalactive.wikipedia|N}}

There is also a special <code><nowiki>total.all</nowiki></code> which is all projects (eg. wikipedia, wikiquote) that are active or closed. 

* <code><nowiki>{{NUMBEROF|pages|total.all|N}}</nowiki></code> → {{NUMBEROF|pages|total.all|N}}

=== Meta statistics ===
Information about the number of Wiki sites is available. Three types of stats: <code><nowiki>active</nowiki></code>, <code><nowiki>closed</nowiki></code> and <code><nowiki>languages</nowiki></code> (ie. active + closed). 

*<code><nowiki>{{NUMBEROF|languages|wikipedia}}</nowiki></code> → {{NUMBEROF|languages|wikipedia}}
*<code><nowiki>{{NUMBEROF|active|wikiquote}}</nowiki></code> → {{NUMBEROF|active|wikiquote}}
*<code><nowiki>{{NUMBEROF|closed|wikiquote}}</nowiki></code> → {{NUMBEROF|closed|wikiquote}} 

This allows for creating dynamic sentences for example: <code><nowiki>As of {{CURRENTMONTHNAME}} {{CURRENTYEAR}} there are {{NUMBEROF|languages|wikipedia}} Wikipedia sites of which {{NUMBEROF|active|wikipedia}} are active and {{NUMBEROF|closed|wikipedia}} are closed.</nowiki></code> which produces: "As of {{CURRENTMONTHNAME}} {{CURRENTYEAR}} there are {{NUMBEROF|languages|wikipedia}} Wikipedia sites of which {{NUMBEROF|active|wikipedia}} are active and {{NUMBEROF|closed|wikipedia}} are closed."

=== Rankings ===
Site rankings are available. See {{tlx|Wikipedia rank by size}}

=== Depth ===
Depth is available. Example:
* <code><nowiki>{{NUMBEROF|depth|fr}}</nowiki></code> → {{NUMBEROF|depth|fr}}
See [[:meta:Wikipedia article depth]] for the meaning of depth.

=== How it works ===

* The statistics are retrieved by [[Module:NUMBEROF]] from [[:Commons:Data:Wikipedia_statistics/data.tab]] and [[:Commons:Data:Wikipedia_statistics/meta.tab]]
* The rankings are retrieved from [[:Commons:Data:Wikipedia_statistics/rank/wikipedia.tab]] and [[:Commons:Data:Wikipedia_statistics/rank/wikibooks.tab|wikibooks.tab]] etc.. one for each of 8 sister projects.
* The bot [https://github.com/greencardamom/Numberof/tree/master Numberof] runs 4x daily updating data.tab and the ranking tabs based on a site list generated by [https://www.mediawiki.org/wiki/Extension:SiteMatrix API:SiteMatrix] and statistics from [https://www.mediawiki.org/wiki/API:Siteinfo API:Siteinfo]
* The bot runs on Toolforge from <code><nowiki>/data/project/botwikiawk/numberof</nowiki></code> by [[en:User:GreenC]]

=== How to install on other wikis ===
Copy and paste these pages:
* Template:NUMBEROF
* [[Module:NUMBEROF]]
* [[Module:NUMBEROF/data]]

This is all that is required for basic installation.

Optionally copy-paste the full package which includes documentation, a rank template and meta statistics. 

* [[Template:NUMBEROF/doc]] .. optionally use shorter [[Template:NUMBEROF/basicdoc]] renamed as "/doc"
* [[Module:NUMBEROF/doc]] 
* [[Module:NUMBEROF/rank]] .. for rankings
* [[Module:NUMBEROF/other]] .. for rankings
* [[Module:NUMBEROF/meta]] .. for meta statistics
* {{tl|Wikipedia rank by size}} .. optionally translate template name
* {{tl|Wikipedia rank by size/WP}} .. variation on the template
* {{tl|Wikipedia rank by size/doc}}

Edit 'languages link' (left column) for:

* Template:NUMBEROF
* [[Module:NUMBEROF]]
* [[Template:Wikipedia rank by size]] (if installed)

Link to the enwiki version. This allows for easier upgrades later.

=== See also ===
* {{tlx|Wikipedia rank by size}}
* [https://github.com/greencardamom/Numberof Numberof] bot at GitHub

<includeonly>{{Sandbox other||
<!-- CATEGORIES BELOW THIS LINE, PLEASE: -->
[[Category:Wikipedia variable-like templates]]
}}</includeonly>