Difference between revisions of "Template:Resource info"

From SNIC Documentation
Jump to: navigation, search
Line 1: Line 1:
 
<noinclude>
 
<noinclude>
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.
+
This template creates a standard info blurb for a resource, and registers the relevant categories and properties. 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>resource info|''description''=|''centre''=|''name''=<nowiki>{{PAGENAME}}}}</nowiki>
 
Usage: <nowiki>{{</nowiki>resource info|''description''=|''centre''=|''name''=<nowiki>{{PAGENAME}}}}</nowiki>
  
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 <nowiki>{{PAGENAME}}</nowiki> and should in principle never have to be set to anything else.
+
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). ''commissioning date'' and ''decommissioning date'' specify when the resource opened and started accepting jobs from users, and when it will close (optional). ''active'' states whether or not the project is currently considered to be active, and is used both to simplify queries and to handle corner cases in an explicit manner. ''name'' defaults to <nowiki>{{PAGENAME}}</nowiki> 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 <nowiki>"{{PAGENAME}} is a {{#show: {{PAGENAME}}|?description}}, and is located at {{#show: {{PAGENAME}}|?centre}}."</nowiki> to the page instead.
 
  
 
Example:
 
Example:
Line 12: Line 11:
 
<pre>
 
<pre>
 
{{resource info
 
{{resource info
|description=capability cluster resource of 250 Tflops with full bisection interconnect
+
|description=capability cluster resource of 60 Tflops with full bisection interconnect
 
|centre=NSC
 
|centre=NSC
|software=a comma separated list of pagenames for installed software
+
|production=yes
 +
|commissioning date=2007
 +
|decommissioning date=
 +
|software=Blast,HMMER,Gaussian
 
}}
 
}}
 
</pre>
 
</pre>
Line 20: Line 22:
 
</noinclude><includeonly>{{#ifeq: {{{quiet}}}|true|
 
</noinclude><includeonly>{{#ifeq: {{{quiet}}}|true|
 
{{#set: name={{{name|{{PAGENAME}}}}}|description={{{description}}}|centre={{{centre}}}}}{{#if: {{{description|}}}||<span style="font-weight: bold; color: red;">ERROR: No description.</span>}}{{#if: {{{centre|}}}||<span style="font-weight: bold; color: red;">ERROR: No centre.</span>}}|
 
{{#set: name={{{name|{{PAGENAME}}}}}|description={{{description}}}|centre={{{centre}}}}}{{#if: {{{description|}}}||<span style="font-weight: bold; color: red;">ERROR: No description.</span>}}{{#if: {{{centre|}}}||<span style="font-weight: bold; color: red;">ERROR: No centre.</span>}}|
[[name::{{{name|{{PAGENAME}}}}}]] is a [[description::{{{description|<span style="font-weight: bold; color: red;">ERROR</span>}}}]], and is located at [[centre::{{{centre|<span style="font-weight: bold; color: red;">ERROR</span>}}}]].}}{{set list|software|{{{software|}}}|sep=,|quiet=true}}
+
{{resource info table|name={{{name|{{PAGENAME}}}}}|description={{{description|}}}|centre={{{centre|}}}|production={{{production|}}}|commissioning date={{{commissioning date|}}}|decommissioning date={{{decommissioning date|}}}}}
 +
}}{{set list|software|{{{software|}}}|sep=,|quiet=true}}
 
[[Category:Resource]]</includeonly>
 
[[Category:Resource]]</includeonly>

Revision as of 07:49, 8 May 2012

This template creates a standard info blurb for a resource, and registers the relevant categories and properties. 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). commissioning date and decommissioning date specify when the resource opened and started accepting jobs from users, and when it will close (optional). active states whether or not the project is currently considered to be active, and is used both to simplify queries and to handle corner cases in an explicit manner. name defaults to {{PAGENAME}} and should in principle never have to be set to anything else.


Example:

{{resource info
|description=capability cluster resource of 60 Tflops with full bisection interconnect
|centre=NSC
|production=yes
|commissioning date=2007
|decommissioning date=
|software=Blast,HMMER,Gaussian
}}