Difference between revisions of "Template:Infobox relax release/doc"
Jump to navigation
Jump to search
(Documented the 'type' and 'date' parameters.) |
(Documented the new 'manual' parameter.) |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 6: | Line 6: | ||
== Usage == | == Usage == | ||
| − | <nowiki>{{</nowiki>'''relax release | + | <nowiki>{{</nowiki>'''infobox relax release''' |
{{!}}''version='' | {{!}}''version='' | ||
{{!}}''prev='' | {{!}}''prev='' | ||
{{!}}''next='' | {{!}}''next='' | ||
| + | {{!}}''keywords='' | ||
{{!}}''type='' | {{!}}''type='' | ||
{{!}}''date='' | {{!}}''date='' | ||
| + | {{!}}''manual='' | ||
<nowiki>}}</nowiki> | <nowiki>}}</nowiki> | ||
| − | ; version : The relax version number. | + | ; version : The relax version number. |
| − | ; prev | + | ; prev : The previous relax version number. |
| − | ; next | + | ; next : The next relax version number (optional). |
| − | ; type | + | ; keywords : Any keywords to describe the release with (optional). |
| − | ; date | + | ; type : The release type, for example <code>Major feature</code>, <code>Minor feature</code>, <code>Major bugfix</code>, <code>Minor bugfix</code>, etc. (optional). |
| + | ; date : The release date. | ||
| + | ; manual : If this is set to 'yes', or anything for that matter, a link will be provided for the PDF copy of the manual saved in the <code>/tags/<version>/docs/relax.pdf</code> path of the SVN repository. | ||
== Example == | == Example == | ||
<pre> | <pre> | ||
| − | {{relax release | + | {{infobox relax release |
| − | | version = 3.3.0 | + | | version = 3.3.0 |
| − | | prev | + | | prev = 3.2.3 |
| − | | next | + | | next = 3.3.1 |
| − | | type | + | | keywords = Relaxation dispersion |
| − | | date | + | | type = Major feature |
| + | | date = 3 September 2014 | ||
| + | | manual = yes | ||
}} | }} | ||
</pre> | </pre> | ||
| − | {{relax release | + | {{infobox relax release |
| − | | version = 3.3.0 | + | | version = 3.3.0 |
| − | | prev | + | | prev = 3.2.3 |
| − | | next | + | | next = 3.3.1 |
| − | | type | + | | keywords = Relaxation dispersion |
| − | | date | + | | type = Major feature |
| + | | date = 3 September 2014 | ||
| + | | manual = yes | ||
}} | }} | ||
Latest revision as of 13:27, 22 October 2015
Template documentation
Goal
To present an InfoBox to summarise the relax release, and provide links to previous and next versions.
Usage
{{infobox relax release
|version=
|prev=
|next=
|keywords=
|type=
|date=
|manual=
}}
- version
- The relax version number.
- prev
- The previous relax version number.
- next
- The next relax version number (optional).
- keywords
- Any keywords to describe the release with (optional).
- type
- The release type, for example
Major feature,Minor feature,Major bugfix,Minor bugfix, etc. (optional). - date
- The release date.
- manual
- If this is set to 'yes', or anything for that matter, a link will be provided for the PDF copy of the manual saved in the
/tags/<version>/docs/relax.pdfpath of the SVN repository.
Example
{{infobox relax release
| version = 3.3.0
| prev = 3.2.3
| next = 3.3.1
| keywords = Relaxation dispersion
| type = Major feature
| date = 3 September 2014
| manual = yes
}}
 | |||||
| relax version 3.3.0 | |||||
| |||||
| Keywords | Relaxation dispersion | ||||
|---|---|---|---|---|---|
| Release type | Major feature | ||||
| Release date | 3 September 2014 | ||||
|
| |||||
 The relax 3.3.0 user manual | |||||
