Difference between revisions of "Template:EcosystemRelease"

m

1 Usage[edit]

The EcosystemRelease template is used to indicate for which ecosystem release revision(s), 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 optional ecosystem release upper revision for which the article part is valid. If this parameter is set, when <range> is must be set to "to"; in this case, and <revision> becomes the lower revision for which the article part is valid.
    • This If this parameter is ignored if <range> is either not set, or and <range> is set to another value than "to", the article part is valid from <revision> to the latest revision.


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.


Clicking on the More info.png icon displays the article about the ecosystem release (e.g. STM32MP15 ecosystem release note - v1.1.0).

2 Basic examples[edit]

You type You get
A specific revision
{{EcosystemRelease | revision=1.0.0}}

ecosystem release v1.0.0 More info.png

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

ecosystem release ≤ v1.1.0 More info.png

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

ecosystem release ≥ v1.1.0 More info.png

Range of revisions
{{EcosystemRelease | revision=1.0.0 | range=to | revision2=1.1.0}}

ecosystem release v1.0.0 More info.png to 1.1.0 More info.png

3 More examples[edit]

You type You get
Another specific revision
{{EcosystemRelease | revision=1.1.0}}

ecosystem release v1.1.0 More info.png

Unspecified revision
{{EcosystemRelease}}

ecosystem release unknown revision

Unknown revision
{{EcosystemRelease | revision=0.0.1}}

ecosystem release unknown revision

Unspecified Any revision2
{{EcosystemRelease | revision=1.1.0 | range=to}}

ecosystem release v1.1.0 More info.png to unknown revision

Unknown revision2
{{EcosystemRelease | revision=1.1.0 | range=to | revision2=10.20.30}}

ecosystem release v1.1.0 More info.png to unknown revision

Ignored revision2

{{EcosystemRelease | revision=1.0.0 | range=and after  | revision2=1.1.0}}

ecosystem release ≥ v1.0.0 More info.png

Unknown range
{{EcosystemRelease | revision=1.1.0 | range=error}}

ecosystem release v1.1.0 More info.png unknown range

4 Code[edit]

ecosystem release unknown revision

<noinclude>

==Usage==
The [[Template:EcosystemRelease|EcosystemRelease]] template is used '''to indicate for which ecosystem release revision(s), 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 '''mandatoryoptional''' ecosystem release upper revision for which the article part is valid, '''when {{HighlightParam|<range>}} is set to "to'''"; in this case, . If this parameter is set, {{HighlightParam|<range>}} must be set to "'''to'''", and {{HighlightParam|<revision>}} becomes the lower revision for which the article part is valid.
** This If this parameter is ignored if not set, and {{HighlightParam|<range>}} is either not set, or set to another value than "'''to'''".
 to "'''to'''", the article part is valid from {{HighlightParam|<revision>}} to the latest revision.
{{ReviewsComments|NSA : The last proposed option is the same as the "and after" and could be confusing, I would prefer the template returns an error than the proposed option}}
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:{{ReviewsComments|NSA : I would prefer to have those information when hovering the icon "i"}}* 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.
=={{ReviewsComments|NSA : in relation to the previous comment, the next csentence should be changed}}
Clicking on the <sup>[[File:More_info.png|15px|link=]]</sup> icon displays '''the article about the ecosystem release''' (e.g. [[STM32MP15 ecosystem release note - v1.1.0]]).

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

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

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

{{EcosystemRelease | revision=1.1.0 | range=and before}}</pre>

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

{{EcosystemRelease | revision=1.1.0 | range=and after}}</pre>

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

{{EcosystemRelease | revision=1.0.0 | range=to | revision2=1.1.0}}</pre>

|
{{EcosystemRelease | revision=1.0.0 | range=to | revision2=1.1.0}}
|}

==More examples==
{| class="st-table"
!  style="width: 50%;" | You type !! You get
|-
| Another specific revision<pre style="white-space: pre-wrap;">

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

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

{{EcosystemRelease}}</pre>

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

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

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

{{EcosystemRelease | revision=1.1.0 | range=to}}</pre>

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

{{EcosystemRelease | revision=1.1.0 | range=to | revision2=10.20.30}}</pre>

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

{{EcosystemRelease | revision=1.0.0 | range=and after  | revision2=1.1.0}}</pre>

|
{{EcosystemRelease | revision=1.0.0 | range=and after  | revision2=1.1.0}}
|-
| Unknown range<pre style="white-space: pre-wrap;">

{{EcosystemRelease | revision=1.1.0 | range=error}}</pre>

|
{{EcosystemRelease | revision=1.1.0 | range=error}}
|}

==Code==</noinclude>ecosystem release {{#switch:{{EcosystemRelease/Revision | revision={{{revision|}}}}}
| unknown = {{Highlight|unknown revision}}
| #default =
  {{#switch: {{{range|}}}
  | and before = &le;
  | and after = &ge;
  }}  <span title="{{EcosystemRelease/Components | revision={{{revision|}}}}}">v{{{revision}}} <sup>[[File:More_info.png|15px|link=STM32MP15 ecosystem release note - v{{{revision}}}]]</sup></span> {{#switch: {{{range}}}
  | and before | and after =
  | to = to {{#switch:{{EcosystemRelease/Revision | revision={{{revision2|latest}}}}}
    | unknown = {{Highlight|unknown revision}}
    | #default = <span title="{{EcosystemRelease/Components | revision={{{revision2|latest}}}}}">{{{revision2|latest}}} <sup>[[File:More_info.png|15px|link=STM32MP15 ecosystem release note {{#if: {{{revision2|}}}|- v{{{revision2}}}| |}}]]</sup></span>

    }}
  | #default = {{#if: {{{range|}}} | {{Highlight|unknown range}} |}}
  }}
}}
Line 16: Line 16:
 
