Template:Resource info

From SNIC Documentation
Revision as of 18:58, 9 September 2011 by Joel Hedlund (NSC) (talk | contribs)
Jump to: navigation, search

This template and registers the relevant categories and properties for a resource. 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: {{resource info|description=|centre=|name={{PAGENAME}}}}

All the parameters are named, and can be given in any order. description should be a shortest-possible style description of what the resource is, eg. it should fit into the second formatter of "%s is a %s." (note absence of capital first letter, leading word "a", and ending full stop character). name defaults to {{PAGENAME}} and should in principle never have to be set to anything else.

The only readable output produced by this template is the string "name is a description, and is located at centre.", but even that can be suppressed by setting quiet=true. If you do, you may want to add something like "{{PAGENAME}} is a {{#show: {{PAGENAME}}|?description}}, and is located at {{#show: {{PAGENAME}}|?centre}}." to the page instead.


{{resource info
|description=a capability cluster resource of 250 Tflops with full bisection interconnect
|software=a comma separated list of pagenames for installed software