HighlightParam

Revision as of 14:28, 9 March 2021 by Nathalie Sangouard (talk | contribs) (Merge articles)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

1 Usage

The HighlightParam template is used to highlight parameters, values or options that must be set, for example in commands, in pages. It formats the text with the STMicroelectronics corporate color shade of light green (█), and in bold.

Usage:  {{HighlightParam|<parameter, value or option to highlight>}}
Where <parameter, value or option to highlight> is the parameter, value or option to highlight

2 Basic examples

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:

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

3 More examples

You type You get
The parameter of the template is formatted in bold: it is useless because the template already formats in bold, but it keeps the parameter in bold
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:

Board $> echo <loglevel> > /proc/sys/kernel/printk
The parameter of the template is formatted in italic: the parameter is then in bold and italic
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:

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

4 Maintenance

This template is a template common to all ST wikis.
Modifications must be done into the WikiModel. They must be reviewed by all ST wikis maintainers.
When approved, the template can be pushed/merged towards all ST wikis.

5 Code

{{{1}}}