Difference between revisions of "Template:EcosystemRelease"

[quality revision] [quality revision]
m
m
 

1 Usage[edit]

The EcosystemRelease template is used to indicate for which ecosystem release revision(s) of the flow associated with this wiki (e.g. v1.y.z ,or v2.y.z, or...), an article part (chapter, paragraph, table...) is valid. Per default (i.e. if this template is not used), any part of an article is valid for all ecosystem release revisions for which the entire article is valid.

It outputs a "standardized" string that might be used to name an article part.

Usage: {{EcosystemRelease | revision=<revision> | range =<range> | revision2=<revision2>}}

Where:

  • <revision> is the mandatory ecosystem release revision for which the article part is valid.
    • The possible values for this parameter are available in the EcosystemRelease/Revision template.
    • The optional <range> and <revision2> parameters allow to define a range of revisions.
  • <range> is the optional range of the ecosystem release revisions for which the article part is valid. The possible values are:
    • and before: the article part is valid only for the revision(s) less than or equal to <revision>
    • and after: the article part is valid only for the revision(s) greater than or equal to <revision>
    • to: the article part is only valid from <revision> to <revision2>
  • <revision2> is the mandatory ecosystem release upper revision for which the article part is valid, when <range> is set to "to"; in this case, <revision> becomes the lower revision for which the article part is valid.
    • This parameter is ignored if <range> is either not set, or set to another value than "to".

If the mouse is left over a revision (or the More info.png icon), a popup window shows, for that revision:

  • the versions of the Linux kernel, U-Boot, TF-A and OP-TEE
  • the version of the STM32Cube MPU Package
  • the version of OpenEmbedded
  • the version of Android

This information comes from the EcosystemRelease/Components template.

2 Basic examples[edit]

You type You get
A specific revision (revision 2.1.0): the next one

{{EcosystemRelease | revision=2.1.0}}

ecosystem release v2.1.0 More info.png

Another specific revision (revision 2.0.0): the latest one
{{EcosystemRelease | revision=2.0.0}}

ecosystem release v2.0.0 More info.png

Revisions that are lower than or equal to a revision
{{EcosystemRelease | revision=x.1.0 | range=and before}}

ecosystem release ≤ vx.1.0 More info.png

Revisions that are greater than or equal to a revision
{{EcosystemRelease | revision=x.1.0 | range=and after}}

ecosystem release ≥ vx.1.0 More info.png

Range of revisions
{{EcosystemRelease | revision=x.0.0 | range=to | revision2=x.1.0}}

ecosystem release vx.0.0 More info.png to vx.1.0 More info.png

3 More examples[edit]

You type You get
Revision x.1.0
{{EcosystemRelease | revision=x.1.0}}

ecosystem release vx.1.0 More info.png

Revision x.0.0
{{EcosystemRelease | revision=x.0.0}}

ecosystem release vx.0.0 More info.png

Former revision that is part of a flow that is not the one associated with this wiki.
{{EcosystemRelease | revision=0.y.0}}<br>
{{EcosystemRelease | revision=0.y.0 | range=and before}}<br>
{{EcosystemRelease | revision=0.y.0 | range=and after}}

ecosystem release v0.y.0
ecosystem release ≤ v0.y.0
ecosystem release ≥ v0.y.0

Unspecified revision
{{EcosystemRelease}}

ecosystem release unknown revision Warning.png

Unknown revision
{{EcosystemRelease | revision=10.20.30}}

ecosystem release unknown revision 10.20.30 Warning.png

Unspecified revision2
{{EcosystemRelease | revision=x.1.0 | range=to}}

ecosystem release vx.1.0 More info.png to unknown revision Warning.png

Unknown revision2
{{EcosystemRelease | revision=x.1.0 | range=to | revision2=10.20.30}}

ecosystem release vx.1.0 More info.png to unknown revision 10.20.30 Warning.png

Former revision2 that is part of a flow that is not the one associated with this wiki.
{{EcosystemRelease | revision=x.0.0 | range=to | revision2=0.y.0}}<br>
{{EcosystemRelease | revision=0.y.0 | range=to | revision2=0.y.0}}

ecosystem release vx.0.0 More info.png to v0.y.0
ecosystem release v0.y.0 to v0.y.0

Ignored revision2
{{EcosystemRelease | revision=x.0.0 | range=and after  | revision2=x.1.0}}

ecosystem release ≥ vx.0.0 More info.png

Unknown range
{{EcosystemRelease | revision=x.1.0 | range=error}}

ecosystem release vx.1.0 More info.png unknown range error Warning.png

Check that there's no space before and after the text
BEFORE{{EcosystemRelease | revision=x.0.0}}AFTER<br>
BEFORE{{EcosystemRelease | revision=x.1.0 | range=and before}}AFTER<br>
BEFORE{{EcosystemRelease | revision=x.1.0 | range=and after}}AFTER<br>
BEFORE{{EcosystemRelease | revision=x.0.0 | range=to | revision2=x.1.0}}AFTER

