Difference between revisions of "Template:Board"

[unchecked revision] [quality revision]
m
m

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>}}
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
    • 157C-EV1: STM32MP157C-EV1 Evaluation board
    • 157F-EV1: STM32MP157F-EV1 Evaluation board
    • 157A/D-EV1: STM32MP157A-EV1 or STM32MP157D-EV1 Evaluation board
    • 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
    • 157C-DK2: STM32MP157C-DK2 Discovery kit
    • 157F-DK2: STM32MP157F-DK2 Discovery kit
    • 157A/D-DK1: STM32MP157A-DK1 or STM32MP157D-DK1 Discovery kit
    • 157C/F-DK2: STM32MP157C-DK2 or STM32MP157F-DK2 Discovery kit
    • 157x-DKx: any Discovery kit with a STM32MP157 MPU

Clicking on the More info.png icon displays the article about the board (e.g. STM32MP157x-DKx - hardware description).

2 Basic examples[edit]

You type You get
STM32MP157F-EV1 Evaluation board
{{Board | type=157F-EV1}}

STM32MP157F-EV1 Evaluation board More info green.png

STM32MP157F-DK2 Discovery kit
{{Board | type=157F-DK2}}

STM32MP157F-DK2 Discovery kit More info green.png

3 More examples[edit]

You type You get
Evaluation boards with a STM32MP157 MPU
{{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}}

STM32MP157A-EV1 Evaluation board More info green.png
STM32MP157D-EV1 Evaluation board More info green.png
STM32MP157C-EV1 Evaluation board More info green.png
STM32MP157F-EV1 Evaluation board More info green.png
STM32MP157A/D-EV1 Evaluation board More info green.png
STM32MP157C/F-EV1 Evaluation board More info green.png
STM32MP157x-EV1 Evaluation board More info green.png

Discovery kits with a STM32MP157 MPU
{{Board | type=157A-DK1}}<br>
{{Board | type=157D-DK1}}<br>
{{Board | type=157C-DK2}}<br>
{{Board | type=157F-DK2}}<br>
{{Board | type=157A/D-DK1}}<br>
{{Board | type=157C/F-DK2}}<br>
{{Board | type=157x-DKx}}

STM32MP157A-DK1 Discovery kit More info green.png
STM32MP157D-DK1 Discovery kit More info green.png
STM32MP157C-DK2 Discovery kit More info green.png
STM32MP157F-DK2 Discovery kit More info green.png
STM32MP157A/D-DK1 unknown board type identifier
STM32MP157C/F-DK2 unknown board type identifier
STM32MP157x-DKx Discovery kit More info green.png

Unspecified board
{{Board}}

STM32MP unknown board type identifier

Unknown boards
{{Board | type=153C-EV1}}<br>
{{Board | type=157C-DK3}}

STM32MP153C-EV1 unknown board type identifier
STM32MP157C-DK3 unknown board type identifier

Check that there's no space before and after the text
BEFORE{{Board | type=157C-EV1}}AFTER<br>
BEFORE{{Board | type=157C-DK2}}AFTER<br>

BEFORESTM32MP157C-EV1 Evaluation board More info green.pngAFTER
BEFORESTM32MP157C-DK2 Discovery kit More info green.pngAFTER

4 Code[edit]

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>}}}}
: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
** '''157C-EV1''': STM32MP157C-EV1 Evaluation board
** '''157F-EV1''': STM32MP157F-EV1 Evaluation board
** '''157A/D-EV1''':  STM32MP157A-EV1 or STM32MP157D-EV1 Evaluation board
** '''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
** '''157C-DK2''': STM32MP157C-DK2 Discovery kit
** '''157F-DK2''': STM32MP157F-DK2 Discovery kit
** '''157A/D-DK1''': STM32MP157A-DK1 or STM32MP157D-DK1 Discovery kit
** '''157C/F-DK2''': STM32MP157C-DK2 or STM32MP157F-DK2 Discovery kit
** '''157x-DKx''': any Discovery kit with a STM32MP157 MPU

Clicking on the <sup>[[File:More_info.png|15px|link=]]</sup> icon displays '''the article about the board''' (e.g. [[STM32MP157x-DKx - hardware description]]).

==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}}
|-
| STM32MP157F-DK2 Discovery kit<pre style="white-space: pre-wrap;">

{{Board | type=157F-DK2}}</pre>

|
{{Board | type=157F-DK2}}
|}

==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=157A/D-DK1}}<br>

{{Board | type=157C/F-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=157A/D-DK1}}<br>

{{Board | type=157C/F-DK2}}<br>

{{Board | type=157x-DKx}}
|-
| 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}}
|-
| 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>{{#vardefine:info|}}{{#switch:{{{type|}}}
| 157A-EV1 | 157D-EV1 | 157C-EV1 | 157F-EV1 | 157A/D-EV1 | 157C/F-EV1 | 157x-EV1 = {{#vardefine:typ|Evaluation board}}{{#vardefine:info|<sup>[[File:More_info.png|15px|link=STM32MP157x-EV1 - hardware description]]</sup>}} 
| 157A-DK1 | 157D-DK1 | 157C-DK2 | 157F-DK2 | 157A/D-DK1 | 157C/F-DK2 | 157x-DKx = {{#vardefine:typ|Discovery kit}}{{#vardefine:info|<sup>[[File:More_info.png|15px|link=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
 
** '''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
 
