Template:Tool/doc

Toolforge tools
{{{title}}}
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}}}

This is a documentation subpage for Template:Tool.
It contains usage information, categories and other content that is not part of the original template page.

Uses Lua:

Module: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        =
|imagesize    =
|phabricator  =
|bugzilla     =
|issues       =
|sal          =
|icon         =
}}

For help with parameter values, see below. For recognized license-values see Module:Tool.

Template parameters

Describes a Toolforge tool (or a tool hosted elsewhere)

Template parameters
This template prefers block formatting of parameters.
Parameter		Description	Type	Status
Name	`name`	Name of tool Example my-tool	String	required
Title	`title`	Title of tool Example My awesome tool	String	suggested
Description	`description`	Short description of tool Example Lookup things about stuff that really matters	String	suggested
URL	`website`	URL to tool's user interface or documentation Example [https://tools.wmflabs.org/my-tool my-tool]	URL	suggested
Keywords	`keywords`	Keywords related to tool Example lookup, patroller, bot	String	suggested
Author(s)	`author`	Tool authors Example Some Author, Another Author	String	suggested
Username	`username`	Wikitech username of solo author Example SomeUser	User	suggested
Maintainer	`maintainer`	Tool maintainers	String	optional
Repository	`repository`	URL to version control for tool Example https://gerrit.wikimedia.org/r/#/admin/projects/labs/tools/grrrit	URL	suggested
License	`license`	OSI-approved license of tool's source code - see [[Module:Tool]] Example GPL-2.0+	String	suggested
Image	`image`	Image representing tool or screenshot	File	suggested
Image size	`imagesize`	Image size in pixels Default 220px	String	optional
Phabricator	`phabricator`	Phabricator project name Example Tool-Mytool	String	optional
Bugzilla	`bugzilla`	Bugzilla component Example Mytool	String	deprecated
Issue tracker	`issues`	URL to issue tracker if not using Phabricator	URL	optional
Server Admin Log	`sal`	Link to server admin log for tool Example [[Nova_Resource:Tools.stashbot/SAL]]	Content	optional
templatemode	`templatemode`	Hack for displaying template on documentation page Example nocats	String	optional
Icon	`icon`	Icon in the top left corner of the template. Default Crystal_Clear_app_package_utilities.png	File	optional