BEFOREecosystem release vx.0.0 More info.png AFTER
BEFOREecosystem release ≤ vx.1.0 More info.png AFTER
BEFOREecosystem release ≥ vx.1.0 More info.png AFTER
BEFOREecosystem release vx.0.0 More info.png to vx.1.0 More info.pngAFTER

4 Code[edit]

ecosystem release unknown revision Warning.png

<noinclude>

==Usage==
The [[Template:EcosystemRelease|EcosystemRelease]] template is used '''to indicate for which ecosystem release revision(s)''' of the flow associated with this wiki (e.g. v1.y.z ,or v2.y.z, or...), '''an article part (chapter, paragraph, table...) is valid'''. Per default (i.e. if this template is not used), any part of an article is valid for all ecosystem release revisions for which the entire article is valid.

It outputs a "standardized" string that might be used to name an article part.

 Usage: <nowiki>{{</nowiki>EcosystemRelease | revision={{HighlightParam|<revision>}} | range ={{HighlightParam|<range>}} | revision2={{HighlightParam|<revision2>}}}}
Where:
* {{HighlightParam|<revision>}} is the '''mandatory''' ecosystem release revision for which the article part is valid.
** The possible values for this parameter are available in the [[Template:EcosystemRelease/Revision|EcosystemRelease/Revision]] template.
** The optional {{HighlightParam|<range>}} and {{HighlightParam|<revision2>}} parameters allow to define a range of revisions. 

* {{HighlightParam|<range>}} is the '''optional''' range of the ecosystem release revisions for which the article part is valid. The possible values are:
** '''and before''': the article part is valid only for the revision(s) less than or equal to {{HighlightParam|<revision>}}
** '''and after''': the article part is valid only for the revision(s) greater than or equal to {{HighlightParam|<revision>}}
** '''to''': the article part is only valid from {{HighlightParam|<revision>}} to {{HighlightParam|<revision2>}}

* {{HighlightParam|<revision2>}} is the '''mandatory''' ecosystem release upper revision for which the article part is valid, '''when {{HighlightParam|<range>}} is set to "to'''"; in this case, {{HighlightParam|<revision>}} becomes the lower revision for which the article part is valid.
** This parameter is ignored if {{HighlightParam|<range>}} is either not set, or set to another value than "'''to'''".

If the mouse is left over a revision (or the <sup>[[File:More_info.png|15px|link=]]</sup> icon), '''a popup window''' shows, for that revision:
* the versions of the Linux kernel, U-Boot, TF-A and OP-TEE
* the version of the STM32Cube MPU Package
* the version of OpenEmbedded
* the version of Android
This information comes from the [[Template:EcosystemRelease/Components|EcosystemRelease/Components]] template.

==Basic examples==
{| class="st-table"
! style="width: 50%;" | You type !! You get
|-
| A specific revision (revision 2.1.0.0)): the next one<pre style="white-space: pre-wrap;">

{{EcosystemRelease | revision=2.1.0}}</pre>

|
{{EcosystemRelease | revision=2.1.0}}
|-
| Another specific revision (revision 2.0.0): the latest one<pre style="white-space: pre-wrap;">

{{EcosystemRelease | revision=2.0.0}}</pre>

|
{{EcosystemRelease | revision=2.0.0}}
|-
| Revisions that are lower than or equal to a revision<pre style="white-space: pre-wrap;">

{{EcosystemRelease | revision=x.1.0 | range=and before}}</pre>

|
{{EcosystemRelease | revision=x.1.0 | range=and before}}
|-
| Revisions that are greater than or equal to a revision<pre style="white-space: pre-wrap;">

{{EcosystemRelease | revision=x.1.0 | range=and after}}</pre>

|
{{EcosystemRelease | revision=x.1.0 | range=and after}}
|-
| Range of revisions<pre style="white-space: pre-wrap;">

{{EcosystemRelease | revision=x.0.0 | range=to | revision2=x.1.0}}</pre>

|
{{EcosystemRelease | revision=x.0.0 | range=to | revision2=x.1.0}}
|}

