Template:Doc example

Example

{{{1}}}

Template documentation[view] [edit] [history] [purge]

This template uses TemplateStyles:

Template:Doc example/styles.css

Usage edit

Template to demarcate examples in documentation

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

{{doc example
 |<pre>{{lorem ipsum}}</pre>
{{lorem ipsum}}
}}

Example

{{lorem ipsum}}

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

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

Prefix: Title of the example

{{lorem ipsum}}

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

See also edit

Users of {{collapsible box}}:
- {{doc example}}: uses this template for documentation examples
- {{closed}}: uses this template for closed discussions
- {{collapsed section}}: uses this to hide sections of books and other texts.
  - {{Advertisements}}
  - {{Front matter}}
- {{license container begin}} and {{license container end}}

Example block used in documentation

Template parameters[Edit template data]
Parameter		Description	Type	Status
content	`content` `1`	The example content	Content	required
title	`title`	Title of the example	Unknown	optional
pre_title	`pre_title`	no description	Unknown	optional
margin-left	`margin-left`	Manual left margin (for indenting on talk pages) Default 1.5em Example 3em	Line	optional
collapsed	`collapsed`	Auto-collapse this example Default false	Boolean	optional

The above documentation is transcluded from Template:Doc example/doc.
Editors can experiment in this template's sandbox and testcases pages.
Add categories to the /doc subpage. Subpages of this template.