MultipleTemplatesForPerformanceTests

Templates may be created in the STM32 MPU wiki pages.

A lot of information about the templates can be found in MediaWiki Help:Templates page^[1], and in Wikipedia Help:Template page^[2]. Therefore, this article focuses on the templates created for this wiki.

Information

The help and syntax page is the master help page.
Use the sandbox page to validate your syntax.
Templates test is the associated test page.

1. Golden rules for STM32 wiki[edit | edit source]↑

The basic principles that should be followed, are summarized here and detailed later:

Contributors:Templates
Learn what are the so-called protected templates
Take a look at the supported templates

2. Generalities[edit | edit source]↑

Templates are pages whose content is designed to be included (embedded) in other pages. Templates contain repetitive material that is needed in several pages: message boxes (e.g. Template:Warning), formatting (e.g. Template:Highlight), package versions (e.g. Template:CodeSource) etc.

A template page belongs to the Template namespace. All templates available in the wiki are listed here, and most of them are described below.

Templates called public are useful for any reader (message boxes, formatting...), while templates called internal only have interest for logged-in users who have writing permissions (mainly to share on wiki maintenance operations).

2.1. Creating a template[edit | edit source]↑

Only logged-in users who have system permissions, can create or edit templates.

A template page is created or edited in the same way an article is created or edited. The only difference is that its name is prefixed by Template:.

Additional rules for template pages:

Template name (e.g. "ArticleToDelete", "Warning")
- it might be composed of several words
- the first character of each word is in uppercase; other characters are in lowercase, excepting if the word is an abbreviation (e.g; in "STDarkGreen", "ST" stands for STMicroelectronics)
Templates should contain at least the chapters shown below. The "Usage" and "Basic examples" chapters might be transcluded in help pages.

<noinclude>
==Usage==
[...]

==Basic examples==
{| class="st-table"
! You type !! You get
|-
| Common usage of the template
|
|}

==More examples==
{| class="st-table"
! You type !! You get
|-
| Other usages of the template
|
|-
| Other usages of the template
|
|}

==Maintenance==
Precise here in which wiki the template must be modified.


==Code==
</noinclude>
[...]

Formatting rules for templates that create message boxes:
- Thin left borders identify public templates (e.g. Template:Warning), while large left borders refer to internal templates (e.g. Template:ArticleToDelete)
- Pink borders and icons are for requests (e.g. Template:ArticleToDelete) or important information (e.g Template:Warning)
- Dark blue borders and icons are for public information (e.g. Template:Info)
- Light blue borders and icons are for internal information (e.g. Template:PublicationRequestId)

2.2. Using a template[edit | edit source]↑

The most common method of template inclusion is called transclusion: the wikitext of the page that uses the template contains a reference to the template, and when that page is rendered, this reference is dynamically replaced by the content of the template. The reference is unchanged in the page wikitext. So, later changes to the template page are propagated to this page. It is the recommended method to include templates. To transclude a template whose name is <template name>, simply add the following text:

{{<template name>}}

Another method is called substitution : the reference to the template in the wikitext is replaced once and for all with the content of of the template when the page is saved. The template reference is substituted by a copy of the template content. So, later changes to the template page are not propagated to this page. To substitute a template whose name is <template name>, simply add the following text:

{{subst:<template name>}}

You type You get

Transclusion

The [[Template:Warning|Warning]] template is transcluded:<br />
{{Warning}}
If you edit this page, you will see <code>{{Warning}}</code> above

The Warning template is transcluded:

Warning

Please read carefully

If you edit this page, you will see {{Warning}} above

Substitution

The [[Template:Warning|Warning]] template is substituted:<br />
{{subst:Warning}}
The rendering is the same as for transclusion, but if you edit this page, you will see the warning message box above instead of <code>{{Warning}}</code>

The Warning template is substituted:

Please read carefully

The rendering is the same as for transclusion, but if you edit this page, you will see the warning message box above instead of {{Warning}}

Attempting to include a template that does not exist produces a red link: following this link is a good method to create that particular template.

