Template:Out: Difference between revisions
Content added Content deleted
(Add `text` parameter, as per request at User_talk:Smls. Also split `comment` into `case` and `note`.) |
m (formatting) |
||
Line 25: | Line 25: | ||
| Text to show instead of the word "Output". |
| Text to show instead of the word "Output". |
||
| <code><nowiki>{{out|Return value}}</nowiki></code> |
| <code><nowiki>{{out|Return value}}</nowiki></code> |
||
| {{out|Return value}} |
| <div style="white-space:nowrap">{{out|Return value}}</div> |
||
|- |
|- |
||
| <code>case</code> |
| <code>case</code> |
||
Line 35: | Line 35: | ||
| The (single-line) input which produces this output. |
| The (single-line) input which produces this output. |
||
| <code><nowiki>{{out|input=Hello world}}</nowiki></code> |
| <code><nowiki>{{out|input=Hello world}}</nowiki></code> |
||
| {{out|input=Hello world}} |
| <div style="white-space:nowrap">{{out|input=Hello world}}</div> |
||
|- |
|- |
||
| <code>note</code> |
| <code>note</code> |
||
| A remark to show in parentheses. |
| A remark to show in parentheses. |
||
| <code><nowiki>{{out|note=elided}}</nowiki></code> |
| <code><nowiki>{{out|note=elided}}</nowiki></code> |
||
| {{out|note=elided}} |
| <div style="white-space:nowrap">{{out|note=elided}}</div> |
||
|- |
|- |
||
| <code>text</code> |
| <code>text</code> |
Revision as of 10:25, 27 August 2016
This template is used to introduce the output of a programming example.
Usage
Write {{out}}
just above the <pre>...</pre>
block that lists a code example's output.
It also accepts these optional parameters:
Parameter | Purpose | Example | Renders as |
---|---|---|---|
{{out}}
|
| ||
1
|
Text to show instead of the word "Output". | {{out|Return value}}
|
|
case
|
The test-case/condition which produces this output. | {{out|case=test case 3}}
|
|
input
|
The (single-line) input which produces this output. | {{out|input=Hello world}}
|
|
note
|
A remark to show in parentheses. | {{out|note=elided}}
|
|
text
|
Free-form text to follow instead of a colon. | {{out|text=...}}}}
|
|
You can combine multiple parameters, except that case and input are mutually exclusive.