Approved version. Approved on: 09:22, 2 October 2020
You are viewing an old version of this page. Return to the latest version.
Difference between revisions of "Template:Board"
[quality revision] | [quality revision] |
m
|
m
|
Contents
1 Usage[edit]
The Board template is used to indicate for which board(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 boards for which the entire article is valid.
It outputs a "standardized" string that might be used to name an article part.
Usage: {{Board | type=<type> | name=<name>}}
- Where:
-
<type> is the mandatory identifier of the board type. The possible values are (see also the part number codification for the STM32MP15 MPUs):
- 157A-EV1: STM32MP157A-EV1 Evaluation board
- 157D-EV1: STM32MP157D-EV1 Evaluation board (June 2020: not available)
- 157C-EV1: STM32MP157C-EV1 Evaluation board
- 157F-EV1: STM32MP157F-EV1 Evaluation board
- 157A/D-EV1: STM32MP157A-EV1 or STM32MP157D-EV1 Evaluation board (June 2020: STM32MP157D-EV1 not available)
- 157C/F-EV1: STM32MP157C-EV1 or STM32MP157F-EV1 Evaluation board
- 157x-EV1: any Evaluation board with a STM32MP157 MPU
- 157A-DK1: STM32MP157A-DK1 Discovery kit
- 157D-DK1: STM32MP157A-DK1 Discovery kit (June 2020: not available)
- 157C-DK2: STM32MP157C-DK2 Discovery kit
- 157F-DK2: STM32MP157F-DK2 Discovery kit (June 2020: not available)
- 157x-DK1: STM32MP157A-DK1 or STM32MP157D-DK1 Discovery kit (June 2020: STM32MP157D-DK1 not available)
- 157x-DK2: STM32MP157C-DK2 or STM32MP157F-DK2 Discovery kit (June 2020: STM32MP157F-DK2 not available)
- 157x-DKx: any Discovery kit with a STM32MP157 MPU
-
<name> is the optional parameter that allows to select the way the board name is displayed. Per default (if <name> is not set), the full board name (i.e. including "Evaluation board" or "Discovery kit") is displayed. The possible value for <name> is:
- short: the short board name (i.e without "Evaluation board" and "Discovery kit") is displayed
The icon indicates that the board is already available, and clicking on this icon links to the article about the boards hardware description (e.g. STM32MP157x-DKx - hardware description).
The icon indicates that the board is currently not available.
2 Basic examples[edit]
You type | You get |
---|---|
STM32MP157F-EV1 Evaluation board {{Board | type=157F-EV1}} |
|
STM32MP157C-DK2 Discovery kit {{Board | type=157C-DK2}} |
|
STM32MP157C-EV1 {{Board | type=157C-EV1 | name=short}} |
|
STM32MP157A-DK1 {{Board | type=157A-DK1 | name=short}} |
3 More examples[edit]
4 Code[edit]
Example :
{{#vardefine:info|}}{{#vardefine:typ|}}{{#switch:{{{type|}}}
| 157A-EV1 | 157C-EV1 | 157F-EV1 | 157C/F-EV1 | 157x-EV1= {{#ifeq: {{{name}}} | short | | {{#vardefine:typ| Evaluation board}}}}{{#vardefine:info|<sup>[[File:More_info_green.png|15px|link=STM32MP157x-EV1 - hardware description]]</sup>}}
| 157D-EV1 | 157A/D-EV1 = {{#ifeq: {{{name}}} | short | | {{#vardefine:typ| Evaluation board}}}}{{#vardefine:info|<span title="STM32MP157D-EV1 not available"><sup>[[File:Warning.png|15px|link=]]</sup></span>}}
[[File:Warning.png|15px|link=]]</sup></span>}}
STM32MP unknown board type identifier
<noinclude> ==Usage== The [[Template:Board|Board]] template is used '''to indicate for which board(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 boards for which the entire article is valid. It outputs a "standardized" string that might be used to name an article part. Usage: <nowiki>{{</nowiki>Board | type={{HighlightParam|<type>}} | name={{HighlightParam|<name>}}}} :Where: * {{HighlightParam|<type>}} is the '''mandatory''' identifier of the board type. The possible values are (see also the [[STM32MP15 microprocessor#Part number codification|part number codification]] for the STM32MP15 MPUs): ** '''157A-EV1''': STM32MP157A-EV1 Evaluation board ** '''157D-EV1''': STM32MP157D-EV1 Evaluation board (June 2020: not available) ** '''157C-EV1''': STM32MP157C-EV1 Evaluation board ** '''157F-EV1''': STM32MP157F-EV1 Evaluation board ** '''157A/D-EV1''': STM32MP157A-EV1 or STM32MP157D-EV1 Evaluation board(June 2020: STM32MP157D-EV1 not available)** '''157C/F-EV1''': STM32MP157C-EV1 or STM32MP157F-EV1 Evaluation board ** '''157x-EV1''': any Evaluation board with a STM32MP157 MPU ** '''157A-DK1''': STM32MP157A-DK1 Discovery kit ** '''157D-DK1''': STM32MP157A-DK1 Discovery kit (June 2020: not available) ** '''157C-DK2''': STM32MP157C-DK2 Discovery kit ** '''157F-DK2''': STM32MP157F-DK2 Discovery kit(June 2020: not available)** '''157x-DK1''': STM32MP157A-DK1 or STM32MP157D-DK1 Discovery kit(June 2020: STM32MP157D-DK1 not available)** '''157x-DK2''': STM32MP157C-DK2 or STM32MP157F-DK2 Discovery kit(June 2020: STM32MP157F-DK2 not available)** '''157x-DKx''': any Discovery kit with a STM32MP157 MPU * {{HighlightParam|<name>}} is the '''optional''' parameter that allows to select the way the board name is displayed. Per default (if {{HighlightParam|<name>}} is not set), the full board name (i.e. including "Evaluation board" or "Discovery kit") is displayed. The possible value for {{HighlightParam|<name>}} is: ** '''short''': the short board name (i.e without "Evaluation board" and "Discovery kit") is displayed The <sup>[[File:More_info_green.png|15px|link=]]</sup> icon indicates that the board is already available, and clicking on this icon links to '''the article about the boards hardware description''' (e.g. [[STM32MP157x-DKx - hardware description]]). The <sup>[[File:Warning.png|15px|link=]]</sup> icon indicates that the board is currently not available. ==Basic examples== {| class="st-table" ! style="width: 50%;" | You type !! You get |- | STM32MP157F-EV1 Evaluation board<pre style="white-space: pre-wrap;"> {{Board | type=157F-EV1}}</pre> | {{Board | type=157F-EV1}} |- | STM32MP157C-DK2 Discovery kit<pre style="white-space: pre-wrap;"> {{Board | type=157C-DK2}}</pre> | {{Board | type=157C-DK2}} |- | STM32MP157C-EV1<pre style="white-space: pre-wrap;"> {{Board | type=157C-EV1 | name=short}}</pre> | {{Board | type=157C-EV1 | name=short}} |- | STM32MP157A-DK1<pre style="white-space: pre-wrap;"> {{Board | type=157A-DK1 | name=short}}</pre> | {{Board | type=157A-DK1 | name=short}} |} ==More examples== {| class="st-table" ! style="width: 50%;" | You type !! You get |- | Evaluation boards with a STM32MP157 MPU<pre style="white-space: pre-wrap;"> {{Board | type=157A-EV1}}<br> {{Board | type=157D-EV1}}<br> {{Board | type=157C-EV1}}<br> {{Board | type=157F-EV1}}<br> {{Board | type=157A/D-EV1}}<br> {{Board | type=157C/F-EV1}}<br> {{Board | type=157x-EV1}}</pre> | {{Board | type=157A-EV1}}<br> {{Board | type=157D-EV1}}<br> {{Board | type=157C-EV1}}<br> {{Board | type=157F-EV1}}<br> {{Board | type=157A/D-EV1}}<br> {{Board | type=157C/F-EV1}}<br> {{Board | type=157x-EV1}} |- | Discovery kits with a STM32MP157 MPU<pre style="white-space: pre-wrap;"> {{Board | type=157A-DK1}}<br> {{Board | type=157D-DK1}}<br> {{Board | type=157C-DK2}}<br> {{Board | type=157F-DK2}}<br> {{Board | type=157x-DK1}}<br> {{Board | type=157x-DK2}}<br> {{Board | type=157x-DKx}}</pre> | {{Board | type=157A-DK1}}<br> {{Board | type=157D-DK1}}<br> {{Board | type=157C-DK2}}<br> {{Board | type=157F-DK2}}<br> {{Board | type=157x-DK1}}<br> {{Board | type=157x-DK2}}<br> {{Board | type=157x-DKx}} |- | Evaluation boards with a STM32MP157 MPU: short name<pre style="white-space: pre-wrap;"> {{Board | type=157A-EV1 | name=short}}<br> {{Board | type=157D-EV1 | name=short}}<br> {{Board | type=157C-EV1 | name=short}}<br> {{Board | type=157F-EV1 | name=short}}<br> {{Board | type=157A/D-EV1 | name=short}}<br> {{Board | type=157C/F-EV1 | name=short}}<br> {{Board | type=157x-EV1 | name=short}}</pre> | {{Board | type=157A-EV1 | name=short}}<br> {{Board | type=157D-EV1 | name=short}}<br> {{Board | type=157C-EV1 | name=short}}<br> {{Board | type=157F-EV1 | name=short}}<br> {{Board | type=157A/D-EV1 | name=short}}<br> {{Board | type=157C/F-EV1 | name=short}}<br> {{Board | type=157x-EV1 | name=short}} |- | Discovery kits with a STM32MP157 MPU: short name<pre style="white-space: pre-wrap;"> {{Board | type=157A-DK1 | name=short}}<br> {{Board | type=157D-DK1 | name=short}}<br> {{Board | type=157C-DK2 | name=short}}<br> {{Board | type=157F-DK2 | name=short}}<br> {{Board | type=157x-DK1 | name=short}}<br> {{Board | type=157x-DK2 | name=short}}<br> {{Board | type=157x-DKx | name=short}}</pre> | {{Board | type=157A-DK1 | name=short}}<br> {{Board | type=157D-DK1 | name=short}}<br> {{Board | type=157C-DK2 | name=short}}<br> {{Board | type=157F-DK2 | name=short}}<br> {{Board | type=157x-DK1 | name=short}}<br> {{Board | type=157x-DK2 | name=short}}<br> {{Board | type=157x-DKx | name=short}} |- | Unspecified board<pre style="white-space: pre-wrap;"> {{Board}}</pre> | {{Board}} |- | Unknown boards<pre style="white-space: pre-wrap;"> {{Board | type=153C-EV1}}<br> {{Board | type=157C-DK3}}</pre> | {{Board | type=153C-EV1}}<br> {{Board | type=157C-DK3}} |- | Unknown value for {{HighlightParam|<name>}}<pre style="white-space: pre-wrap;"> {{Board | type=157C-EV1 | name=long}}<br> {{Board | type=157C-EV1 | name=}}</pre> | {{Board | type=157C-EV1 | name=long}}<br> {{Board | type=157C-EV1 | name=}} |- | Check that there's no space before and after the text<pre style="white-space: pre-wrap;"> BEFORE{{Board | type=157C-EV1}}AFTER<br> BEFORE{{Board | type=157C-DK2}}AFTER<br> </pre> | BEFORE{{Board | type=157C-EV1}}AFTER<br> BEFORE{{Board | type=157C-DK2}}AFTER<br> |} ==Code== {{UpdateNeededForNewBoard| Add the new board in the code below and in the list of the possible values above.Make sure that the [[Contributors:Formatting#Lead_section|Lead section]] is available for all referenced articles }}</noinclude>Example :<pre> {{#vardefine:info|}}{{#vardefine:typ|}}{{#switch:{{{type|}}} | 157A-EV1 | 157C-EV1 | 157F-EV1 | 157C/F-EV1 | 157x-EV1 = {{#ifeq: {{{name}}} | short | | {{#vardefine:typ| Evaluation board}}}}{{#vardefine:info|<sup>[[File:More_info_green.png|15px|link=STM32MP157x-EV1 - hardware description]]</sup>}} | 157D-EV1 | 157A/D-EV1 = {{#ifeq: {{{name}}} | short | | {{#vardefine:typ| Evaluation board}}}}{{#vardefine:info|<span title="STM32MP157D-EV1 not available"><sup>[[File:Warning.png|15px|link=]]</sup></span>}}| 157A-DK1 | 157C-DK2 | 157x-DKx[[File:Warning.png|15px|link=]]</sup></span>}}</pre> </noinclude>{{#vardefine:info|}}{{#vardefine:typ|}}{{#switch:{{{type|}}} | 157A-EV1 | 157D-EV1 | 157A/D-EV1 | 157C-EV1 | 157F-EV1 |157C/F-EV1 | 157x-EV1 = {{#ifeq: {{{name}}} | short | | {{#vardefine:typ| Discovery kitEvaluation board}}}}{{#vardefine:info|<sup>[[File:More_info_green.png|15px|link=STM32MP157x-DKxEV1 - hardware description]]</sup>}} | 157D157A-DK1 | 157x157D-DK1 = {{#ifeq: {{{name}}} | short | | {{#vardefine:typ| Discovery kit}}}}{{#vardefine:info|<span title="STM32MP157D-DK1 not available"><sup>[[File:Warning.png|15px|link=]]</sup></span>}} | 157F-DK2 | 157x-DK2 | 157C-DK2 | 157F-DK2 | 157x-DK2 | 157x-DK1 | 157x-DKx = {{#ifeq: {{{name}}} | short | | {{#vardefine:typ| Discovery kit}}}}{{#vardefine:info|<span title="STM32MP157F-DK2 not available"><sup>[[File:WarningMore_info_green.png|15px|link=]]</sup></span>STM32MP157x-DKx - hardware description]]</sup>}} | #default = {{#vardefine:typ|{{Highlight| unknown board type identifier}}}} }}STM32MP{{{type|}}}{{#var:typ}} {{#var:info}}
Line 9: | Line 9: | ||
* {{HighlightParam|<type>}} is the '''mandatory''' identifier of the board type. The possible values are (see also the [[STM32MP15 microprocessor#Part number codification|part number codification]] for the STM32MP15 MPUs): |
* {{HighlightParam|<type>}} is the '''mandatory''' identifier of the board type. The possible values are (see also the [[STM32MP15 microprocessor#Part number codification|part number codification]] for the STM32MP15 MPUs): |
||
** '''157A-EV1''': STM32MP157A-EV1 Evaluation board |
** '''157A-EV1''': STM32MP157A-EV1 Evaluation board |
||
− | ** '''157D-EV1''': STM32MP157D-EV1 Evaluation board |
+ | ** '''157D-EV1''': STM32MP157D-EV1 Evaluation board |
** '''157C-EV1''': STM32MP157C-EV1 Evaluation board |
** '''157C-EV1''': STM32MP157C-EV1 Evaluation board |
||
** '''157F-EV1''': STM32MP157F-EV1 Evaluation board |
** '''157F-EV1''': STM32MP157F-EV1 Evaluation board |
||
− | ** '''157A/D-EV1''': STM32MP157A-EV1 or STM32MP157D-EV1 Evaluation board |
+ | ** '''157A/D-EV1''': STM32MP157A-EV1 or STM32MP157D-EV1 Evaluation board |
** '''157C/F-EV1''': STM32MP157C-EV1 or STM32MP157F-EV1 Evaluation board |
** '''157C/F-EV1''': STM32MP157C-EV1 or STM32MP157F-EV1 Evaluation board |
||
** '''157x-EV1''': any Evaluation board with a STM32MP157 MPU |
** '''157x-EV1''': any Evaluation board with a STM32MP157 MPU |
||
** '''157A-DK1''': STM32MP157A-DK1 Discovery kit |
** '''157A-DK1''': STM32MP157A-DK1 Discovery kit |
||
− | ** '''157D-DK1''': STM32MP157A-DK1 Discovery kit |
+ | ** '''157D-DK1''': STM32MP157A-DK1 Discovery kit |
** '''157C-DK2''': STM32MP157C-DK2 Discovery kit |
** '''157C-DK2''': STM32MP157C-DK2 Discovery kit |
||
− | ** '''157F-DK2''': STM32MP157F-DK2 Discovery kit |
+ | ** '''157F-DK2''': STM32MP157F-DK2 Discovery kit |
− | ** '''157x-DK1''': STM32MP157A-DK1 or STM32MP157D-DK1 Discovery kit |
+ | ** '''157x-DK1''': STM32MP157A-DK1 or STM32MP157D-DK1 Discovery kit |
− | ** '''157x-DK2''': STM32MP157C-DK2 or STM32MP157F-DK2 Discovery kit |
+ | ** '''157x-DK2''': STM32MP157C-DK2 or STM32MP157F-DK2 Discovery kit |
** '''157x-DKx''': any Discovery kit with a STM32MP157 MPU |
** '''157x-DKx''': any Discovery kit with a STM32MP157 MPU |
||
* {{HighlightParam|<name>}} is the '''optional''' parameter that allows to select the way the board name is displayed. Per default (if {{HighlightParam|<name>}} is not set), the full board name (i.e. including "Evaluation board" or "Discovery kit") is displayed. The possible value for {{HighlightParam|<name>}} is: |
* {{HighlightParam|<name>}} is the '''optional''' parameter that allows to select the way the board name is displayed. Per default (if {{HighlightParam|<name>}} is not set), the full board name (i.e. including "Evaluation board" or "Discovery kit") is displayed. The possible value for {{HighlightParam|<name>}} is: |
||
Line 179: | Line 179: | ||
==Code== |
==Code== |
||
{{UpdateNeededForNewBoard| Add the new board in the code below and in the list of the possible values above.Make sure that the [[Contributors:Formatting#Lead_section|Lead section]] is available for all referenced articles }} |
{{UpdateNeededForNewBoard| Add the new board in the code below and in the list of the possible values above.Make sure that the [[Contributors:Formatting#Lead_section|Lead section]] is available for all referenced articles }} |
||
+ | Example : |
||
+ | <pre> |
||
+ | {{#vardefine:info|}}{{#vardefine:typ|}}{{#switch:{{{type|}}} |
||
+ | | 157A-EV1 | 157C-EV1 | 157F-EV1 | 157C/F-EV1 | 157x-EV1= {{#ifeq: {{{name}}} | short | | {{#vardefine:typ| Evaluation board}}}}{{#vardefine:info|<sup>[[File:More_info_green.png|15px|link=STM32MP157x-EV1 - hardware description]]</sup>}} |
||
+ | | 157D-EV1 | 157A/D-EV1 = {{#ifeq: {{{name}}} | short | | {{#vardefine:typ| Evaluation board}}}}{{#vardefine:info|<span title="STM32MP157D-EV1 not available"><sup>[[File:Warning.png|15px|link=]]</sup></span>}} |
||
+ | [[File:Warning.png|15px|link=]]</sup></span>}} |
||
+ | </pre> |
||
+ | |||
</noinclude>{{#vardefine:info|}}{{#vardefine:typ|}}{{#switch:{{{type|}}} |
</noinclude>{{#vardefine:info|}}{{#vardefine:typ|}}{{#switch:{{{type|}}} |
||
− | | 157A-EV1 | 157C-EV1 | 157F-EV1 | 157C/F-EV1 | 157x-EV1 = {{#ifeq: {{{name}}} | short | | {{#vardefine:typ| Evaluation board}}}}{{#vardefine:info|<sup>[[File:More_info_green.png|15px|link=STM32MP157x-EV1 - hardware description]]</sup>}} |
+ | | 157A-EV1 | 157D-EV1 | 157A/D-EV1 | 157C-EV1 | 157F-EV1 |157C/F-EV1 | 157x-EV1 = {{#ifeq: {{{name}}} | short | | {{#vardefine:typ| Evaluation board}}}}{{#vardefine:info|<sup>[[File:More_info_green.png|15px|link=STM32MP157x-EV1 - hardware description]]</sup>}} |
− | | 157D- |
+ |
| 157A-DK1 | 157D-DK1 | 157C-DK2 | 157F-DK2 | 157x-DK2 | 157x-DK1 | 157x-DKx = {{#ifeq: {{{name}}} | short | | {{#vardefine:typ| Discovery kit}}}}{{#vardefine:info|<sup>[[File:More_info_green.png|15px|link=STM32MP157x-DKx - hardware description]]</sup>}} |
− | |||
− | |||
− | |||
| #default = {{#vardefine:typ|{{Highlight| unknown board type identifier}}}} |
| #default = {{#vardefine:typ|{{Highlight| unknown board type identifier}}}} |
||
}}STM32MP{{{type|}}}{{#var:typ}} {{#var:info}} |
}}STM32MP{{{type|}}}{{#var:typ}} {{#var:info}} |