2.3. Modifying a template[edit | edit source]↑

Some templates are common to all ST wikis. Maintenance/modification of such templates and of their associated ProtectedTemplate (when any) must be done in the WikiModel wiki. They must be approved by maintainer of all ST wikis. Then, modified and approved templates must be pushed/merged to all other wikis. Below, the list of concerned templates :

Some templates are dedicated to a particular wiki for special usage. They must be modified and reviewed in the concerned online wiki and, once approved, pushed/merged to derivated wikis.
Below, templates dedicated to stm32mpu wikis :

Some templates, dedicated to stm32mpu wikis, could be useful, after adaptations, to other wikis

Following templates are automatically created, update is not needed

2.4. Linking to a template[edit | edit source]↑

To create a link to a template, surround its full name (i.e. including the namespace) by double square brackets ([[ and ]]) :

You type	You get
Linking to the "ArticleToDelete" template This is a link to the [[Template:ArticleToDelete]].	This is a link to the Template:ArticleToDelete.
Changing the the link text This is a link to the [[Template:ArticleToDelete\|template used to request the deletion of a page]] .	This is a link to the template used to request the deletion of a page .

2.5. Parameters[edit | edit source]↑

Parameters might be passed to a template when it is transcluded: they allow the template to produce different contents or have different behaviors. In the template, each parameter is surrounded by three braces: {{{ and }}}. When using the template on a page, the parameter values are filled in, separated by a "pipe" character |. MediaWiki allows parameters might be passed to the template in three ways: anonymous, numbered or named.

Let's consider a template "TestTemplate" that needs 2 parameters, a <message> and a <signature>. Depending on the way the template is written, the parameters might be passed as follows:

You type

Parameters received by the template

Anonymous parameters

{{TestTemplate|Here is my message|Here is my signature}}

{{{1}}} = Here is my message
{{{2}}} = Here is my signature

Numbered parameters

{{TestTemplate|2=Here is my signature|1=Here is my message}}

{{{1}}} = Here is my message
{{{2}}} = Here is my signature

Named parameters

{{TestTemplate|signature=Here is my signature|message=Here is my message}}

{{{message}}} = Here is my message
{{{signature}}} = Here is my signature

2.6. Templates and special characters[edit | edit source]↑

Parameters of templates must not contain the "=" and "|" characters . Therefore, these characters must be replaced by their HTML equivalent, or by special templates:

You type

You get

Do not use the "=" and "|" characters in templates

{{Warning|Problem with the "=" and "|" characters in the "Warning" template}}

Warning

" characters in the "Warning" template

Instead, use their HTML equivalent in templates

{{Warning|Solution with their HTML equivalent, "&#0061;" and "&#0124;" in the "Warning" template}}

Warning

Solution with their HTML equivalent, "=" and "|" in the "Warning" template

Or, use the dedicated magic words or templates

{{Warning|Solution with magic words or templates, "{{=}}" and "{{!}}" in the "Warning" template}}

Warning

Solution with magic words or templates, "=" and "|" in the "Warning" template

However, on top of this basic rule, there are more complicated situations (e.g. inserting a table in a non-secure template) that in addition depend on whether a non-secure or secure template is used: the Templates test article lists all these situations.

3. Protected templates[edit | edit source]↑

Protected templates (a.k.a. secure templates) are designed so that they are evaluated only for logged-in users who have writing permissions. In other words, the reference to a protected template in a page is dynamically replaced by the content of this template at the time that page is loaded, only if the reader has signed up and has the wring permissions . Otherwise, the reference to a protected template is replaced by nothing.

Warning

However, do not put any confidential information in the parameters of protected templates: even if there is no rendering, the wikitext might be read.

Classic templates are sometimes called non-secure templates to differentiate them from the protected templates.

A protected template page belongs to the ProtectedTemplate namespace. The syntax to use a protected template is as follows:

{{#tag:secureTransclude||
src=ProtectedTemplate:<protected template name>|
params=<parameters>
}}

