Template:Out: Difference between revisions

Content added Content deleted

Inline

Revision as of 06:53, 25 August 2016

This template is used to introduce the example output of a programming example.

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}}`	Output:
`1`	Replaces the word "Output".	`{{out\|Return value}}`	Return value:
`in`	The (single-line) input which produces this output.	`{{out\|in=Hello world}}`	Output — when given an input of `Hello world`:
`comment`	Any other text you want shown in the same line.	`{{out\|comment=test case 1}}}}`	Output — test case 1:

This is a template. There are many others. See Category:RCTemplates for a complete list of templates.

@@ Line 1: / Line 1: @@
 <includeonly><div>
-;{{#if: {{{1|}}} | {{{1}}} | Output}}<nowiki>:</nowiki></div></includeonly><noinclude><nowiki>;Output:</nowiki>
+;{{#if: {{{1|}}} | {{{1}}} | Output}}{{#if: {{{comment|}}}{{{in|}}} | <span style="font-weight:normal> &nbsp; &mdash;&nbsp; {{#if: {{{comment|}}} | {{{comment|}}} | when given an input of <code>{{{in|}}}</code>}}</span> |}}<nowiki>:</nowiki></div></includeonly><noinclude>
-This template is used to standardize the way in which example output is described. {{template}}</noinclude>
+This template is used to introduce the example output of a programming example.
+===Usage===
+Write <code><nowiki>{{out}}</nowiki></code> just above the <code><nowiki><pre>...</pre></nowiki></code> block that lists a code example's output.
+It also accepts these optional parameters:
+{| class="wikitable"
+|-
+! Parameter
+! Purpose
+! Example
+! Renders as
+|-
+|
+|
+| <code><nowiki>{{out}}</nowiki></code>
+| {{out}}
+|-
+| <code>1</code>
+| Replaces the word "Output".
+| <code><nowiki>{{out|Return value}}</nowiki></code>
+| {{out|Return value}}
+|-
+| <code>in</code>
+| The (single-line) input which produces this output.
+| <code><nowiki>{{out|in=Hello world}}</nowiki></code>
+| {{out|in=Hello world}}
+|-
+| <code>comment</code>
+| Any other text you want shown in the same line.
+| <code><nowiki>{{out|comment=test case 1}}}}</nowiki></code>
+| <div style="white-space:nowrap">{{out|comment=test case 1}}</div>
+|}
+{{template}}</noinclude>