==More examples==
{| class="st-table"
!  style="width: 50%;" | You type !! You get
|-
| Revision x.1.0<pre style="white-space: pre-wrap;">

{{EcosystemRelease | revision=x.1.0}}</pre>

|
{{EcosystemRelease | revision=x.1.0}}
|-
| Revision x.0.0<pre style="white-space: pre-wrap;">

{{EcosystemRelease | revision=x.0.0}}</pre>

|
{{EcosystemRelease | revision=x.0.0}}
|-
| Former revision that is part of a flow that is not the one associated with this wiki.<pre style="white-space: pre-wrap;">

{{EcosystemRelease | revision=0.y.0}}<br>

{{EcosystemRelease | revision=0.y.0 | range=and before}}<br>

{{EcosystemRelease | revision=0.y.0 | range=and after}}</pre>

|
{{EcosystemRelease | revision=0.y.0}}<br>

{{EcosystemRelease | revision=0.y.0 | range=and before}}<br>

{{EcosystemRelease | revision=0.y.0 | range=and after}}
|-
| Unspecified revision<pre style="white-space: pre-wrap;">

{{EcosystemRelease}}</pre>

|
{{EcosystemRelease}}
|-
| Unknown revision<pre style="white-space: pre-wrap;">

{{EcosystemRelease | revision=10.20.30}}</pre>

|
{{EcosystemRelease | revision=10.20.30}}
|-
| Unspecified revision2<pre style="white-space: pre-wrap;">

{{EcosystemRelease | revision=x.1.0 | range=to}}</pre>

|
{{EcosystemRelease | revision=x.1.0 | range=to}}
|-
| Unknown revision2<pre style="white-space: pre-wrap;">

{{EcosystemRelease | revision=x.1.0 | range=to | revision2=10.20.30}}</pre>

|
{{EcosystemRelease | revision=x.1.0 | range=to | revision2=10.20.30}}

|-
| Former revision2 that is part of a flow that is not the one associated with this wiki.<pre style="white-space: pre-wrap;">

{{EcosystemRelease | revision=x.0.0 | range=to | revision2=0.y.0}}<br>

{{EcosystemRelease | revision=0.y.0 | range=to | revision2=0.y.0}}</pre>

|
{{EcosystemRelease | revision=x.0.0 | range=to | revision2=0.y.0}}<br>

{{EcosystemRelease | revision=0.y.0 | range=to | revision2=0.y.0}}
|-
| Ignored revision2<pre style="white-space: pre-wrap;">

{{EcosystemRelease | revision=x.0.0 | range=and after  | revision2=x.1.0}}</pre>

|
{{EcosystemRelease | revision=x.0.0 | range=and after  | revision2=x.1.0}}
|-
| Unknown range<pre style="white-space: pre-wrap;">

{{EcosystemRelease | revision=x.1.0 | range=error}}</pre>

|
{{EcosystemRelease | revision=x.1.0 | range=error}}
|-
| Check that there's no space before and after the text<pre style="white-space: pre-wrap;">

BEFORE{{EcosystemRelease | revision=x.0.0}}AFTER<br>

BEFORE{{EcosystemRelease | revision=x.1.0 | range=and before}}AFTER<br>

BEFORE{{EcosystemRelease | revision=x.1.0 | range=and after}}AFTER<br>

BEFORE{{EcosystemRelease | revision=x.0.0 | range=to | revision2=x.1.0}}AFTER</pre>

|
BEFORE{{EcosystemRelease | revision=x.0.0}}AFTER<br>

BEFORE{{EcosystemRelease | revision=x.1.0 | range=and before}}AFTER<br>

BEFORE{{EcosystemRelease | revision=x.1.0 | range=and after}}AFTER<br>

BEFORE{{EcosystemRelease | revision=x.0.0 | range=to | revision2=x.1.0}}AFTER
|}

==Code==
{{UpdateNeededForNewRelease|
* Update the first "basic example" with the latest revision, and add in "more examples" the legacy revisions
* Update, if needed, the below sentence "not valid in the flow (v1.y.z) associated"}}</noinclude>ecosystem release {{#switch: {{{range|}}}
| and before = &le;
| and after = &ge;
}} {{#switch:{{EcosystemRelease/Revision | revision={{{revision|}}}}}
| unknown = <span title="This revision value is not valid">{{Highlight|unknown revision {{{revision|}}}}} <sup>[[File:Warning.png|15px|link=]]</sup></span>{{#set:Ecosystem release=unknown revision {{{revision}}}}}
| former =  v{{{revision|}}}{{#set:Ecosystem release=revision of a previous flow {{{revision}}}}}
| #default = <span title="{{EcosystemRelease/Components | revision={{{revision|}}}}}">v{{{revision}}} <sup>[[File:More_info.png|15px|link=]]</sup></span>{{#set:Ecosystem release={{{revision}}}}}}} {{#switch: {{{range}}}
| and before | and after =
| to = to {{#switch:{{EcosystemRelease/Revision | revision={{{revision2|}}}}}
  | unknown = <span title="This revision value is not valid">{{Highlight|unknown revision {{{revision2|}}}}} <sup>[[File:Warning.png|15px|link=]]</sup></span>

  | former = v{{{revision2|}}}
  | #default = <span title="{{EcosystemRelease/Components | revision={{{revision2|}}}}}">v{{{revision2}}} <sup>[[File:More_info.png|15px|link=]]</sup></span>

  }}
| #default = {{#if: {{{range|}}} | <span title="This range value is not valid">{{Highlight|unknown range {{{range|}}}}} <sup>[[File:Warning.png|15px|link=]]</sup></span> |}}
}}
Line 30: Line 30:
 
! style="width: 50%;" | You type !! You get
 
! style="width: 50%;" | You type !! You get
 
|-
 
|-
| A specific revision (revision 2.0.0)
+
| A specific revision (revision 2.1.0): the next one
  +
<pre style="white-space: pre-wrap;">
  +
{{EcosystemRelease | revision=2.1.0}}
  +
</pre>
  +
|
  +
{{EcosystemRelease | revision=2.1.0}}
  +
|-
  +
| Another specific revision (revision 2.0.0): the latest one
 
<pre style="white-space: pre-wrap;">
 
<pre style="white-space: pre-wrap;">
 
{{EcosystemRelease | revision=2.0.0}}
 
{{EcosystemRelease | revision=2.0.0}}