Difference between revisions of "Template:EcosystemFlow/Archives"

[unchecked revision] [quality revision]
m
m
 

1 Usage[edit]

The EcosystemFlow/Archives template is used to insert a generic or custom message about the wiki archives so that readers might switch from a wiki dedicated to an ecosystem releases flow (e.g. v2.y.z) to a wiki dedicated to another ecosystem releases flow (e.g. v1.y.z).

The generic message takes offers readers to read the article of the Wiki archives content tab where they get the list of the wiki archives, which allows them to explicitly switch on a wiki dedicated to another ecosystem releases flow.

Usage: {{EcosystemFlow/Archives | custom=<custom> | flow=<flow> | page=<page>}}

Where:

  • <custom> is the optional identifier of a custom message. 2 values are currently possible:
    • Basic: a simple interwiki link between the current wiki and the targeted wiki is inserted.
    • Android: a custom message for the STM32MPU distribution for Android™ is inserted.
  • <flow> is the identifier of the targeted wiki dedicated to another ecosystem releases flow than the current one. This parameter is mandatory if <custom> is set, else it is ignored. 1 value is currently possible:
  • <page> is the name of the targeted page in the targeted wiki request. This parameter is optional if <custom> is set (per default, it is set with the name of the current page), else it is ignored. Whether this parameter is set or not, please cross-check that the targeted page really exists in the targeted wiki.

The returned value is:

  • a generic or custom message depending on the parameters
  • "unknown custom", if <custom> is not supported.
  • "unknown flow", if <flow> is not supported.

2 Basic examples[edit]

You type You get
Generic message
{{EcosystemFlow/Archives}}

This wiki is for the v2 ecosystem releases. For information about the previous ecosystem releases, please go through the Wiki archives.

Simple interwiki link (link to the current page i.e. Template:EcosystemFlow/Archives)
{{EcosystemFlow/Archives | custom=Basic | flow=v1}}

Template:EcosystemFlow/Archives page for the v1 ecosystem releases (in archived wiki)

Simple interwiki link (link to the "Development zone" page)
{{EcosystemFlow/Archives | custom=Basic | flow=v1 | page=Development zone}}

Development zone page for the v1 ecosystem releases (in archived wiki)

Custom message for the STM32MPU distribution for Android™ (link to the current page i.e. Template:EcosystemFlow/Archives)
{{EcosystemFlow/Archives | custom=Android | flow=v1}}

The STM32MPU distribution for Android™ is not yet available in the v2 ecosystem releases: please refer to the Template:EcosystemFlow/Archives page for the v1 ecosystem releases (in archived wiki).

Custom message for the STM32MPU distribution for Android™ (link to the "STM32MP1 Developer Package for Android" page)
{{EcosystemFlow/Archives | custom=Android | flow=v1 | page=STM32MP1 Developer Package for Android}}

The STM32MPU distribution for Android™ is not yet available in the v2 ecosystem releases: please refer to the STM32MP1 Developer Package for Android page for the v1 ecosystem releases (in archived wiki).

3 More examples[edit]

You type You get
Unknown custom
{{EcosystemFlow/Archives | custom=not supported | flow=v1}}

unknown custom

Unknown flow
{{EcosystemFlow/Archives | custom=Android | flow=v0}}

The STM32MPU distribution for Android™ is not yet available in the v2 ecosystem releases: please refer to the unknown flow.

Unspecified flow
{{EcosystemFlow/Archives | custom=Android}}

The STM32MPU distribution for Android™ is not yet available in the v2 ecosystem releases: please refer to the unknown flow.

The targeted page doesn't exist in the targeted wiki: it is not detected (broken link)
{{EcosystemFlow/Archives | custom=Android | flow=v1 | page=not supported}}

The STM32MPU distribution for Android™ is not yet available in the v2 ecosystem releases: please refer to the not supported page for the v1 ecosystem releases (in archived wiki).

Check that there's no space before and after the text
BEFORE{{EcosystemFlow/Archives}}AFTER<br>
BEFORE{{EcosystemFlow/Archives | custom=Basic | flow=v1}}AFTER<br>
BEFORE{{EcosystemFlow/Archives | custom=Android | flow=v1}}AFTER

