Difference between revisions of "Template:Software/Release"

From SoftMC-Wiki
Jump to: navigation, search
(modified design)
m (branding)
 
(21 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
<!--   
+
<includeonly><!--   
 +
 
 
### page settings
 
### page settings
 
-->__NOTOC__<!--   
 
-->__NOTOC__<!--   
 +
  
 
### MAIN
 
### MAIN
−
-->
+
-->{{Note/Important
 +
|This software release is only a basic package for the application engineers.<br/>
 +
Releases for single projects or machine types, must be cleared with product managers or software manager from concrete business unit!}}
 +
 
 
;Version
 
;Version
−
:{{{version}}}
+
{{#if:{{{version|}}}
 +
|:{{{version}}}
 +
|:{{#replace:{{PAGENAME}}|/|&nbsp;}}
 +
}}
 
;Release date
 
;Release date
 
:{{{date}}}
 
:{{{date}}}
Line 12: Line 20:
 
;Download location
 
;Download location
 
:{{{location}}}
 
:{{{location}}}
−
}}<!--
+
}}
 +
{{#if:{{{history|}}}|:
 +
;History<br>
 +
:{{{history}}}
 +
}}
 +
<!--
  
 
### SERVICE PACKS
 
### SERVICE PACKS
 
-->{{#if:{{#ifexist:Category:{{FULLPAGENAME}}|true|{{{service packs|}}} }}|: <!-- if category page or parameter exist -->
 
-->{{#if:{{#ifexist:Category:{{FULLPAGENAME}}|true|{{{service packs|}}} }}|: <!-- if category page or parameter exist -->
−
== Service packs ==
+
= Service packs =
 
{{#if:{{{service packs|}}}|
 
{{#if:{{{service packs|}}}|
 
{{{service packs}}}
 
{{{service packs}}}
Line 22: Line 35:
 
-->{{#ifexist:Category:{{FULLPAGENAME}}|
 
-->{{#ifexist:Category:{{FULLPAGENAME}}|
 
{{#tag:DynamicPageList|
 
{{#tag:DynamicPageList|
−
category      = Category:{{FULLPAGENAME}}
+
category      = {{FULLPAGENAME}}
−
notcategory  = Category:{{NAMESPACE}}:{{BASEPAGENAME}}
+
notcategory  = {{NAMESPACE}}:{{BASEPAGENAME}}
 
namespace    = {{NAMESPACE}}
 
namespace    = {{NAMESPACE}}
 +
ordermethod  = created
 
}}<!--  
 
}}<!--  
 
also add to service packs category  
 
also add to service packs category  
Line 33: Line 47:
 
### IMPORTANT HINTS
 
### IMPORTANT HINTS
 
-->{{#if:{{{hints|}}}|:
 
-->{{#if:{{{hints|}}}|:
−
== Important hints ==
+
= Important hints =
 
{{{hints}}}
 
{{{hints}}}
 +
}}<!--
 +
 +
### FEATURES
 +
-->{{#if:{{{features|}}}|:
 +
= Features =
 +
{{{features}}}
 
}}<!--
 
}}<!--
  
 
### BUG FIXES
 
### BUG FIXES
 
-->{{#if:{{{bug fixes|}}}|:
 
-->{{#if:{{{bug fixes|}}}|:
−
== Bug fixes ==
+
= Bug fixes =
 
{{{bug fixes}}}
 
{{{bug fixes}}}
−
}}<!--
 
−
 
−
### FEATURES
 
−
-->{{#if:{{{features|}}}|:
 
−
== Features ==
 
−
{{{features}}}
 
 
}}<!--
 
}}<!--
  
 
### KNOWN ISSUES
 
### KNOWN ISSUES
 
-->{{#if:{{{known issues|}}}|:
 
-->{{#if:{{{known issues|}}}|:
−
== Known issues ==
+
= Known issues =
 
{{{known issues}}}
 
{{{known issues}}}
 +
}}<!--
 +
 +
<!--
 +
 +
### DOCUMENTS
 +
-->{{#if:{{{documents|}}}|:
 +
= Documents =
 +
{{{documents}}}
 
}}<!--
 
}}<!--
  
 
### FURTHER INFO
 
### FURTHER INFO
 
-->{{#if:{{{further info|}}}|:
 
-->{{#if:{{{further info|}}}|:
−
== Further information ==
+
= Further information =
 
{{{further info}}}
 
{{{further info}}}
 
}}<!--   
 
}}<!--   
  
 
### categories
 
### categories
−
--><includeonly>
+
-->
 
[[Category:{{NAMESPACE}}:{{BASEPAGENAME}}]]
 
[[Category:{{NAMESPACE}}:{{BASEPAGENAME}}]]
−
</includeonly>
+
</includeonly><!-- 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
### DESCRIPTION
 +
--><noinclude>
 +
{{Template
 +
|description=
 +
This template is designed to be used on the actual software '''release''' and '''sub-release''' pages.
 +
 
 +
|template=
 +
<nowiki>
 +
{{Software/Release
 +
|version=
 +
|date=
 +
|location=
 +
|history=
 +
|hints=
 +
|features=
 +
|bug fixes=
 +
|further info=
 +
|documents=
 +
}}</nowiki>
 +
 
 +
|parameters=
 +
;version (optional)
 +
: Full version string of the release.
 +
;date
 +
: Release date.
 +
;location (optional)
 +
: Download link for the release.
 +
; History (optional)
 +
: History table started from release date and include all service packs (introduces for release 2012-03-30)
 +
;service packs(optional) '' Don't use for new release pages after 2012-03-30
 +
: Additional information in the Service packs section. It is shown before the dynamic list of service pack pages.
 +
;hints (optional)
 +
: Important hints section.
 +
;features (optional)
 +
: Features section.
 +
;bug fixes (optional)
 +
: Bug fixes section.
 +
;documents (optional)
 +
: a link list to all documents which refers to this version
 +
;further info (optional)
 +
: Further info section.
 +
 
 +
|operation=
 +
* The dynamic list of sub-release pages is automatically generated, if release sub-pages also use this template and the corresponding category page exist.
 +
* If ''version'' is empty, the version string is generated from the page name.
 +
 
 +
|examples=
 +
<pre>
 +
{{Software/Release
 +
|version=
 +
|date=2010-05-10
 +
|location={{External-Media|aico.control/aico.control_V1.5.0.zip}}
 +
|history={{Software/NewsHeader|History|
 +
{{Software/News|2012-03-30|aico.metrology 4.4.6.0 released|[[#Features|Features]] ,
 +
[[#Bug fixes|Bug fixes]]<br> [[#Documents| Documents]] , [[#Further information|Further Information ]]}}
 +
 
 +
|hints=
 +
To avoid inconsistence in master directory all files of existing master must be deleted before changing to an other master!
 +
 
 +
|features=
 +
== Component AA ==
 +
* Feature A
 +
* Feature B
 +
== Component BB ==
 +
* Feature C
 +
* Feature D
 +
 
 +
|bug fixes=
 +
*{{Bugzilla|3559}} In TpJog: Unexpected exception Error: 13005, ....Inverse kinematics failed
 +
*{{Bugzilla|3615}} sub CalculateGantryRelations does not work without axes
 +
*{{Bugzilla|3616}} group.DecStop is (sometimes) set wrongly
 +
*...
 +
 
 +
|further info=
 +
== Recommended Firmware ==
 +
For all standard purpose applications Version 4.3.17 or higher is recommended.
 +
...
 +
== Recommended MIB FPGA Version ==
 +
Currently Version 0x0019 should be used
 +
|documents=
 +
Here a list for all included documents for this release followed...
 +
}}
 +
</pre>
 +
}}
 +
 
 +
[[Category:Template:Software]]
 +
</noinclude>

Latest revision as of 08:11, 23 March 2014

This template is designed to be used on the actual software release and sub-release pages.

Template

{{Software/Release
|version=
|date=
|location=
|history=
|hints=
|features=
|bug fixes=
|further info=
|documents=
}}

Parameters

version (optional)
Full version string of the release.
date
Release date.
location (optional)
Download link for the release.
History (optional)
History table started from release date and include all service packs (introduces for release 2012-03-30)
service packs(optional) Don't use for new release pages after 2012-03-30
Additional information in the Service packs section. It is shown before the dynamic list of service pack pages.
hints (optional)
Important hints section.
features (optional)
Features section.
bug fixes (optional)
Bug fixes section.
documents (optional)
a link list to all documents which refers to this version
further info (optional)
Further info section.

Operation

  • The dynamic list of sub-release pages is automatically generated, if release sub-pages also use this template and the corresponding category page exist.
  • If version is empty, the version string is generated from the page name.

Examples

{{Software/Release
|version=
|date=2010-05-10
|location={{External-Media|aico.control/aico.control_V1.5.0.zip}}
|history={{Software/NewsHeader|History|
{{Software/News|2012-03-30|aico.metrology 4.4.6.0 released|[[#Features|Features]] ,
 [[#Bug fixes|Bug fixes]]<br> [[#Documents| Documents]] , [[#Further information|Further Information ]]}}

|hints=
To avoid inconsistence in master directory all files of existing master must be deleted before changing to an other master!

|features=
== Component AA ==
* Feature A
* Feature B
== Component BB ==
* Feature C
* Feature D

|bug fixes=
*{{Bugzilla|3559}} In TpJog: Unexpected exception Error: 13005, ....Inverse kinematics failed
*{{Bugzilla|3615}} sub CalculateGantryRelations does not work without axes
*{{Bugzilla|3616}} group.DecStop is (sometimes) set wrongly
*...

|further info=
== Recommended Firmware ==
For all standard purpose applications Version 4.3.17 or higher is recommended.
...
== Recommended MIB FPGA Version ==
Currently Version 0x0019 should be used
|documents= 
Here a list for all included documents for this release followed...
}}

For more examples refer to pages, which use this template: What links here.

Help:Templates describes general usage of templates, including treatment of special characters.

Retrieved from "http://softmc.servotronix.com/index.php?title=Template:Software/Release&oldid=115374"