Difference between revisions of "Template:HighlightParam"

[quality revision] [quality revision]
(Merge articles)
(Merge articles)
 

1 Usage[edit]

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[edit]

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[edit]

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[edit]

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[edit]

{{{1}}}

<noinclude>

==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 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>}}}}
:Where {{HighlightParam|<parameter, value or option to highlight>}} is the parameter, value or option to highlight

==Basic examples==
{| class="st-table"
! You type !! You get
|-
| Highlighting parameter, value or option<pre style="white-space: pre-wrap;">

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

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

==More examples==
{| class="st-table"
! 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<pre style="white-space: pre-wrap;">

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

|
To change the current console {{HighlightParam|'''<loglevel>'''}}, simply write to this file:
 {{Board$}} echo '''{{HighlightParam|<loglevel>}}''' > /proc/sys/kernel/printk
|-
| The parameter of the template is formatted in italic: the parameter is then in bold and italic<pre style="white-space: pre-wrap;">

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

|
To change the current console {{HighlightParam|''<loglevel>''}}, simply write to this file:
 {{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==</noinclude><span style="color: #49B170; font-weight: bold;">{{{1}}}</span>
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: #49B170; font-weight: bold;">{{{1}}}</span>
 
</noinclude><span style="color: #49B170; font-weight: bold;">{{{1}}}</span>