Difference between revisions of "Help:Software example page"

From SNIC Documentation
Jump to: navigation, search
 
(22 intermediate revisions by the same user not shown)
Line 1: Line 1:
[[Category:Page example]]
+
[[Category:example page|{{PAGENAME}}]]
 
Minimal software page. Copy and edit to suit your needs. Page name should be same as software name. See [[Template:software info]] for details.
 
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 operates on information provided in the <nowiki>{{software information}}</nowiki> 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).
  
Note that the lists of experts and available installations operate on information provided in the <nowiki>{{software information}}</nowiki> 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 ([[Help:Talk example page|example here]]).
  
 +
Also note that the information on available installations of the software is set on the individual [[Property:Resource|resource pages]].
 +
 +
Example with fine tuned output:
 
<pre>
 
<pre>
 
{{software info
 
{{software info
|description=what to put in the second arg of sprintf("%s is a %s.", ...), note that there is neither capital first char nor terminal '.' in %s.
+
|description=what to put in the second arg to the complete sentence sprintf("%s is a %s.", ...), and note that it has neither capital first char nor terminal full stop char
|research areas=comma separated list of names (newlines are ignored)
+
|license=free
|resources=comma separated list of names (newlines are ignored)
+
|fields=semicolon separated list of field category names (newlines are ignored)
 
}}
 
}}
 +
[http://example.com {{PAGENAME}}] (abbreviation explained) is a software package for {{#show: {{PAGENAME}} |?description}}, which is motivated by this dependent clause.
 +
 +
== Availability ==
 +
{{list resources for software}}
 +
 +
== Tips and tricks ==
 +
Describe general tips and tricks for using the software here, eg. compilation trickery, general workflow design to get better performance...
 +
 +
== License ==
 +
{{show license}}
 +
 +
Any further license particularities (such as site licenses) are succinctly described here.
  
 
== Experts ==
 
== Experts ==
 
{{list experts}}
 
{{list experts}}
  
== Availability ==
+
== Links ==
{{list resources for software}}
+
* [http://pingu.com Official website]
 +
* [http://pingu.com Publication]
 +
* [http://pingu.com Manual]
 +
 
 
</pre>
 
</pre>

Latest revision as of 14:58, 29 September 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.

Note that the lists of experts operates 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).

Also note that the information on available installations of the software is set on the individual resource pages.

Example with fine tuned output:

{{software info
|description=what to put in the second arg to the complete sentence sprintf("%s is a %s.", ...), and note that it has neither capital first char nor terminal full stop char
|license=free
|fields=semicolon separated list of field category names (newlines are ignored)
}}
[http://example.com {{PAGENAME}}] (abbreviation explained) is a software package for {{#show: {{PAGENAME}} |?description}}, which is motivated by this dependent clause.

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

== Tips and tricks ==
Describe general tips and tricks for using the software here, eg. compilation trickery, general workflow design to get better performance... 

== License ==
{{show license}}

Any further license particularities (such as site licenses) are succinctly described here.

== Experts ==
{{list experts}}

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