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

Template:Tool/doc

From Wikitech
Jump to navigation Jump to search

Tool is a template for documenting Toolforge tools.

Usage

Copy and paste:

{{Tool
|name         =
|title        =
|description  =
|website      =
|keywords     =
|author       =
|username     =
|maintainer   =
|repository   =
|license      =
|image        =
|imagesize    =
|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 prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Namename

Name of tool

Example
my-tool
Stringrequired
Titletitle

Title of tool

Example
My awesome tool
Stringsuggested
Descriptiondescription

Short description of tool

Example
Lookup things about stuff that really matters
Stringsuggested
URLwebsite

URL to tool's user interface or documentation

Example
[https://tools.wmflabs.org/my-tool my-tool]
URLsuggested
Keywordskeywords

Keywords related to tool

Example
lookup, patroller, bot
Stringsuggested
Author(s)author

Tool authors

Example
Some Author, Another Author
Stringsuggested
Usernameusername

Wikitech username of solo author

Example
SomeUser
Usersuggested
Maintainermaintainer

Tool maintainers

Stringoptional
Repositoryrepository

URL to version control for tool

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

OSI-approved license of tool's source code

Example
GPL-2.0+
Stringsuggested
Imageimage

Image representing tool or screenshot

Filesuggested
Image sizeimagesize

Image size in pixels

Default
220px
Stringoptional
Phabricatorphabricator

Phabricator project name

Example
Tool-Mytool
Stringoptional
Bugzillabugzilla

Bugzilla component

Example
Mytool
Stringdeprecated
Issue trackerissues

URL to issue tracker if not using Phabricator

URLoptional
Server Admin Logsal

Link to server admin log for tool

Example
[[Nova_Resource:Tools.stashbot/SAL]]
Contentoptional
Templatemodetemplatemode

Hack for displaying template on documentation page

Example
nocats
Stringoptional
Iconicon

Icon in the top left corner of the template.

Default
Crystal_Clear_app_package_utilities.png
Fileoptional