BEFOREThis wiki is for the v2 ecosystem releases. For information about the previous ecosystem releases, please go through the Wiki archives.AFTER
BEFORETemplate:EcosystemFlow/Archives page for the v1 ecosystem releases (in archived wiki)AFTER
BEFOREThe STM32MPU distribution for Android™ is not yet available in the v2 ecosystem releases: please refer to the Template:EcosystemFlow/Archives page for the v1 ecosystem releases (in archived wiki).AFTER

4 Code[edit]

This wiki is for the v2 ecosystem releases. For information about the previous ecosystem releases, please go through the Wiki archives.

<noinclude>

==Usage==
The [[Template:EcosystemFlow/Archives|EcosystemFlow/Archives]] template is used '''to insert a generic or custom message about the wiki archives''' so that readers might switch from a wiki dedicated to an ecosystem releases flow (e.g. v2.y.z) to a wiki dedicated to another ecosystem releases flow (e.g. v1.y.z).{{ReviewsComments|-- [[User:Bernard Puel|Bernard Puel]] ([[User talk:Bernard Puel|talk]]) 15:01, 11 June 2020 (CEST)<br />What do you mean with "takes readers" ?}}
The generic message takes readers to the 

The generic message offers readers to read the article of the [[Wiki archives]] content tab where they get the list of the wiki archives, which allows them to explicitly switch on a wiki dedicated to another ecosystem releases flow.

 Usage: <nowiki>{{</nowiki>EcosystemFlow/Archives | custom={{HighlightParam|<custom>}} | flow={{HighlightParam|<flow>}} | page={{HighlightParam|<page>}}}}
Where:
* {{HighlightParam|<custom>}} is the '''optional''' identifier of a custom message. 2 values are currently possible:
** '''Basic''': a simple interwiki link between the current wiki and the targeted wiki is inserted.
** '''Android''': a custom message for the STM32MPU distribution for Android&trade; is inserted.
* {{HighlightParam|<flow>}} is the identifier of the targeted wiki dedicated to another ecosystem releases flow than the current one. This parameter is '''mandatory''' if {{HighlightParam|<custom>}} is set, else it is ignored. 1 value is currently possible:
** '''v1''': [[stm32mpuv1:Main Page|STM32 MPU wiki for v1.y.z ecosystem releases]].
* {{HighlightParam|<page>}} is the name of the targeted page in the targeted wiki request. This parameter is '''optional''' if {{HighlightParam|<custom>}} is set (per default, it is set with the name of the current page), else it is ignored. Whether this parameter is set or not, please cross-check that the targeted page really exists in the targeted wiki. 

The returned value is:
* a generic or custom message depending on the parameters
* "unknown custom", if {{HighlightParam|<custom>}} is not supported.
* "unknown flow", if {{HighlightParam|<flow>}} is not supported.

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

{{EcosystemFlow/Archives}}</pre>

|
{{EcosystemFlow/Archives}}
|-
| Simple interwiki link (link to the current page i.e. Template:EcosystemFlow/Archives)<pre style="white-space: pre-wrap;">

{{EcosystemFlow/Archives | custom=Basic | flow=v1}}</pre>

|
{{EcosystemFlow/Archives | custom=Basic | flow=v1}}
|-
| Simple interwiki link (link to the "Development zone" page)<pre style="white-space: pre-wrap;">

{{EcosystemFlow/Archives | custom=Basic | flow=v1 | page=Development zone}}</pre>

|
{{EcosystemFlow/Archives | custom=Basic | flow=v1 | page=Development zone}}
|-
| Custom message for the STM32MPU distribution for Android&trade; (link to the current page i.e. Template:EcosystemFlow/Archives)<pre style="white-space: pre-wrap;">

{{EcosystemFlow/Archives | custom=Android | flow=v1}}</pre>

|
{{EcosystemFlow/Archives | custom=Android | flow=v1}}
|-
| Custom message for the STM32MPU distribution for Android&trade; (link to the "STM32MP1 Developer Package for Android" page)<pre style="white-space: pre-wrap;">

{{EcosystemFlow/Archives | custom=Android | flow=v1 | page=STM32MP1 Developer Package for Android}}</pre>

|
{{EcosystemFlow/Archives | custom=Android | flow=v1 | page=STM32MP1 Developer Package for Android}}
|}

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

{{EcosystemFlow/Archives | custom=not supported | flow=v1}}</pre>

