Difference between revisions of "Template:Infobox relax release/doc"

From relax wiki
Jump to navigation Jump to search
m (Bugman admin moved page Template:Relax release infobox/doc to Template:Infobox relax release/doc without leaving a redirect: More conventional name)
(Documentation fixes and expansion.)
Line 6: Line 6:
 
== Usage ==
 
== Usage ==
  
  <nowiki>{{</nowiki>'''relax release infobox'''
+
  <nowiki>{{</nowiki>'''infobox relax release'''
 
  {{!}}''version=''
 
  {{!}}''version=''
 
  {{!}}''prev=''
 
  {{!}}''prev=''
 
  {{!}}''next=''
 
  {{!}}''next=''
 +
{{!}}''keywords=''
 
  {{!}}''type=''
 
  {{!}}''type=''
 
  {{!}}''date=''
 
  {{!}}''date=''
 
  <nowiki>}}</nowiki>
 
  <nowiki>}}</nowiki>
  
; version : The relax version number.
+
; version : The relax version number.
; prev   : The previous relax version number.
+
; prev     : The previous relax version number.
; next   : The next relax version number (optional).
+
; next     : The next relax version number (optional).
; type   : The release type, for example <code>Major feature</code>, <code>Minor feature</code>, <code>Major bugfix</code>, <code>Minor bugfix</code>, etc.
+
; keywords : Any keywords to describe the release with (optional).
; date   : The release 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.
  
 
== Example ==
 
== Example ==
  
 
<pre>
 
<pre>
{{relax release infobox
+
{{infobox relax release
| version = 3.3.0
+
| version = 3.3.0
| prev   = 3.2.3
+
| prev     = 3.2.3
| next   = 3.3.1
+
| next     = 3.3.1
| type   = Major feature
+
| keywords = Relaxation dispersion
| date   = 3 September 2014
+
| type     = Major feature
 +
| date     = 3 September 2014
 
}}
 
}}
 
</pre>
 
</pre>
  
{{relax release infobox
+
{{infobox relax release
| version = 3.3.0
+
| version = 3.3.0
| prev   = 3.2.3
+
| prev     = 3.2.3
| next   = 3.3.1
+
| next     = 3.3.1
| type   = Major feature
+
| keywords = Relaxation dispersion
| date   = 3 September 2014
+
| type     = Major feature
 +
| date     = 3 September 2014
 
}}
 
}}
  

Revision as of 19:17, 21 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=
}}
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.

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
}}
Official relax releases
relax logo
relax version 3.3.0
Previous version Next version
← relax 3.2.3 relax 3.3.1 →

Keywords Relaxation dispersion
Release type Major feature
Release date 3 September 2014

The PDF version of the relax 3.3.0 user manual The relax 3.3.0 user manual