Where <parameters> is the list of parameters separated by "pipe" magic words {{!}}.

A protected template page must belongs to the "SecureTransclusion" category:

<noinclude>
[[category:SecureTransclusion]]
</noinclude>

You type	You get (if you signed up with ST editor permissions. Else, nothing is rendered)
Protected template {{#tag:secureTransclude\|\| src=ProtectedTemplate:PublicationRequestId\| params=12345 {{!}} 2019-05-09 {{!}} }}

To ease the usage of protected templates in pages, non-secure templates are created to encapsulate the call to the protected templates.

You type	You get (if you signed up with ST editor permissions. Else, nothing is rendered)
Classic template that calls the protected template {{#tag:secureTransclude\|\| src=ProtectedTemplate:PublicationRequestId\| params={{{1\|}}} {{!}} {{{2\|}}} {{!}} {{{3\|}}} }}
Page that calls the classic template {{PublicationRequestId \| 12345 \| 2019-05-09}}

3.1. Protected templates and categories[edit | edit source]↑

Automatically assigning a page to a category through a template is often used. For example, if a page uses the ArticleToRename template, it is automatically assigned to the Candidates for renaming category.

It is not possible to achieve this automatic assignment through a protected template for a security reason.

The solution is to go through a non-secure template that makes the assignment to a category and that calls a secure template that makes the secure operations. For example, the FileSource template assigns any page that uses it, to the File source category, and calls the FileSource protected template. With this solution, any reader is able to see the list of all articles that are assigned to the category: it means that this solution is applicable if showing this list doesn’t communicate confidential information.

4. Supported templates[edit | edit source]↑

Most of the templates and protected templates available in the wiki are described in the next chapters.

4.1. Templates for editing[edit | edit source]↑

Indicating that a page (or part of a page) is under construction (not ready yet)
Public - Unprotected
Template common to all ST wikis

Template:UnderConstruction

4.2. Templates for formatting[edit | edit source]↑

Warning on a particularly important point
Public - Unprotected
Template common to all ST wikis

Template:Warning

You type

You get

Warning without specific warning message

{{Warning}}

Warning

Please read carefully

Warning with specific warning message

{{Warning | Please respect the order of the below actions. Just after, link is displayed to test the background color when link is displayed: [[Main Page]]}}

Warning

Please respect the order of the below actions. Just after, link is displayed to test the background color when link is displayed: Main Page

Drawing attention to a particularly important point
Public - Unprotected
Template common to all ST wikis

Template:Info

You type

You get

Info without specific info message

{{Info}}

Information

Info

Info with specific Info message

{{Info | Note that the below actions are optional but recommended. Just after, link is displayed to test the background color when link is displayed: [[Main Page]]}}

Information

Note that the below actions are optional but recommended. Just after, link is displayed to test the background color when link is displayed: Main Page

Drawing attention to information related to the Android™ distribution
Public - Unprotected
Template specific to stm32mpu wiki

Template:Android

You type

You get

Android without specific message

{{Android}}

Below information is related to the Android™ distribution

Android with specific message

{{Android | Note that the following packages are required to build an environment for Android™}}

Below information is related to the Android™ distribution
Note that the following packages are required to build an environment for Android™

Highlighting important information
Public - Unprotected
Template common to all ST wikis

Template:Highlight

You type	You get
Highlighting important information The commands only apply {{Highlight\|for versions up to x.y}}, and it is {{Highlight\|mandatory}} to execute them	The commands only apply for versions up to x.y, and it is mandatory to execute them

Highlighting parameters, values or options that must be set, for example in commands
Public - Unprotected
Template common to all ST wikis

Template:HighlightParam

You type

You get

Highlighting parameter, value or option

To change the current console {{HighlightParam|<loglevel>}}, simply write to this file:
 {{Board$}} echo {{HighlightParam|<loglevel>}} > /proc/sys/kernel/printk

To change the current console <loglevel>, simply write to this file:

 echo <loglevel> > /proc/sys/kernel/printk

Coloring text with the STMicroelectronics corporate secondary color shade of dark green (█)
Public - Unprotected
Template common to all ST wikis

Template:STDarkGreen

You type	You get
Coloring text in dark green This is a {{STDarkGreen\|STMicroelectronics corporate color: shade of dark green: █}}	This is a STMicroelectronics corporate color: shade of dark green: █
Coloring text in 75% tint of dark green This is a {{STDarkGreen\|STMicroelectronics corporate color: 75% tint of dark green: █ \| tint=75}}	This is a STMicroelectronics corporate color: 75% tint of dark green: █
Coloring text in 50% tint of dark green This is a {{STDarkGreen\|STMicroelectronics corporate color: 50% tint of dark green: █ \| tint=50}}	This is a STMicroelectronics corporate color: 50% tint of dark green: █
Coloring text in 25% tint of dark green This is a {{STDarkGreen\|STMicroelectronics corporate color: 25% tint of dark green: █ \| tint=25}}	This is a STMicroelectronics corporate color: 25% tint of dark green: █
Getting the hexadecimal code of the color {{STDarkGreen}} is the hexadecimal code of STMicroelectronics dark green.	#04572F is the hexadecimal code of STMicroelectronics dark green.
Getting the hexadecimal code of the 75% tint of the color {{STDarkGreen \| tint=75}} is the hexadecimal code of STMicroelectronics 75% tint of dark green.	#438163 is the hexadecimal code of STMicroelectronics 75% tint of dark green.
Getting the hexadecimal code of the 50% tint of the color {{STDarkGreen \| tint=50}} is the hexadecimal code of STMicroelectronics 50% tint of dark green.	#81AB97 is the hexadecimal code of STMicroelectronics 50% tint of dark green.
Getting the hexadecimal code of the 25% tint of the color {{STDarkGreen \| tint=25}} is the hexadecimal code of STMicroelectronics 25% tint of dark green.	#BDD3C8 is the hexadecimal code of STMicroelectronics 25% tint of dark green.

Coloring text with the STMicroelectronics corporate primary color shade of dark blue (█)
Public - Unprotected
Template common to all ST wikis

Template:STDarkBlue

You type	You get
Coloring text in dark blue This is a {{STDarkBlue\|STMicroelectronics corporate color: shade of dark blue: █}}	This is a STMicroelectronics corporate color: shade of dark blue: █
Coloring text in 75% tint of dark blue This is a {{STDarkBlue\|STMicroelectronics corporate color: 75% tint of dark blue: █ \| tint=75}}	This is a STMicroelectronics corporate color: 75% tint of dark blue: █
Coloring text in 50% tint of dark blue This is a {{STDarkBlue\|STMicroelectronics corporate color: 50% tint of dark blue: █ \| tint=50}}	This is a STMicroelectronics corporate color: 50% tint of dark blue: █
Coloring text in 25% tint of dark blue This is a {{STDarkBlue\|STMicroelectronics corporate color: 25% tint of dark blue: █ \| tint=25}}	This is a STMicroelectronics corporate color: 25% tint of dark blue: █
Getting the hexadecimal code of the color {{STDarkBlue}} is the hexadecimal code of STMicroelectronics dark blue.	#03234B is the hexadecimal code of STMicroelectronics dark blue.
Getting the hexadecimal code of the 75% tint of the color {{STDarkBlue \| tint=75}} is the hexadecimal code of STMicroelectronics 75% tint of dark blue.	#425A78 is the hexadecimal code of STMicroelectronics 75% tint of dark blue.
Getting the hexadecimal code of the 50% tint of the color {{STDarkBlue \| tint=50}} is the hexadecimal code of STMicroelectronics 50% tint of dark blue.	#8191A5 is the hexadecimal code of STMicroelectronics 50% tint of dark blue.
Getting the hexadecimal code of the 25% tint of the color {{STDarkBlue \| tint=25}} is the hexadecimal code of STMicroelectronics 25% tint of dark blue.	#BDC5D0 is the hexadecimal code of STMicroelectronics 25% tint of dark blue.

Coloring text with the STMicroelectronics corporate primary color shade of yellow (█)
Public - Unprotected
Template common to all ST wikis

Template:STYellow

You type	You get
Coloring text in yellow This is a {{STYellow\|STMicroelectronics corporate color: shade of yellow: █}}	This is a STMicroelectronics corporate color: shade of yellow: █
Coloring text in 75% tint of yellow This is a {{STYellow\|STMicroelectronics corporate color: 75% tint of yellow: █ \| tint=75}}	This is a STMicroelectronics corporate color: 75% tint of yellow: █
Coloring text in 50% tint of yellow This is a {{STYellow\|STMicroelectronics corporate color: 50% tint of yellow: █ \| tint=50}}	This is a STMicroelectronics corporate color: 50% tint of yellow: █
Coloring text in 25% tint of yellow This is a {{STYellow\|STMicroelectronics corporate color: 25% tint of yellow: █ \| tint=25}}	This is a STMicroelectronics corporate color: 25% tint of yellow: █
Getting the hexadecimal code of the color {{STYellow}} is the hexadecimal code of STMicroelectronics yellow.	#FFD200 is the hexadecimal code of STMicroelectronics yellow.
Getting the hexadecimal code of the 75% tint of the color {{STYellow \| tint=75}} is the hexadecimal code of STMicroelectronics 75% tint of yellow.	#FFDD40 is the hexadecimal code of STMicroelectronics 75% tint of yellow.
Getting the hexadecimal code of the 50% tint of the color {{STYellow \| tint=50}} is the hexadecimal code of STMicroelectronics 50% tint of yellow.	#FFE87F is the hexadecimal code of STMicroelectronics 50% tint of yellow.
Getting the hexadecimal code of the 25% tint of the color {{STYellow \| tint=25}} is the hexadecimal code of STMicroelectronics 25% tint of yellow.	#FFF4BF is the hexadecimal code of STMicroelectronics 25% tint of yellow.

Coloring text with the STMicroelectronics corporate secondary color shade of purple (█)
Public - Unprotected
Template common to all ST wikis

Template:STPurple

You type	You get
Coloring text in purple This is a {{STPurple\|STMicroelectronics corporate color: shade of purple: █}}	This is a STMicroelectronics corporate color: shade of purple: █
Coloring text in 75% tint of purple This is a {{STPurple\|STMicroelectronics corporate color: 75% tint of purple: █ \| tint=75}}	This is a STMicroelectronics corporate color: 75% tint of purple: █
Coloring text in 50% tint of purple This is a {{STPurple\|STMicroelectronics corporate color: 50% tint of purple: █ \| tint=50}}	This is a STMicroelectronics corporate color: 50% tint of purple: █
Coloring text in 25% tint of purple This is a {{STPurple\|STMicroelectronics corporate color: 25% tint of purple: █ \| tint=25}}	This is a STMicroelectronics corporate color: 25% tint of purple: █
Getting the hexadecimal code of the color {{STPurple}} is the hexadecimal code of STMicroelectronics purple.	#8C0078 is the hexadecimal code of STMicroelectronics purple.
Getting the hexadecimal code of the 75% tint of the color {{STPurple \| tint=75}} is the hexadecimal code of STMicroelectronics 75% tint of purple.	#A9409A is the hexadecimal code of STMicroelectronics 75% tint of purple.
Getting the hexadecimal code of the 50% tint of the color {{STPurple \| tint=50}} is the hexadecimal code of STMicroelectronics 50% tint of purple.	#C57FBB is the hexadecimal code of STMicroelectronics 50% tint of purple.
Getting the hexadecimal code of the 25% tint of the color {{STPurple \| tint=25}} is the hexadecimal code of STMicroelectronics 25% tint of purple.	#E2BFDD is the hexadecimal code of STMicroelectronics 25% tint of purple.

Getting the hexadecimal code of the STMicroelectronics corporate primary color shade of pink (█)

Warning

This template must not be used to color the text: pink is reserved to the Highlight template