You are browsing a read-only backup copy of Wikitech. The primary site can be found at wikitech.wikimedia.org

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

Template:Tool/doc

From Wikitech-static
Jump to navigation Jump to search

Lua error in Module:TNT at line 159: Missing JsonConfig extension; Cannot load https://commons.wikimedia.org/wiki/Data:I18n/Lua banner.tab. 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.

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

<templatedata> { "params": { "name": { "label": "Name", "description": "Name of tool", "example": "my-tool", "type": "string", "required": true, "suggested": true }, "title": { "label": "Title", "description": "Title of tool", "example": "My awesome tool", "type": "string", "suggested": true }, "description": { "label": "Description", "description": "Short description of tool", "example": "Lookup things about stuff that really matters", "type": "string", "suggested": true }, "website": { "label": "URL", "description": "URL to tool's user interface or documentation", "example": "my-tool", "type": "url", "suggested": true }, "keywords": { "label": "Keywords", "description": "Keywords related to tool", "example": "lookup, patroller, bot", "type": "string", "suggested": true }, "repository": { "label": "Repository", "description": "URL to version control for tool", "example": "https://gerrit.wikimedia.org/r/#/admin/projects/labs/tools/grrrit", "type": "url", "suggested": true }, "license": { "label": "License", "description": "OSI-approved license of tool's source code - see Module:Tool", "example": "GPL-2.0+", "type": "string", "suggested": true }, "phabricator": { "label": "Phabricator", "description": "Phabricator project name", "example": "Tool-Mytool", "type": "string" }, "bugzilla": { "label": "Bugzilla", "description": "Bugzilla component", "example": "Mytool", "type": "string", "deprecated": "Use Phabricator instead" }, "issues": { "label": "Issue tracker", "description": "URL to issue tracker if not using Phabricator", "type": "url" }, "author": { "label": "Author(s)", "description": "Tool authors", "example": "Some Author, Another Author", "type": "string", "suggested": true }, "username": { "label": "Username", "description": "Wikitech username of solo author", "example": "SomeUser", "type": "wiki-user-name", "suggested": true }, "templatemode": { "type": "string", "description": "Hack for displaying template on documentation page", "example": "nocats" }, "image": { "label": "Image", "description": "Image representing tool or screenshot", "type": "wiki-file-name", "suggested": true }, "imagesize": { "label": "Image size", "description": "Image size in pixels", "type": "string", "default": "220px" }, "maintainer": { "label": "Maintainer", "description": "Tool maintainers", "type": "string" }, "sal": { "label": "Server Admin Log", "description": "Link to server admin log for tool", "example": "Nova_Resource:Tools.stashbot/SAL", "type": "content" }, "icon": { "label": "Icon", "description": "Icon in the top left corner of the template.", "type": "wiki-file-name", "default": "Crystal_Clear_app_package_utilities.png" } }, "paramOrder": [ "name", "title", "description", "website", "keywords", "author", "username", "maintainer", "repository", "license", "image",

               "imagesize",

"phabricator", "bugzilla", "issues", "sal", "templatemode", "icon" ], "format": "block", "description": "Describes a Toolforge tool (or a tool hosted elsewhere)" } </templatedata>