|
{{EcosystemFlow/Archives | custom=not supported | flow=v1}}
|-
| Unknown flow<pre style="white-space: pre-wrap;">

{{EcosystemFlow/Archives | custom=Android | flow=v0}}</pre>

|
{{EcosystemFlow/Archives | custom=Android | flow=v0}}
|-
| Unspecified flow<pre style="white-space: pre-wrap;">

{{EcosystemFlow/Archives | custom=Android}}</pre>

|
{{EcosystemFlow/Archives | custom=Android}}
|-
| The targeted page doesn't exist in the targeted wiki: it is not detected (broken link)<pre style="white-space: pre-wrap;">

{{EcosystemFlow/Archives | custom=Android | flow=v1 | page=not supported}}</pre>

|
{{EcosystemFlow/Archives | custom=Android | flow=v1 | page=not supported}}
|-
| Check that there's no space before and after the text<pre style="white-space: pre-wrap;">

BEFORE{{EcosystemFlow/Archives}}AFTER<br>

BEFORE{{EcosystemFlow/Archives | custom=Basic | flow=v1}}AFTER<br>

BEFORE{{EcosystemFlow/Archives | custom=Android | flow=v1}}AFTER</pre>

|
BEFORE{{EcosystemFlow/Archives}}AFTER<br>

BEFORE{{EcosystemFlow/Archives | custom=Basic | flow=v1}}AFTER<br>

BEFORE{{EcosystemFlow/Archives | custom=Android | flow=v1}}AFTER
|}

==Code==</noinclude>{{#switch: {{{flow|}}}
| v1 = {{#switch: {{{page|none}}}
  | none = {{#vardefine:link|[[stm32mpuv1:{{FULLPAGENAME}}|{{FULLPAGENAME}}]] page for the v1 ecosystem releases (in archived wiki)}}
  | #default = {{#vardefine:link|[[stm32mpuv1:{{{page}}}|{{{page}}}]] page for the v1 ecosystem releases (in archived wiki)}}
  }}
| #default =  {{#vardefine:link|{{Highlight|unknown flow}}}}
}}{{#switch: {{{custom|none}}}
| none = This wiki is for the v2 ecosystem releases. For information about the previous ecosystem releases, please go through the [[Wiki archives]].
| Basic = {{#var:link}}
| Android = The STM32MPU distribution for Android&trade; is not yet available in the v2 ecosystem releases: please refer to the {{#var:link}}.
| #default = {{Highlight|unknown custom}}
}}
Line 2: Line 2:
 
==Usage==
 
==Usage==
 
The [[Template:EcosystemFlow/Archives|EcosystemFlow/Archives]] template is used '''to insert a generic or custom message about the wiki archives''' so that readers might switch from a wiki dedicated to an ecosystem releases flow (e.g. v2.y.z) to a wiki dedicated to another ecosystem releases flow (e.g. v1.y.z).
 
The [[Template:EcosystemFlow/Archives|EcosystemFlow/Archives]] template is used '''to insert a generic or custom message about the wiki archives''' so that readers might switch from a wiki dedicated to an ecosystem releases flow (e.g. v2.y.z) to a wiki dedicated to another ecosystem releases flow (e.g. v1.y.z).
{{ReviewsComments|-- [[User:Bernard Puel|Bernard Puel]] ([[User talk:Bernard Puel|talk]]) 15:01, 11 June 2020 (CEST)<br />What do you mean with "takes readers" ?}}
+
 
The generic message takes readers to the [[Wiki archives]] content tab where they get the list of the wiki archives, which allows them to explicitly switch on a wiki dedicated to another ecosystem releases flow.
+
The generic message offers readers to read the article of the [[Wiki archives]] content tab where they get the list of the wiki archives, which allows them to explicitly switch on a wiki dedicated to another ecosystem releases flow.
   
 
  Usage: <nowiki>{{</nowiki>EcosystemFlow/Archives | custom={{HighlightParam|<custom>}} | flow={{HighlightParam|<flow>}} | page={{HighlightParam|<page>}}}}
 
  Usage: <nowiki>{{</nowiki>EcosystemFlow/Archives | custom={{HighlightParam|<custom>}} | flow={{HighlightParam|<flow>}} | page={{HighlightParam|<page>}}}}