View source for Template:Tool/doc

<noinclude>{{Documentation subpage}}</noinclude>
{{lua|Module:Tool}}
'''Tool''' is a template for documenting [[Portal:Tool Labs|Tool Labs]] tools.
{{Clear}}
== Usage == 
{| width="100%"
|-
! width=40% |
! width=60% |
|- valign="top"
| align="left" |
<span id="CutAndPaste">Copy and paste:</span>
<pre>{{Tool
|templatemode =
|name         =
|title        =
|description  =
|website      =
|keywords     =
|author       =
|username     =
|maintainer   =
|repository   =
|license      =
|image        =
|phabricator  =
|bugzilla     =
|issues       =
}}
</pre>

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

| align="right"|{{Tool
|templatemode = nocats
|name         = {{{name}}}
|title        = {{{title}}}
|description  = {{{description}}}
|website      = {{{website}}}
|keywords     = {{{keywords}}}
|author       = SomeAuthor
|username     = SomeUser
|maintainer   = SomeMaintainer
|repository   = {{{repository}}}
|license      = {{{license}}}
|image        = Placeholder.png
|phabricator  = {{{phabricator}}}
|bugzilla     = {{{bugzilla}}}
|issues       = {{{issues}}}
}}
|}
<br style="clear:both"/>

== 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": "[https://tools.wmflabs.org/my-tool 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",
			"example": "GPL-2.0+",
			"type": "string",
			"suggested": true
		},
		"phabricator": {
			"label": "Phabricator",
			"description": "Phabricator project name",
			"example": "Tool-Labs-Tool-Mytool",
			"type": "string"
		},
		"bugzilla": {
			"label": "Bugzilla",
			"description": "Bugzilla component",
			"example": "Mytool",
			"type": "string",
			"deprecated": "Use Phabricator instead"
		},
		"issues": {
			"label": "Issure 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
		},
		"maintainer": {
			"label": "Maintainer",
			"description": "Tool maintainers",
			"type": "string"
		}
	},
	"paramOrder": [
		"name",
		"title",
		"description",
		"website",
		"keywords",
		"author",
		"username",
		"maintainer",
		"repository",
		"license",
		"image",
		"phabricator",
		"bugzilla",
		"issues",
		"templatemode"
	],
	"format": "block",
	"description": "Describes a Tool Labs tool (or a tool hosted elsewhere)"
}
</templatedata>