** '''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
 
** '''157C-DK2''': STM32MP157C-DK2 Discovery kit
 
** '''157C-DK2''': STM32MP157C-DK2 Discovery kit
 
** '''157F-DK2''': STM32MP157F-DK2 Discovery kit
 
** '''157F-DK2''': STM32MP157F-DK2 Discovery kit
  +
** '''157A/D-DK1''': STM32MP157A-DK1 or STM32MP157D-DK1 Discovery kit
 
** '''157C/F-DK2''': STM32MP157C-DK2 or STM32MP157F-DK2 Discovery kit
 
** '''157C/F-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
Line 47: Line 51:
 
<pre style="white-space: pre-wrap;">
 
<pre style="white-space: pre-wrap;">
 
{{Board | type=157A-EV1}}<br>
 
{{Board | type=157A-EV1}}<br>
  +
{{Board | type=157D-EV1}}<br>
 
{{Board | type=157C-EV1}}<br>
 
{{Board | type=157C-EV1}}<br>
 
{{Board | type=157F-EV1}}<br>
 
{{Board | type=157F-EV1}}<br>
  +
{{Board | type=157A/D-EV1}}<br>
 
{{Board | type=157C/F-EV1}}<br>
 
{{Board | type=157C/F-EV1}}<br>
 
{{Board | type=157x-EV1}}
 
{{Board | type=157x-EV1}}
Line 54: Line 60:
 
|
 
|
 
{{Board | type=157A-EV1}}<br>
 
{{Board | type=157A-EV1}}<br>
  +
{{Board | type=157D-EV1}}<br>
 
{{Board | type=157C-EV1}}<br>
 
{{Board | type=157C-EV1}}<br>
 
{{Board | type=157F-EV1}}<br>
 
{{Board | type=157F-EV1}}<br>
  +
{{Board | type=157A/D-EV1}}<br>
 
{{Board | type=157C/F-EV1}}<br>
 
{{Board | type=157C/F-EV1}}<br>
 
{{Board | type=157x-EV1}}
 
{{Board | type=157x-EV1}}
Line 62: Line 70:
 
<pre style="white-space: pre-wrap;">
 
<pre style="white-space: pre-wrap;">
 
{{Board | type=157A-DK1}}<br>
 
{{Board | type=157A-DK1}}<br>
  +
{{Board | type=157D-DK1}}<br>
 
{{Board | type=157C-DK2}}<br>
 
{{Board | type=157C-DK2}}<br>
 
{{Board | type=157F-DK2}}<br>
 
{{Board | type=157F-DK2}}<br>
  +
{{Board | type=157A/D-DK1}}<br>
 
{{Board | type=157C/F-DK2}}<br>
 
{{Board | type=157C/F-DK2}}<br>
 
{{Board | type=157x-DKx}}
 
{{Board | type=157x-DKx}}
Line 69: Line 79:
 
|
 
|
 
{{Board | type=157A-DK1}}<br>
 
{{Board | type=157A-DK1}}<br>
  +
{{Board | type=157D-DK1}}<br>
 
{{Board | type=157C-DK2}}<br>
 
{{Board | type=157C-DK2}}<br>
 
{{Board | type=157F-DK2}}<br>
 
{{Board | type=157F-DK2}}<br>
  +
{{Board | type=157A/D-DK1}}<br>
 
{{Board | type=157C/F-DK2}}<br>
 
{{Board | type=157C/F-DK2}}<br>
 
{{Board | type=157x-DKx}}
 
{{Board | type=157x-DKx}}
Line 103: Line 115:
 
{{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 }}
 
</noinclude>{{#vardefine:info|}}{{#switch:{{{type|}}}
 
</noinclude>{{#vardefine:info|}}{{#switch:{{{type|}}}
| 157A-EV1 | 157C-EV1 | 157F-EV1 |157C/F-EV1 | 157x-EV1 = {{#vardefine:typ|Evaluation board}}{{#vardefine:info|<sup>[[File:More_info.png|15px|link=STM32MP157x-EV1 - hardware description]]</sup>}}  
+
| 157A-EV1 | 157D-EV1 | 157C-EV1 | 157F-EV1 | 157A/D-EV1 | 157C/F-EV1 | 157x-EV1 = {{#vardefine:typ|Evaluation board}}{{#vardefine:info|<sup>[[File:More_info.png|15px|link=STM32MP157x-EV1 - hardware description]]</sup>}}  
| 157A-DK1 | 157C-DK2 | 157F-DK2 | 157C/F-DK2 | 157x-DKx = {{#vardefine:typ|Discovery kit}}{{#vardefine:info|<sup>[[File:More_info.png|15px|link=STM32MP157x-DKx - hardware description]]</sup>}}  
+
| 157A-DK1 | 157D-DK1 | 157C-DK2 | 157F-DK2 | 157A/D-DK1 | 157C/F-DK2 | 157x-DKx = {{#vardefine:typ|Discovery kit}}{{#vardefine:info|<sup>[[File:More_info.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}}