Difference between revisions of "Template:Software info"
(Created page with "<noinclude> This template registers the relevant categories and properties for a software. Will protest loudly in bold red if mandatory information is missing. If you do not wish...") |
|||
| Line 2: | Line 2: | ||
This template registers the relevant categories and properties for a software. Will protest loudly in bold red if mandatory information is missing. If you do not wish to provide a certain piece of required information: do not use this template. Or else you will corrupt the database with incorrect information. | This template registers the relevant categories and properties for a software. Will protest loudly in bold red if mandatory information is missing. If you do not wish to provide a certain piece of required information: do not use this template. Or else you will corrupt the database with incorrect information. | ||
| − | Usage: <nowiki>{{</nowiki>software info|''description''=|''license''=|'' | + | Usage: <nowiki>{{</nowiki>software info|''description''=|''license''=|''fields''=|''name''=<nowiki>{{PAGENAME}}}}</nowiki> |
All the parameters are named, and can be given in any order. ''description'' is required. Multiple ''fields'' can be specified using semicolon separated lists of names, optionally split over multiple lines. List ''fields'' in order of relevance (most relevant first) to ensure that sorting of dynamically generated tables will work as expected. See example below. | All the parameters are named, and can be given in any order. ''description'' is required. Multiple ''fields'' can be specified using semicolon separated lists of names, optionally split over multiple lines. List ''fields'' in order of relevance (most relevant first) to ensure that sorting of dynamically generated tables will work as expected. See example below. | ||
Revision as of 13:34, 9 September 2011
This template registers the relevant categories and properties for a software. Will protest loudly in bold red if mandatory information is missing. If you do not wish to provide a certain piece of required information: do not use this template. Or else you will corrupt the database with incorrect information.
Usage: {{software info|description=|license=|fields=|name={{PAGENAME}}}}
All the parameters are named, and can be given in any order. description is required. Multiple fields can be specified using semicolon separated lists of names, optionally split over multiple lines. List fields in order of relevance (most relevant first) to ensure that sorting of dynamically generated tables will work as expected. See example below.
license should be one of the allowed values (Free, Requires license, Site license), see description on Property:License.
name defaults to {{PAGENAME}}, and it should in principle never be necessary to set it to anything else.
Example (as used on the GROMACS page):
{{software info
|description=a versatile package for molecular dynamics
|license=free
|research areas=Molecular dynamics; Computational chemistry; Bioinformatics
}}