** '''to''': the article part is only valid from {{HighlightParam|<revision>}} to {{HighlightParam|<revision2>}}
 
** '''to''': the article part is only valid from {{HighlightParam|<revision>}} to {{HighlightParam|<revision2>}}
   
* {{HighlightParam|<revision2>}} is the '''optional''' ecosystem release upper revision for which the article part is valid. If this parameter is set, {{HighlightParam|<range>}} must be set to "'''to'''", and {{HighlightParam|<revision>}} becomes the lower revision for which the article part is valid.
+
* {{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.
** If this parameter is not set, and {{HighlightParam|<range>}} is set to "'''to'''", the article part is valid from {{HighlightParam|<revision>}} to the latest revision.
+
** This parameter is ignored if {{HighlightParam|<range>}} is either not set, or set to another value than "'''to'''".
{{ReviewsComments|NSA : The last proposed option is the same as the "and after" and could be confusing, I would prefer the template returns an error than the proposed option}}
 
   
If the mouse is left over a revision, '''a popup window''' shows, for that revision:
+
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:
{{ReviewsComments|NSA : I would prefer to have those information when hovering the icon "i"}}
 
 
* the versions of the Linux kernel, U-Boot, TF-A and OP-TEE
 
* the versions of the Linux kernel, U-Boot, TF-A and OP-TEE
 
* the version of the STM32Cube MPU Package
 
* the version of the STM32Cube MPU Package
Line 27: Line 25:
 
* the version of Android
 
* the version of Android
 
This information comes from the [[Template:EcosystemRelease/Components|EcosystemRelease/Components]] template.
 
This information comes from the [[Template:EcosystemRelease/Components|EcosystemRelease/Components]] template.
 
{{ReviewsComments|NSA : in relation to the previous comment, the next csentence should be changed}}
 
Clicking on the <sup>[[File:More_info.png|15px|link=]]</sup> icon displays '''the article about the ecosystem release''' (e.g. [[STM32MP15 ecosystem release note - v1.1.0]]).
 
   
 
==Basic examples==
 
==Basic examples==
Line 89: Line 84:
 
{{EcosystemRelease | revision=0.0.1}}
 
{{EcosystemRelease | revision=0.0.1}}
 
|-
 
|-
| Any revision2
+
| Unspecified revision2
 
<pre style="white-space: pre-wrap;">
 
<pre style="white-space: pre-wrap;">
 
{{EcosystemRelease | revision=1.1.0 | range=to}}
 
{{EcosystemRelease | revision=1.1.0 | range=to}}
Line 102: Line 97:
 
|
 
|
 
{{EcosystemRelease | revision=1.1.0 | range=to | revision2=10.20.30}}
 
{{EcosystemRelease | revision=1.1.0 | range=to | revision2=10.20.30}}
  +
|-
  +
| Ignored revision2
  +
<pre style="white-space: pre-wrap;">
  +
{{EcosystemRelease | revision=1.0.0 | range=and after  | revision2=1.1.0}}
  +
</pre>
  +
|
  +
{{EcosystemRelease | revision=1.0.0 | range=and after  | revision2=1.1.0}}
 
|-
 
|-
 
| Unknown range
 
| Unknown range
Line 118: Line 120:
 
   | and before = &le;
 
   | and before = &le;
 
   | and after = &ge;
 
   | and after = &ge;
   }}  <span title="{{EcosystemRelease/Components | revision={{{revision|}}}}}">{{{revision}}} <sup>[[File:More_info.png|15px|link=STM32MP15 ecosystem release note - v{{{revision}}}]]</sup></span> {{#switch: {{{range}}}
+
   }}  <span title="{{EcosystemRelease/Components | revision={{{revision|}}}}}">v{{{revision}}} <sup>[[File:More_info.png|15px|link=]]</sup></span> {{#switch: {{{range}}}
 
   | and before | and after =
 
   | and before | and after =
   | to = to {{#switch:{{EcosystemRelease/Revision | revision={{{revision2|latest}}}}}
+
   | to = to {{#switch:{{EcosystemRelease/Revision | revision={{{revision2|}}}}}
 
     | unknown = {{Highlight|unknown revision}}
 
     | unknown = {{Highlight|unknown revision}}
     | #default = <span title="{{EcosystemRelease/Components | revision={{{revision2|latest}}}}}">{{{revision2|latest}}} <sup>[[File:More_info.png|15px|link=STM32MP15 ecosystem release note {{#if: {{{revision2|}}}|- v{{{revision2}}}| |}}]]</sup></span>
+
     | #default = <span title="{{EcosystemRelease/Components | revision={{{revision2|}}}}}">{{{revision2}}} <sup>[[File:More_info.png|15px|link=]]</sup></span>
 
     }}
 
     }}
 
   | #default = {{#if: {{{range|}}} | {{Highlight|unknown range}} |}}
 
   | #default = {{#if: {{{range|}}} | {{Highlight|unknown range}} |}}
 
   }}
 
   }}
 
}}
 
}}

Attachments

Discussions