Difference between revisions of "Template:Tool"
| Line 1: | Line 1: | ||
<noinclude>This template simplifies the creation of articles about software tools. When inserted in a page, it creates a decorative table with much helpful information. It also takes care of annotating the given data semantically, so that users can easily find it or query it in other articles. Do not try to read this page's source code for learning table syntax – there are far easier ways of creating tables in MediaWiki. | <noinclude>This template simplifies the creation of articles about software tools. When inserted in a page, it creates a decorative table with much helpful information. It also takes care of annotating the given data semantically, so that users can easily find it or query it in other articles. Do not try to read this page's source code for learning table syntax – there are far easier ways of creating tables in MediaWiki. | ||
| − | + | To use this template, insert the following at the beginning of your page. All fields are strictly '''optional''' and should be omitted if no data is given. Note that the licenses are described briefly in separate articles, and thus should be an [[:Category:License|existing license]] (of course new licenses can be added). | |
| − | |||
| − | To use this template, insert the following at the beginning of your | ||
<pre>{{Tool | <pre>{{Tool | ||
| Name = The full name of the tool, defaults to pagename | | Name = The full name of the tool, defaults to pagename | ||
| Line 9: | Line 7: | ||
| Type = one of API, Frontend, Backend or another subcategory of Category:Tool, add additional ones via category links | | Type = one of API, Frontend, Backend or another subcategory of Category:Tool, add additional ones via category links | ||
| Homepage = URL of the tool's main home page, without "http://"| | | Homepage = URL of the tool's main home page, without "http://"| | ||
| − | |||
| Affiliation = Some organisation maintaining this tool, if applicable | | Affiliation = Some organisation maintaining this tool, if applicable | ||
| Maintainer = Some person maintaining this tool, if applicable | | Maintainer = Some person maintaining this tool, if applicable | ||
| Line 30: | Line 27: | ||
|- | |- | ||
{{#ifeq:{{{Logo|}}}|||{{Tablelongrow|Align=Center|Value=[[Image:{{{Logo}}}|frameless|Logo of {{{Name|{{PAGENAME}}}}}]] }}}} | {{#ifeq:{{{Logo|}}}|||{{Tablelongrow|Align=Center|Value=[[Image:{{{Logo}}}|frameless|Logo of {{{Name|{{PAGENAME}}}}}]] }}}} | ||
| + | |- | ||
| + | {{Tablerow|Label=[[:Category:Science|Field]]:|Value=[[Category:{{{Field|Science}}}]]}} | ||
| + | |- | ||
| + | {{Tablerow|Label=[[:Category:Tool]]:|Value=[[Category:{{{Type|Tool}}}]]}} | ||
|- | |- | ||
{{#ifeq:{{{Homepage|}}}|||{{Tablesection|Label=[[homepage::http://{{{Homepage}}}|{{{Homepage label|{{{Homepage}}}}}}]]|Color=#F5CFE9}}}} | {{#ifeq:{{{Homepage|}}}|||{{Tablesection|Label=[[homepage::http://{{{Homepage}}}|{{{Homepage label|{{{Homepage}}}}}}]]|Color=#F5CFE9}}}} | ||
|- | |- | ||
{{Tablerow|Label=Status:|Value=[[Status::{{{Status|unknown}}}]]}} | {{Tablerow|Label=Status:|Value=[[Status::{{{Status|unknown}}}]]}} | ||
| + | |- | ||
| + | {{Tablerow|Label=[[Category:Programming language]]:|Value=[[Programming language::{{{Programming language|unknown}}}]]}} | ||
|- | |- | ||
{{#ifeq:{{{Version|}}}{{{Release|}}}|||{{Tablerow|Label=Last release: | {{#ifeq:{{{Version|}}}{{{Release|}}}|||{{Tablerow|Label=Last release: | ||
| Line 41: | Line 44: | ||
|- | |- | ||
{{#ifeq:{{{Affiliation|}}}|||{{Tablerow|Label=Affiliation:|Value=[[Affiliation::{{{Affiliation}}}]]}}}} | {{#ifeq:{{{Affiliation|}}}|||{{Tablerow|Label=Affiliation:|Value=[[Affiliation::{{{Affiliation}}}]]}}}} | ||
| + | |- | ||
| + | {{#ifeq:{{{Maintainer|}}}|||{{Tablerow|Label=Maintainer:|Value=[[Maintainer::{{{Maintainer}}}]]}}}} | ||
|- | |- | ||
<!-- *** On the web: *** --> | <!-- *** On the web: *** --> | ||
| Line 50: | Line 55: | ||
|- | |- | ||
{{#ifeq:{{{Documentation|}}}|||{{Tablelongrow|Align=Center|Value=[[documentation URL::{{{Documentation}}}|Documentation]]}}}} | {{#ifeq:{{{Documentation|}}}|||{{Tablelongrow|Align=Center|Value=[[documentation URL::{{{Documentation}}}|Documentation]]}}}} | ||
| + | |- | ||
| + | {{#ifeq:{{{Forum|}}}|||{{Tablelongrow|Align=Center|Value=[[forum URL::{{{Forum}}}|Forum]]}}}} | ||
|}</includeonly> | |}</includeonly> | ||
Revision as of 15:19, 13 August 2008
This template simplifies the creation of articles about software tools. When inserted in a page, it creates a decorative table with much helpful information. It also takes care of annotating the given data semantically, so that users can easily find it or query it in other articles. Do not try to read this page's source code for learning table syntax – there are far easier ways of creating tables in MediaWiki.
To use this template, insert the following at the beginning of your page. All fields are strictly optional and should be omitted if no data is given. Note that the licenses are described briefly in separate articles, and thus should be an existing license (of course new licenses can be added).
{{Tool
| Name = The full name of the tool, defaults to pagename
| Field = primary research field of the tool (must be a subcategory of Category:Science), add additional ones via category links
| Type = one of API, Frontend, Backend or another subcategory of Category:Tool, add additional ones via category links
| Homepage = URL of the tool's main home page, without "http://"|
| Affiliation = Some organisation maintaining this tool, if applicable
| Maintainer = Some person maintaining this tool, if applicable
| Version = current version number, may also be "ongoing" for very agile projects
| Release = date when the given version of the tool was released, omit if not applicable
| License = the license type of the tool, look into Category:License to find existing licenses
| Status = one of: pre-alpha, alpha, beta, stable, mature, discontinued (default is unknown)
| Programming language = the primary language the code is written in (see Category:Programming_language)
| Download = URL for downloading current version
| Sources = URL for viewing/downloading current source code
| Documentation = URL for online documentation/handbook
| Forum = URL of a forum mailinglist for support etc.
| Logo = the name of an uploaded logo, such as "WikiPipesLogo.png" (use "Upload file" in the toolbar on the left)
}}
The order of the fields is not relevant. The template should be given as the first thing on a page.
