Difference between revisions of "Help:Funtoo Editing Guidelines/ConsoleOutput"
(Created page with "Daniel Robbins has developed a custom MediaWiki extension to allow the realistic display of console output in wikitext. Here's how to use it. To display console output, use t...") |
|||
| Line 1: | Line 1: | ||
| − | Daniel Robbins has developed a custom MediaWiki extension to allow the realistic display of console output in wikitext. Here's | + | Daniel Robbins has developed a custom MediaWiki extension to allow the realistic display of console output in wikitext. Here's what it can look like: |
| + | |||
| + | {{console|body= | ||
| + | # ##i##bluetoothctl | ||
| + | [##g##NEW##!g##] Controller 00:02:72:C9:62:65 antec [default] | ||
| + | ##bl##[bluetooth]##!bl### ##i##power on | ||
| + | Changing power on succeeded | ||
| + | ##bl##[bluetooth]##!bl### ##i##agent on | ||
| + | Agent registered | ||
| + | ##bl##[bluetooth]##!bl### ##i##scan on | ||
| + | Discovery started | ||
| + | ##bl##[bluetooth]##!bl### ##i##devices | ||
| + | Device 00:1F:20:3D:1E:75 Logitech K760 | ||
| + | ##bl##[bluetooth]##!bl### ##i##pair 00:1F:20:3D:1E:75 | ||
| + | Attempting to pair with 00:1F:20:3D:1E:75 | ||
| + | [##y##CHG##!y##] Device 00:1F:20:3D:1E:75 Connected: yes | ||
| + | ##r##[agent]##!r## Passkey: 454358 | ||
| + | ##r##[agent]##!r## Passkey: ##i##4##!i##54358 | ||
| + | ##r##[agent]##!r## Passkey: ##i##45##!i##4358 | ||
| + | ##r##[agent]##!r## Passkey: ##i##454##!i##358 | ||
| + | ##r##[agent]##!r## Passkey: ##i##4543##!i##58 | ||
| + | ##r##[agent]##!r## Passkey: ##i##45435##!i##8 | ||
| + | ##r##[agent]##!r## Passkey: ##i##454358##!i## | ||
| + | [##y##CHG##!y##] Device 00:1F:20:3D:1E:75 Paired: yes | ||
| + | Pairing successful | ||
| + | [##y##CHG##!y##] Device 00:1F:20:3D:1E:75 Connected: no | ||
| + | ##bl##[bluetooth]##!bl### ##i##connect 00:1F:20:3D:1E:75 | ||
| + | Attempting to connect to 00:1F:20:3D:1E:75 | ||
| + | [##y##CHG##!y##] Device 00:1F:20:3D:1E:75 Connected: yes | ||
| + | Connection successful | ||
| + | ##bl##[bluetooth]##!bl### ##i##quit | ||
| + | [##r##DEL##!r##] Controller 00:02:72:C9:62:65 antec [default] | ||
| + | # | ||
| + | }} | ||
| + | |||
| + | As you can see, this renders in a way that provides a more realistic representation of what actually happened on a terminal console. | ||
| + | |||
| + | === Console Usage === | ||
To display console output, use the <nowiki>{{console}}</nowiki> template: | To display console output, use the <nowiki>{{console}}</nowiki> template: | ||
| Line 40: | Line 77: | ||
Please use the above coloring options sparingly. It is sometimes nice to use them to get wiki console output to match the colors that are displayed on a Linux console. Also note that for every color above, there is a matching <code>##!(colorcode)##</code> option to turn color off prior to end of line. | Please use the above coloring options sparingly. It is sometimes nice to use them to get wiki console output to match the colors that are displayed on a Linux console. Also note that for every color above, there is a matching <code>##!(colorcode)##</code> option to turn color off prior to end of line. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Revision as of 03:23, February 24, 2019
Daniel Robbins has developed a custom MediaWiki extension to allow the realistic display of console output in wikitext. Here's what it can look like:
root # bluetoothctl [NEW] Controller 00:02:72:C9:62:65 antec [default] root ##bl##[bluetooth]##!bl### power on Changing power on succeeded root ##bl##[bluetooth]##!bl### agent on Agent registered root ##bl##[bluetooth]##!bl### scan on Discovery started root ##bl##[bluetooth]##!bl### devices Device 00:1F:20:3D:1E:75 Logitech K760 root ##bl##[bluetooth]##!bl### pair 00:1F:20:3D:1E:75 Attempting to pair with 00:1F:20:3D:1E:75 [CHG] Device 00:1F:20:3D:1E:75 Connected: yes root ##r##[agent]##!r## Passkey: 454358 root ##r##[agent]##!r## Passkey: 454358 root ##r##[agent]##!r## Passkey: 454358 root ##r##[agent]##!r## Passkey: 454358 root ##r##[agent]##!r## Passkey: 454358 root ##r##[agent]##!r## Passkey: 454358 root ##r##[agent]##!r## Passkey: 454358 [CHG] Device 00:1F:20:3D:1E:75 Paired: yes Pairing successful [CHG] Device 00:1F:20:3D:1E:75 Connected: no root ##bl##[bluetooth]##!bl### connect 00:1F:20:3D:1E:75 Attempting to connect to 00:1F:20:3D:1E:75 [CHG] Device 00:1F:20:3D:1E:75 Connected: yes Connection successful root ##bl##[bluetooth]##!bl### quit [DEL] Controller 00:02:72:C9:62:65 antec [default] root #
As you can see, this renders in a way that provides a more realistic representation of what actually happened on a terminal console.
Console Usage
To display console output, use the {{console}} template:
For a root console:
{{console|body=
###i## run a command as root
}}
Produces:
root # run a command as root
For a non-root console:
{{console|body=
$ ##i##run a command as user
}}
Produces:
user $ run a command as user
Important
Note that we use a # prompt for root and a $ prompt to denote a non-root user.
Important
The ##i## text tags the rest of the line as being user input ("i" is for "input"). It is then highlighted in a noticeable color so it stands out from text that is not typed in by the user.
If you need to end highlighting of user input prior to the end of a line, use ##!i## to mark the end of the highlighted area.
The following special character sequences are also available:
##g##- Green##y##- Yellow##bl##- Blue##r##- Red##b##- Bold
Please use the above coloring options sparingly. It is sometimes nice to use them to get wiki console output to match the colors that are displayed on a Linux console. Also note that for every color above, there is a matching ##!(colorcode)## option to turn color off prior to end of line.
