1. Usage
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 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 to "Basic", 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
| You type | You get |
|---|---|
Generic message
{{EcosystemFlow/Archives}}
|
This wiki is for the v5 ecosystem releases. For information about the previous ecosystem releases, 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 current page i.e. Template:EcosystemFlow/Archives)
{{EcosystemFlow/Archives | custom=Basic | flow=v2}}
|
Template:EcosystemFlow/Archives page for the v2 ecosystem releases (in archived wiki) |
Simple interwiki link (link to the current page i.e. Template:EcosystemFlow/Archives)
{{EcosystemFlow/Archives | custom=Basic | flow=v3}}
|
Template:EcosystemFlow/Archives page for the v3 ecosystem releases (in archived wiki) |
Simple interwiki link (link to the current page i.e. Template:EcosystemFlow/Archives)
{{EcosystemFlow/Archives | custom=Basic | flow=v4}}
|
Template:EcosystemFlow/Archives page for the v4 ecosystem releases (in archived wiki) |
Simple interwiki link (link to the current page i.e. Template:EcosystemFlow/Archives)
{{EcosystemFlow/Archives | custom=Basic | flow=v5}}
|
Template:EcosystemFlow/Archives page for the v5 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) |
Simple interwiki link (link to the "Development zone" page)
{{EcosystemFlow/Archives | custom=Basic | flow=v2 | page=Development zone}}
|
Development zone page for the v2 ecosystem releases (in archived wiki) |
Simple interwiki link (link to the "Development zone" page)
{{EcosystemFlow/Archives | custom=Basic | flow=v3 | page=Development zone}}
|
Development zone page for the v3 ecosystem releases (in archived wiki) |
Simple interwiki link (link to the "Development zone" page)
{{EcosystemFlow/Archives | custom=Basic | flow=v4 | page=Development zone}}
|
Development zone page for the v4 ecosystem releases (in archived wiki) |
Simple interwiki link (link to the "Development zone" page)
{{EcosystemFlow/Archives | custom=Basic | flow=v5 | page=Development zone}}
|
Development zone page for the v5 ecosystem releases (in archived wiki) |
Custom message for the STM32MPU distribution for Android™: no message for the current release
{{EcosystemFlow/Archives | custom=Android}}
|
3. More examples
| You type | You get |
|---|---|
Unknown custom
{{EcosystemFlow/Archives | custom=not supported | flow=v1}}
|
unknown custom |
Flow ignored in case of custom message
{{EcosystemFlow/Archives | custom=Android | flow=v1}}
|
|
Unknown flow
{{EcosystemFlow/Archives | custom=Basic| flow=v0}}
|
unknown flow |
Unspecified flow
{{EcosystemFlow/Archives | custom=Basic}}
|
unknown flow |
The targeted page doesn't exist in the targeted wiki: it is not detected (broken link)
{{EcosystemFlow/Archives | custom=Basic| flow=v1 | page=Page not supported}}
|
Page 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 v5 ecosystem releases. For information about the previous ecosystem releases, go through the Wiki archives.AFTER |
4. Code
This wiki is for the v5 ecosystem releases. For information about the previous ecosystem releases, go through the Wiki archives.