Phabricator project: [[phab:tag/{{{phabricator}}}/|#{{{phabricator}}}]]

Template:Tool/doc

From Wikitech
Jump to: navigation, search
This documentation subpage contains instructions, categories, or other information that is not part of the template. To view the Template page itself, see Template:Tool.

Tool is a template for documenting Toolforge tools.

Usage

Copy and paste:

{{Tool
|name         =
|title        =
|description  =
|website      =
|keywords     =
|author       =
|username     =
|maintainer   =
|repository   =
|license      =
|image        =
|phabricator  =
|bugzilla     =
|issues       =
|sal          =
|icon         =
}}

For help with parameter values, see below.

Toolforge tools
Crystal Clear app package utilities.png {{{title}}}
Placeholder.png
Website {{{website}}}
Description {{{description}}}
Keywords {{{keywords}}}
Author(s) SomeAuthor (SomeUsertalk)
Maintainer(s) SomeMaintainer ([[toolforge:admin/tool/{{{name}}}|View all]])
Source code {{{repository}}}
License {{{license}}}
Issues [[phab:tag/{{{phabricator}}}|Open tasks]] · Report a bug
Admin log {{{sal}}}


Template parameters

Describes a Toolforge tool (or a tool hosted elsewhere)

Template parameters

This template has custom formatting.

ParameterDescriptionTypeStatus
Namename

Name of tool

Default
empty
Example
my-tool
Auto value
empty
Stringrequired
Titletitle

Title of tool

Default
empty
Example
My awesome tool
Auto value
empty
Stringsuggested
Descriptiondescription

Short description of tool

Default
empty
Example
Lookup things about stuff that really matters
Auto value
empty
Stringsuggested
URLwebsite

URL to tool's user interface or documentation

Default
empty
Example
[https://tools.wmflabs.org/my-tool my-tool]
Auto value
empty
URLsuggested
Keywordskeywords

Keywords related to tool

Default
empty
Example
lookup, patroller, bot
Auto value
empty
Stringsuggested
Author(s)author

Tool authors

Default
empty
Example
Some Author, Another Author
Auto value
empty
Stringsuggested
Usernameusername

Wikitech username of solo author

Default
empty
Example
SomeUser
Auto value
empty
Usersuggested
Maintainermaintainer

Tool maintainers

Default
empty
Example
empty
Auto value
empty
Stringoptional
Repositoryrepository

URL to version control for tool

Default
empty
Example
https://gerrit.wikimedia.org/r/#/admin/projects/labs/tools/grrrit
Auto value
empty
URLsuggested
Licenselicense

OSI-approved license of tool's source code

Default
empty
Example
GPL-2.0+
Auto value
empty
Stringsuggested
Imageimage

Image representing tool or screenshot

Default
empty
Example
empty
Auto value
empty
Filesuggested
Phabricatorphabricator

Phabricator project name

Default
empty
Example
Tool-Mytool
Auto value
empty
Stringoptional
Bugzillabugzilla

Bugzilla component

Default
empty
Example
Mytool
Auto value
empty
Stringdeprecated
Issue trackerissues

URL to issue tracker if not using Phabricator

Default
empty
Example
empty
Auto value
empty
URLoptional
Server Admin Logsal

Link to server admin log for tool

Default
empty
Example
[[Nova_Resource:Tools.stashbot/SAL]]
Auto value
empty
Contentoptional
Templatemodetemplatemode

Hack for displaying template on documentation page

Default
empty
Example
nocats
Auto value
empty
Stringoptional
Iconicon

Icon in the top left corner of the template.

Default
Crystal_Clear_app_package_utilities.png
Example
empty
Auto value
empty
Fileoptional