Difference between revisions of "Help:Software example page"

From SNIC Documentation
Jump to: navigation, search
 
(3 intermediate revisions by the same user not shown)
Line 6: Line 6:
 
Remember to create the Talk: page ([[Help:Talk example page|example here]]).
 
Remember to create the Talk: page ([[Help:Talk example page|example here]]).
  
Also note that the information on available installations of software has been moved to the resource pages.
+
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:
 
Example with fine tuned output:
Line 16: Line 16:
 
}}
 
}}
 
[http://example.com {{PAGENAME}}] (abbreviation explained) is a software package for {{#show: {{PAGENAME}} |?description}}, which is motivated by this dependent clause.
 
[http://example.com {{PAGENAME}}] (abbreviation explained) is a software package for {{#show: {{PAGENAME}} |?description}}, which is motivated by this dependent clause.
 
== Experts ==
 
{{list experts}}
 
  
 
== Availability ==
 
== Availability ==
 
{{list resources for software}}
 
{{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 ==
 
== License ==
Line 27: Line 27:
  
 
Any further license particularities (such as site licenses) are succinctly described here.
 
Any further license particularities (such as site licenses) are succinctly described here.
 +
 +
== Experts ==
 +
{{list experts}}
  
 
== Links ==
 
== Links ==
 
* [http://pingu.com Official website]
 
* [http://pingu.com Official website]
 +
* [http://pingu.com Publication]
 
* [http://pingu.com Manual]
 
* [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]