View source for Template:Tool

<noinclude>
<languages/>
</noinclude><!--
--><templatestyles src="Template:Infobox/styles.css" /><!--
--><templatestyles src="Template:Skin/styles.css" /><!--
--><templatestyles src="Template:Extension/status.css" /><!--
--><includeonly><!--
-->{{#if: {{{phabricator|}}} | {{Ptag|{{{phabricator}}}}} }}
<table class="infobox infobox-{{dir|{{pagelang}}}} skin-infobox ext-status-{{#switch: {{lc: {{{status|unknown}}} }}
|unmaintained|unstable|experimental|beta|stable|magic={{{status}}}
|#default=unknown
}}">
<caption>'''{{ll|Manual:Tools|2=<translate><!--T:1--> Manual on MediaWiki Tools</translate>}}'''</caption>
<tr class="infobox-header ext-infobox-header">
<th colspan="2" style="padding-top: 0.5em;">[[File:{{#ifeq: {{lc: {{{status|}}} }} |unstable
|OOjs UI icon alert-invert.svg
|<!--else-->OOjs UI icon advanced{{#ifeq:{{{status}}}|beta||-invert}}.svg
}}|{{dir|{{pagelang}}|right|left}}|40px]] <span style="font-size: 130%;">{{{name|{{PAGENAME}}}}}</span><br />
{{ll|Tool status|2=<translate><!--T:2--> Release status:</translate>}} {{#switch: {{lc: {{{status|unknown}}} }}
|unmaintained=<translate><!--T:3--> unmaintained</translate>
|unstable=<translate><!--T:4--> unstable</translate>
|experimental=<translate><!--T:5--> experimental</translate>
|beta=<translate><!--T:6--> beta</translate>
|stable=<translate><!--T:7--> stable</translate>
|#default=<translate><!--T:9--> unknown</translate>
}}<!--
-->{{#ifeq:{{{templatemode|}}}|nocats|<!-- do nothing -->|<!--else-->[[Category:{{#switch: {{lc:{{{status|}}} }}
|unstable|experimental|unmaintained|stable = {{{status}}} tools
|beta = Beta status tools
|unknown = Tools with unknown status
|#default = Tools with invalid status
}}{{#translation:}}]]}}</th>
</tr>
{{#if:{{{image|}}}|
<tr>
<td colspan="2" style="text-align: center;">[[Image:{{{image}}}|{{{imagesize|220}}}px]]{{#if:{{{image description|}}}|<br />''{{{image description}}}''}}</td>
</tr>
}}
{{#if:{{{type|}}}{{{type1|}}}|
<tr>
<td style="vertical-align:top; min-width:7em">'''{{ll|Template:Tool#type|2=<translate><!--T:10--> Implementation</translate>}}'''</td>
<td>{{#ifeq:{{{templatemode|}}}|nocats|<!--
      -->{{Foreach| {{TNTN|Template:Tool/TypeSwitchNoCats}} |<!-- -->delim=,&ensp;|<!--
         -->{{{type1|{{{type|missing}}}<!-- -->}}}|<!--
         -->{{{type2|}}}|<!-- -->{{{type3|}}}|<!-- -->{{{type4|}}}|<!-- -->{{{type5|}}}|<!-- -->{{{type6|}}}<!--
      -->}}<!--
   -->|<!--else--><!--S
      -->{{Foreach| {{TNTN|Template:Tool/TypeSwitch}} |<!-- -->delim=,&ensp;|<!--
         -->{{{type1|{{{type|missing}}}<!-- -->}}}|<!--
         -->{{{type2|}}}|<!-- -->{{{type3|}}}|<!-- -->{{{type4|}}}|<!-- -->{{{type5|}}}|<!-- -->{{{type6|}}}<!--
      -->}}<!--
   -->}}<!--
-->|<!--else--><!--
   -->{{#ifeq:{{{templatemode|}}}|nocats|<!--
      nothing
   -->|<!--else--><!--
      -->{{Tool/TypeSwitch|_missing_}}<!--
   -->}}<!--
--></td>
</tr>
}}
{{#if:{{{description|}}}|
<tr>
<td style="vertical-align: top">'''{{ll|Template:Tool#description|2=<translate><!--T:11--> Description</translate>}}'''</td>
<td>{{{description}}}</td>
</tr>
}}
{{#if:{{{author|}}}{{{username|}}} |
<tr>
<td style="vertical-align: top">'''{{ll|Template:Tool#username|2=<translate><!--T:12--> Author(s)</translate>}}'''</td>
<td>{{#if: {{{username|}}} |<!--
      -->{{#ifeq: {{{username}}}|{{{author|{{{username}}}<!-- -->}}}|<!--
         nothing
      -->|<!--else--><!--
         -->{{{author}}} (<!--
      -->}}<!--
      -->[[User:{{{username}}}|{{{username}}}]]<!--
      --><sup><small>[[User talk:{{{username}}}|{{int:talkpagelinktext}}]]</small></sup><!--
      -->{{#ifeq: {{{username}}}|{{{author|{{{username}}}<!-- -->}}}|<!--
         nothing
      -->|<!--else--><!--
         -->)<!--
      -->}}<!--
   -->|<!--else--><!--
      -->{{{author}}}<!--
   -->}}</td>
</tr>
}}
{{#if:{{{latest release version|{{{latest_release_version|{{{version|}}}}}}}}}|
<tr>
<td style="vertical-align: top">'''{{ll|Template:Tool#version|2=<translate><!--T:13--> Latest version</translate>}}'''</td>
<td>{{{latest release version|{{{latest_release_version|{{{version|}}}}}}}}}{{#if:{{{latest release date|{{{latest_release_date|{{{update|}}}}}}}}}|&#160;({{{latest release date|{{{latest_release_date|{{{update}}})}}}}}}}}</td>
</tr>
}}
{{#if:{{{latest preview version|{{{latest_preview_version|{{{version_preview|{{{version preview|}}}}}}}}}}}}|
<tr>
<td style="vertical-align: top">'''{{ll|Template:Tool#version|2=<translate><!--T:14--> Latest preview version</translate>}}'''</td>
<td>{{{latest preview version|{{{latest_preview_version|{{{version_preview|{{{version preview|}}}}}}}}}}}}{{#if:{{{latest preview date|{{{latest_preview_date|{{{update_preview|{{{update preview|}}}}}}}}}}}}|&#160;({{{latest preview date|{{{latest_preview_date|{{{update_preview|{{{update preview}}}}}}}}}}}})}}</td>
</tr>
}}
{{#if:{{{mediawiki|}}}|
<tr>
<td style="vertical-align: top">{{ll|Template:Tool#mediawiki|'''MediaWiki'''}}</td>
<td>{{{mediawiki}}}</td>
</tr>
}}
{{#if:{{{php|}}}|
<tr>
<td style="vertical-align: top">{{ll|Template:Tool#php|'''PHP'''}}</td>
<td>{{{php}}}</td>
</tr>
}}
<tr>
<td style="vertical-align: top">'''{{ll|Template:Tool#license|2=<translate><!--T:15--> License</translate>}}'''</td>
<td>{{#if:{{{license|}}}|{{{license}}}|<translate><!--T:16--> No license specified</translate>{{#if:{{{nocats|}}}||{{#ifeq:{{{templatemode|}}}|nocats||[[Category:Tools with no license specified{{#translation:}}]]}}}}}}</td>
</tr>
<tr>
<td style="vertical-align: top">'''{{ll|Template:Tool#download|2=<translate><!--T:17--> Download</translate>}}'''</td>
<td><!--
-->{{#if:{{{download|}}}|{{{download}}}|''<translate><!--T:18--> No link</translate>''}}<!--
-->{{#if:{{{readme|}}}|<br />{{{readme}}}<!-- -->}}<!--
-->{{#if:{{{changelog|}}}|<br />{{{changelog}}}<!-- -->}}</td>
</tr>
{{#if:{{{example|}}}|
<tr>
<td style="vertical-align: top">'''{{ll|Template:Tool#example|2=<translate><!--T:19--> Example</translate>}}'''</td>
<td>{{{example}}}</td>
</tr>
}}
{{#if:{{{parameters|}}}|
<tr>
<td style="padding: 0pt;" colspan="2"><!--
   -->
<table class="mw-collapsible mw-collapsed" style="border-collapse: collapse; width: 100%;">
<tr>
<th style="vertical-align: top; text-align:{{dir|{{pagelang}}|right|left}}; padding: 0.2em 0.5em;">'''{{ll|Template:Tool#parameters|2=<translate><!--T:20--> Parameters</translate>}}'''</th>
</tr><tr>
<td>{{{parameters}}}</td>
</tr>
</table></td>
</tr>
}}
{{#if:{{{tags|}}}|
<tr>
<td style="padding: 0pt;" colspan="2">
<table class="mw-collapsible mw-collapsed" style="border-collapse: collapse; width: 100%;">
<tr>
<th style="vertical-align: top; text-align:{{dir|{{pagelang}}|right|left}}; padding: 0.2em 0.5em;">'''{{ll|Template:Tool#tags|2=<translate><!--T:21--> Tags</translate>}}'''</th>
</tr><tr>
<td>{{{tags}}}</td>
</tr>
</table></td>
</tr>
}}
{{#if:{{{compatibility|}}}|
<tr>
<td colspan="2">
{{{compatibility}}}</td>
</tr>
}}
<tr>
<td colspan="2" style="text-align:center;"><!--
Note: this next check suppresses the 'Check usage' link if page is: a subpage, not in Extension: namespace, or if suppressed by 'templatemode=nocats' or 'nousage=true'.
-->{{#if:{{{nousage|{{#ifeq:{{{templatemode|}}}|nocats
                      |no usage
                      |{{#ifeq:{{NAMESPACE}}|{{ns:102}}
                         |
                         |no usage
                       }}
                      {{#ifeq:{{{templatemode|}}}|nousage
                         |no usage
                       }}
                    }}}}}
     |<!-- no usage -->|
Check [[wikiapiary:Tool:{{{CheckUsageNameOverride|{{BASEPAGENAMEE}}}}}|<translate><!--T:22--> usage and version matrix</translate>]];<!--
-->}}</td>
</tr>
{{#if: {{{phabricator|{{{bugzilla|}}}}}} |
<tr>
<td style="vertical-align: top">
'''{{ll|Phabricator|2=<translate><!--T:25--> Issues</translate>}}:'''</td>
<td>[[phab:tag/{{{phabricator|{{{bugzilla}}}}}}|<translate><!--T:23--> Open tasks</translate>]] · [https://phabricator.wikimedia.org/maniphest/task/create/?projects={{{phabricator|{{{bugzilla}}}}}} <translate><!--T:24--> Report a bug</translate>]</td>
</tr>
}}
</table><!--
-->{{#ifeq:{{{templatemode|}}}|nocats|<!--
   nothing--><!--
-->|<!--else--><!--
   -->{{DEFAULTSORT:{{#if:{{{name|}}}|<!--
      -->{{uc:{{{name}}}<!-- -->}}<!--
   -->|<!--else--><!--
      -->{{uc:{{PAGENAME}}<!-- -->}}<!--
   -->}}<!-- -->}}<!--
   -->[[Category:All tools{{#translation:}}]]<!--
-->}}<!--
--></includeonly><noinclude>
{{Documentation|content=
{{Uses TemplateStyles|Template:Infobox/styles.css|Template:Skin/styles.css|Template:Extension/status.css}}

{{anchor|Purpose}}
== Purpose ==

This template should be added to the main page of all tools documented on this wiki (and only the main page).  It will add a useful infobox using the information supplied (see below) and will automatically add the tool to {{ll|Category:All tools|All tools}}, plus the appropriate {{ll|Category:Tools by status|status}} and {{ll|Category:Tools by implementation type|implementation type}} categories.

{{anchor|Usage}}
== Usage ==

{{(}}{{!}} width="100%"
{{!}}-
! width=40% {{!}}
! width=60% {{!}}
{{!}}- valign="top"
{{!}} align="left" {{!}}
<span id="CutAndPaste">Copy and paste:</span>
<pre>{{Tool|templatemode =
|name            = 
|status          = 
|type1           = 
|type2           = 
|username        = 
|author          = 
|description     = 
|image           = 
|imagesize       = 
|version         = 
|update          = 
|version preview = 
|update preview  = 
|mediawiki       = 
|php             = 
|license         = 
|download        = 
|readme          = 
|changelog       = 
|example         = 
|parameters      = 
|tags            = 
|compatibility   = 
|bugzilla        = 
|phabricator =
}}</pre>

For help with parameter values, see [[#Content parameters|below]].

{{!}} align="right"{{!}}{{Tool|templatemode=nocats
|name            = {{{name}}}
|status          = {{{status}}}
|type1           = {{{type1}}}
|type2           = {{{type2}}}
|username        = SomeUser
|author          = SomeAuthor
|image           = Placeholder.svg
|version         = {{{version}}}
|update          = {{{update}}}
|version preview = {{{version preview}}}
|update preview  = {{{update preview}}}
|mediawiki       = {{{mediawiki}}}
|php             = {{{php}}}
|license         = {{{license}}}
|download        = {{{download}}}
|readme          = {{{readme}}}
|changelog       = {{{changelog}}}
|example         = {{{example}}}
|description     = {{{description}}}
|parameters      = {{{parameters}}}
|tags            = {{{tags}}}
|compatibility   = {{{compatibility}}}
|bugzilla        = {{{bugzilla}}}
|phabricator        = {{{phabricator}}}
|pagedrive1      = true
|demo            = true
}}
{{!}}{{)}}
{{-}}

== Content parameters ==
This section describes parameters that govern infobox content.  For help with '''templatemode''' and other control parameters, please see  ''[[#Control parameters|Control parameters]]''.

<!-- BEFORE YOU EDIT THIS:
     span ids on each parameter are used by the code in Template:Tool.
     They enable each label in the info box to link its documentation.
     If you change an id, please update the code in Template:Tool accordingly
-->  
{{(}}{{!}} class="wikitable"
{{!}}+ '''Content parameters'''
{{!}}-
! <translate><!--T:26--> Parameter</translate>
! <translate><!--T:27--> Description</translate>
{{!}}-
{{!}}<span id="name">'''name'''</span> {{!!}} '''name of the tool'''
{{!}}-
{{!}}<span id="status">'''status'''</span> {{!!}} '''current release status'''
One of: 
* ''{{ll|Category:Unstable tools|unstable}}'' (broken - do not use this tool)
* ''{{ll|Category:Experimental tools|experimental}}'' (early stages of development, may change drastically)
* ''{{ll|Category:Beta status tools|beta}}'' (stable but not fully tested)
* ''{{ll|Category:Stable tools|stable}}'' (stable version)
* ''{{ll|Category:Unmaintained tools|unmaintained}}'' (unmaintained - previously claimed to be stable, now unmaintained)
* ''{{ll|Category:Tools with unknown status|unknown}}'' (default)
If the status is anything other than the above, it will be ignored and the default value of 'Unknown' will be displayed in the template instead.  In cases where the value is omitted, it will be categorized as {{ll|Category:Tools with unknown status|unknown}}.  In cases where the value is invalid, it will be placed in a {{ll|category:Tools with invalid status|special category}} so that the error can be caught and fixed.
{{!}}-
{{!}} '''type1'''<br/>''type2''<br/>''type3''<br/>''type4''<br/>''type5''<br/>''type6''<br/> {{!!}} <span id="type">'''implementation type'''</span><!-- id here so at top of documentation -->

The  implementation strategy(s) employed in building this tools. This parameter is used to create categories that help programmers find examples of various MediaWiki specific implementation strategies or patterns.  Although the values of this parameter sometimes coincide with the use case or purpose of an tools, that is not reason for this parameter.  If the values you have chosen for this parameter do not adequately identify the [[w:Requirements|purpose]] or possible [[w:Use case|use case]]s, we recommend you add additional [[Help:Categories|category links]] as needed.


Legal values for the '''type1''','''type2''',... parameters are:
<!---
   To update, copy everything between "#switch: ..." and "}}" (on [[Template:Tool/TypeSwitch]])
   and run the following regex: .replace(/\|(.+)\=(.+)\[\[Cat(.+)]]/g, "*[[:Cat$3|'''''$1''''']] - $2")
-->
*{{ll|Category:Ajax tools|'''''ajax'''''}} - [[w:AJAX|Ajax]]
*{{ll|Category:API tools|'''''api'''''}} - [[API:Main page|API]] 
*{{ll|Category:Bots|'''''bot'''''}} - [[Bot]] 
*{{ll|Category:Database tools|'''''database'''''}} - [[Manual:Database layout|Database]]
*{{ll|Category:Database tools|'''''db'''''}} - Database
*{{ll|Category:Data extraction tools|'''''data extraction'''''}} - Data extraction
*{{ll|Category:Tool examples|'''''example'''''}} - Example
*{{ll|Category:Link markup tools|'''''link'''''}} - [[Manual:Extending wiki markup|Link markup]]
*{{ll|Category:Internationalization tools|'''''locale'''''}} - [[Manual:Localization|Locale]]
*{{ll|Category:Personalization tools|'''''mywiki'''''}} - [[Manual:Personalization|MyWiki]]
*{{ll|Category:Extensions by integration target|'''''plugin'''''}} - Plugin for third party software 
*{{ll|Category:Search tools|'''''search'''''}} - Search
*{{ll|Category:WordPress extensions|'''''wordpress'''''}} - [[w:WordPress|WordPress Plugins]]

Any other value for 'type' is invalid, and will cause the tool to be placed in [[:Category:Tools with invalid or missing type]].

Note: Many tools have more than one type, if this applies to yours,replace <code><nowiki>|type=</nowiki></code> with <code><nowiki>|type1=|type2=|type3=...</nowiki></code>.  You may define up to six types for a tool.
{{!}}-
{{!}} <span id="username">'''username'''</span> {{!!}} The author's username on MediaWiki.org (if they have one). May be omitted, but if present it will be used to link to the author's user & user_talk page.
{{!}}-
{{!}} <span id="author">author</span>{{!!}} The tool author's name, if different from their MediaWiki.org username. Free text. If omitted then the 'username' field will be used (if present).
{{!}}-
{{!}} <span id="description">'''description'''</span>{{!!}} '''short description'''
{{!}}-
{{!}} <span id="image">image</span>{{!!}} screenshot or logo of tool
{{!}}-
{{!}} <span id="imagesize">imagesize</span>{{!!}} ''facultative'', size of the image (default size is 220px)
{{!}}-
{{!}} <span id="version">version</span>{{!!}} last version
{{!}}-
{{!}} <span id="update">update</span>{{!!}} date of the last update
{{!}}-
{{!}} <span id="mediawiki">mediawiki</span>{{!!}} required version of MediaWiki
{{!}}-
{{!}} <span id="php">php</span>{{!!}} required version of PHP
{{!}}-
{{!}} <span id="license">license</span>{{!!}} license(s) governing use of this tool, e.g. GPL
{{!}}-
{{!}}  <span id="download">'''download'''</span>{{!!}} '''link to the download''' : [https://phabricator.wikimedia.org/r/project/mediawiki/core Git], {{tl|WikimediaDownload}} with server=svn in case it was not migrated from [http://svn.wikimedia.org/svnroot/mediawiki/trunk/tools/ SVN]. If you put the code into page in the MediaWiki wiki, link to it using a full page name and section name, e.g. <code> <nowiki>[[Tool:Example/version_1.22a#Code]]</nowiki> </code> (it must remain valid when bot-copied elsewhere)
{{!}}-
{{!}} <span id="readme">readme</span>{{!!}} link to the readme file : [https://phabricator.wikimedia.org/r/browse/mediawiki/extensions/Flow;master;README README] or other
{{!}}-
{{!}} <span id="changelog">changelog</span>{{!!}} link to the changelog file : [http://svn.wikimedia.org/svnroot/mediawiki/trunk/tools/Sort/Sort CHANGELOG] or other
{{!}}-
{{!}} <span id="parameters">parameters</span> {{!!}} available parameters for LocalSettings.php
{{!}}-
{{!}} <span id="tags">tags</span> {{!!}} any tags your tool uses (e.g. &lt;tag1&gt;, &lt;tag2&gt;).
{{!}}-
{{!}} rights{{!!}} <span id="rights">rights</span> added by the tool. '''Not to be confused with the license!''' Not such as GFDL or LGPL or GPL - those are licenses!
{{!}}-
{{!}} <span id="example">example</span> {{!!}} example, website or screenshot of working tool
{{!}}-
{{!}} <span id="compatibility">compatibility</span> {{!!}} compatibility chart, e.g. [[Template:Extension Testing]]
{{!}}-
{{!}} <span id="bugzilla">bugzilla</span> {{!!}} Bugzilla MediaWiki extension component name
{{!}}-
{{!}} <span id="CheckUsageNameOverride">CheckUsageNameOverride</span> {{!!}} override the page name used for the check usage link.
{{!}}{{)}}

<translate>
== Control parameters == <!--T:28-->
</translate>
{{(}}{{!}} class="wikitable"
{{!}}+ '''Control parameters'''
{{!}}-
! <translate><!--T:29--> Parameter</translate>
! <translate><!--T:30--> Description</translate>
{{!}}-
{{!}} '''templatemode''' {{!!}} '''Controls auto-categorization of host page.'''

Normally left blank.  Alternate values are:
* ''nocats'' - suppresses categorization. Use this value if you are adding this template to [[Help:Subpage|subpages]] of an tool or to how-to documentation of tools. For example, the usage image above sets <code>templatemode=nocats</code> because this isn't an actual tool page and we don't want to add this page to any categories on account of it.


If this is left blank, this template will add the host page to {{ll|Category:All tools|All tools}} and to one or more additional categories, depending on the values assigned to the [[#Content parameters|Content parameters]].
{{!}}{{)}}

== Using the infobox ==
=== Existing tools pages ===
If you want to add the infobox to an existing page, copy and paste the code at the [[#CutAndPaste|top of this page]].

=== Infobox parameters ===
In general:
* To make this template easy to use, each label in the infobox is linked to documentation on the template parameter(s) it displays.  If you add a parameter, please be sure to also add it to the [[#Content parameters|content parameter documentation]] and link its label to its documentation.

To change/correct/add to the implementation type parameters (<code>type1</code>, etc.):
* Discuss the change on the [[Template_talk:Tool|talk page]]
* '''[[Template:Tool/TypeSwitch]]:''' Stores the possible values for the type field.  Multiple values are implemented by calling this template with [[Template:Foreach]].
* '''[[Template:Tool/TypeSwitchNoCats]]:''' Used instead of [[Template:Tool/TypeSwitch]] when this template is used in <code>templatemode=nocats</code>.  Templates used with [[Template:Foreach]] can only take one parameter so we need to wrap the call to [[Template:Tool/TypeSwitch]] with another template that sets the mode.

== Test case ==
See if the following pages are still ok, after edited this template.
* [[PhotoCommons]]

}}
[[Category:Infobox templates{{#translation:}}|{{PAGENAME}}]]
[[Category:Tool creation{{#translation:}}|{{PAGENAME}}]]
[[Category:Categorizing templates{{#translation:}}|{{PAGENAME}}]]
</noinclude>