Last edited 4 years ago

Template:HighlightParam: Difference between revisions

Registered User
mNo edit summary
Registered User
(Merge articles)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
<noinclude>
<noinclude>
==Usage==
==Usage==
The [[Template:HighlightParam|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 brand color <span style="color: {{STLightGreen}};">shade of light green (&#9608;)</span>, and in <span style="font-weight: bold;">bold</span>.
The [[Template:HighlightParam|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 <span style="color: {{STLightGreen}};">shade of light green (&#9608;)</span>, and in <span style="font-weight: bold;">bold</span>.


  Usage:  <nowiki>{{</nowiki>HighlightParam|{{HighlightParam|<parameter, value or option to highlight>}}}}
  Usage:  <nowiki>{{</nowiki>HighlightParam|{{HighlightParam|<parameter, value or option to highlight>}}}}
Line 41: Line 41:
To change the current console {{HighlightParam|''<loglevel>''}}, simply write to this file:
To change the current console {{HighlightParam|''<loglevel>''}}, simply write to this file:
  {{Board$}} echo ''{{HighlightParam|<loglevel>}}'' > /proc/sys/kernel/printk
  {{Board$}} echo ''{{HighlightParam|<loglevel>}}'' > /proc/sys/kernel/printk
|}
|}
 
==Maintenance==
This template is a template common to all ST wikis. <br>
Modifications must be done into the [[stwikimodel:Template:HighlightParam|WikiModel]]. They must be reviewed by all  ST wikis maintainers.<br>
When approved, the template can be pushed/merged towards all ST wikis.


==Code==
==Code==
</noinclude><span style="color: #BBCC00; font-weight: bold;">{{{1}}}</span>
</noinclude><span style="color: #49B170; font-weight: bold;">{{{1}}}</span>

Latest revision as of 16:28, 9 March 2021

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:

 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:

 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:

 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}}}

No categories assignedEdit