1. Usage
The STM32CubeRelease template is used to indicate for which STM32Cube 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 STM32Cube release revisions for which the entire article is valid.
It outputs a "standardized" string that might be used to name an article part.
Usage: {{STM32CubeRelease| revision=<revision> | range =<range> | revision2=<revision2>}}
Where:
- <revision> is the mandatory STM32Cube release revision for which the article part is valid.
- The possible values for this parameter are available in the STM32CubeRelease/Revision template.
- The optional <range> and <revision2> parameters allow to define a range of revisions.
- <range> is the optional range of the STM32Cube 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 STM32Cube 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.
- The possible values for this parameter are available in the STM32CubeRelease/Revision template.
- 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 icon), a popup window shows, for that revision:
- the version of the STM32CubeMP1 Package
- the version of the STM32CubeMP13 Package
- the version of the STM32CubeIDE
- the version of the STM32CubeMX
- the version of the STM32CubeProgrammer
This information comes from the STM32CubeRelease/Components template.
2. Basic examples
You type | You get |
---|---|
The latest revision
{{STM32CubeRelease| revision=latest}} |
STM32Cube release v1.17.0 |
A specific revision (revision 1.17.0)
{{STM32CubeRelease| revision=1.17.0}} |
STM32Cube release v1.17.0 |
A specific revision (revision 1.16.0)
{{STM32CubeRelease| revision=1.16.0}} |
STM32Cube release v1.16.0 |
A specific revision (revision 1.15.0)
{{STM32CubeRelease| revision=1.15.0}} |
STM32Cube release v1.15.0 |
Revisions that are lower than or equal to a revision
{{STM32CubeRelease| revision=x.1.0 | range=and before}} |
STM32Cube release ≤ vx.1.0 |
Revisions that are greater than or equal to a revision
{{STM32CubeRelease| revision=x.1.0 | range=and after}} |
STM32Cube release ≥ vx.1.0 |
Range of revisions
{{STM32CubeRelease| revision=x.0.0 | range=to | revision2=x.1.0}} |
STM32Cube release vx.0.0 to vx.1.0 |
Revisions that are lower than or equal to the latest one
{{STM32CubeRelease| revision=latest | range=and before}} |
STM32Cube release ≤ v1.17.0 |
Revisions that are greater than or equal to the latest one
{{STM32CubeRelease| revision=latest | range=and after}} |
STM32Cube release ≥ v1.17.0 |
Range of revisions
{{STM32CubeRelease| revision=x.0.0 | range=to | revision2=latest}} |
STM32Cube release vx.0.0 to v1.17.0 |
3. More examples
You type | You get |
---|---|
Revision x.2.0 (next)
{{STM32CubeRelease| revision=x.2.0}} |
STM32Cube release vx.2.0 |
Revision x.1.0 (latest)
{{STM32CubeRelease| revision=x.1.0}} |
STM32Cube release vx.1.0 |
Revision x.0.0 (legacy)
{{STM32CubeRelease| revision=x.0.0}} |
STM32Cube release vx.0.0 |
Former revision that is part of a flow that is not the one associated with this wiki.
{{STM32CubeRelease| revision=0.y.0}}<br> {{STM32CubeRelease| revision=0.y.0 | range=and before}}<br> {{STM32CubeRelease| revision=0.y.0 | range=and after}} |
STM32Cube release v0.y.0 |
Unspecified revision
{{STM32CubeRelease}} |
STM32Cube release unknown revision |
Unknown revision
{{STM32CubeRelease| revision=10.20.30}} |
STM32Cube release unknown revision 10.20.30 |
Unspecified revision2
{{STM32CubeRelease| revision=x.1.0 | range=to}} |
STM32Cube release vx.1.0 to unknown revision |
Unknown revision2
{{STM32CubeRelease| revision=x.1.0 | range=to | revision2=10.20.30}} |
STM32Cube release vx.1.0 to unknown revision 10.20.30 |
Former revision2 that is part of a flow that is not the one associated with this wiki.
{{STM32CubeRelease| revision=x.0.0 | range=to | revision2=0.y.0}}<br> {{STM32CubeRelease| revision=0.y.0 | range=to | revision2=0.y.0}} |
STM32Cube release vx.0.0 to v0.y.0 |
Ignored revision2
{{STM32CubeRelease| revision=x.0.0 | range=and after | revision2=x.1.0}} |
STM32Cube release ≥ vx.0.0 |
Unknown range
{{STM32CubeRelease| revision=x.1.0 | range=error}} |
STM32Cube release vx.1.0 unknown range error |
Check that there's no space before and after the text
BEFORE{{STM32CubeRelease| revision=x.0.0}}AFTER<br> BEFORE{{STM32CubeRelease| revision=x.1.0 | range=and before}}AFTER<br> BEFORE{{STM32CubeRelease| revision=x.1.0 | range=and after}}AFTER<br> BEFORE{{STM32CubeRelease| revision=x.0.0 | range=to | revision2=x.1.0}}AFTER |
BEFORESTM32Cube release vx.0.0 AFTER |
4. Code
STM32Cube release unknown revision