Difference between revisions of "Help:Software example page"

From SNIC Documentation
Jump to: navigation, search
Line 34: Line 34:
 
|quiet=true
 
|quiet=true
 
}}
 
}}
{{PAGENAME}} (abbreviation explained) is {{#show: {{PAGENAME}} |?description}}, which is motivated by this dependent clause.
+
[http://example.com {{PAGENAME}}] (abbreviation explained) is {{#show: {{PAGENAME}} |?description}}, which is motivated by this dependent clause.
  
 
== Experts ==
 
== Experts ==

Revision as of 08:38, 6 July 2011

Minimal software page. Copy and edit to suit your needs. Page name should be same as software name. See Template:software info for details.

It may be a good idea to keep the |resources= field grouped by centre on a line basis, otherwise it may quickly grow beyond all manageability. Note that the actual order of resources will not matter much anyway since they will always be presented in tables sortable by name and centre.

Note that the lists of experts and available installations operate on information provided in the {{software information}} template on the same page, so any changes will probably not show up until the page has been refreshed once (browser side refresh should suffice).

Remember to create the Talk: page (example here).

{{software info
|description=what to put in the second arg to the complete sentence sprintf("%s is %s.", ...), and note that it has neither capital first char nor terminal full stop character.
|research areas=comma separated list of names (newlines are ignored)
|resources=comma separated list of names (newlines are ignored)
}}

== Experts ==
{{list experts}}

== Availability ==
{{list resources for software}}

== Links ==
* [http://example.com Official website]
* [http://example.com Manual]

Example with more fine tuned output:

{{software info
|description=a commercial ecclesiasticities package.
|research areas=simialogy
|resources=kappa, matter
|quiet=true
}}
[http://example.com {{PAGENAME}}] (abbreviation explained) is {{#show: {{PAGENAME}} |?description}}, which is motivated by this dependent clause.

== Experts ==
{{list experts}}

== Availability ==
{{list resources for software}}

== Links ==
* [http://pingu.com Official website]
* [http://pingu.com Manual]