View source for Template:Doc example/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE AND INTERWIKIS IN WIKIDATA -->

=== Usage ===

Template to demarcate examples in documentation

* {{parameter|content}} or {{parameter|1}}: The example content
* {{parameter|title}}: example title, optional, blank if not given
* {{parameter|pre_title}}: title prefix, optional, default is "Example"
* {{parameter|collapsed}}: <code>yes</code> collapses the box by default. Optional, default false.
* {{parameter|margin-left}}: left margin for indenting on talk pages, etc. Optional, default <code>1.5em</code>.

<pre>
{{doc example
 |&lt;pre&gt;{{lorem ipsum}}&lt;/pre&gt;
{{lorem ipsum}}
}}
</pre>
{{doc example
 |<pre>{{lorem ipsum}}</pre>
{{lorem ipsum}}
}}

<pre>
{{doc example
 | title = Title of the example
 | pre_title = Prefix
 | collapsed = yes
 |&lt;pre&gt;{{lorem ipsum}}&lt;/pre&gt;
{{lorem ipsum}}
}}
</pre>
{{doc example
 | title = Title of the example
 | pre_title = Prefix
 | collapsed = yes
 |<pre>{{lorem ipsum}}</pre>
{{lorem ipsum}}
}}


=== See also ===

* {{tl|collapsible box}}: template this template is built on

<includeonly>
<!-- PLEASE ADD CATEGORIES BELOW THIS LINE AND INTERWIKIS IN WIKIDATA, THANKS -->
[[Category:Template documentation|*Example]]
</includeonly>
<templatedata>
{
	"params": {
		"pre_title": {},
		"title": {
			"description": "Title of the example"
		},
		"margin-left": {
			"description": "Manual left margin (for indenting on talk pages)",
			"example": "3em",
			"type": "line",
			"default": "1.5em"
		},
		"collapsed": {
			"description": "Auto-collapse this example",
			"type": "boolean",
			"default": "false"
		},
		"content": {
			"aliases": [
				"1"
			],
			"description": "The example content",
			"type": "content",
			"required": true
		}
	},
	"description": "Example block used in documentation",
	"paramOrder": [
		"content",
		"title",
		"pre_title",
		"margin-left",
		"collapsed"
	]
}
</templatedata>