Template:Markup/doc

From TechInfoDepot
Jump to navigationJump to search

This template is used to present markup or code side by side with the output it renders.


Usage

Each cell in the first ("Markup") column uses <pre> to retain newlines and spaces but styled to allow content to wrap within it. It is usually desirable to escape the content of these cells so that the markup is displayed by wrapping the markup in <nowiki>. It is technically not possible to add this feature to the template.

Each cell in the second ("Renders as") column is usually the unescaped markup copied from the corresponding "Markup" cell before it. There are instances where this may differ:

  • If the first line includes wikimarkup that must start on a new line such as #, * or ; then use <nowiki /> before the first line; see examples below.
  • Header markup such as == will show in the page table of contents; use {{fake heading}}.
  • Some templates will place the page in a maintenance category, which is usually undesired:
  • Some templates may have error checking that places the page in a maintenance category. Suppress the category as possible:
    • Citation Style 1 templates can suppress the maintenance category by setting |template doc demo=true.

Limitations

<nowiki>

If you don't wrap the content of the markup cell in <nowiki>, then any template markup will not be escaped, it will be expanded.

This example shows the markup for {{tl|tag}}:

Renders as =scope="col" style="width:50%;"| Expected rendering
{{[[Template:tag|tag]]}}

{{tl|tag}}

HTML entities

HTML entities are parsed in the markup cell:

Nowikied markup shows as =scope="col" style="width:50%;"| Expected markup
 –

&nbsp;&ndash;

To work around this, replace the & with &amp; thus &amp;nbsp; will show as &nbsp;

List and indent markup

If the first line includes wikimarkup that must start on a new line such as #, * or ; then use <nowiki />:

Without <nowiki />
Markup =scope="col" style="width:50%;"| Renders as
# Item 1
# Item 2
# Item 3
# Item 4
  1. Item 1
  2. Item 2
  3. Item 3
  4. Item 4
With <nowiki />
Markup =scope="col" style="width:50%;"| Renders as
<nowiki />
# Item 1
# Item 2
# Item 3
# Item 4

  1. Item 1
  2. Item 2
  3. Item 3
  4. Item 4

Examples

Simple

Markup =scope="col" style="width:50%;"| Renders as
'''Bold text'''

Bold text

''Italic text''

Italic text

More complex

Note that {{Markup}}'s second argument here uses {{fake heading}} and {{fake citation needed}}.

Markup =scope="col" style="width:50%;"| Renders as
The quick brown fox jumps over the lazy dog.{{#tag:ref|A footnote.<ref>A reference for the footnote.</ref>|group=nb}} The cow jumped over the moon.{{fact}}

== Notes ==
{{reflist|group=nb}}

== References ==
{{reflist}}

The quick brown fox jumps over the lazy dog.[nb 1] The cow jumped over the moon.[citation needed]

Notes
  1. A footnote.[1]
References
  1. A reference for the footnote.

Multiple rows

Markup =scope="col" style="width:50%;"| Renders as
The quick brown fox jumps over the lazy dog.

The quick brown fox jumps over the lazy dog.

The quick brown fox jumps over the lazy dog.

The quick brown fox jumps over the lazy dog.

The quick brown fox jumps over the lazy dog.

The quick brown fox jumps over the lazy dog.

The quick brown fox jumps over the lazy dog.

The quick brown fox jumps over the lazy dog.

The quick brown fox jumps over the lazy dog.

The quick brown fox jumps over the lazy dog.

With title

Foxes and dogs
Markup =scope="col" style="width:50%;"| Renders as
The quick brown fox jumps over the lazy dog.

The quick brown fox jumps over the lazy dog.

Showing rendered HTML

When a template is enclosed within {{code}}, it shows the rendered HTML:

Markup =scope="col" style="width:50%;"| Renders as
{{cite book |last=White |first=T. H. |title=The Book of Merlyn |year=1977}}

Page Module:Citation/CS1/styles.css has no content.White, T. H. (1977). The Book of Merlyn.

{{code|lang=html|{{cite book |last=White |first=T. H. |title=The Book of Merlyn |year=1977}}}}

'"`UNIQ--templatestyles-0000002C-QINU`"'<cite id="CITEREFWhite1977" class="citation book cs1">White, T. H. (1977). ''The Book of Merlyn''.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=book&rft.btitle=The+Book+of+Merlyn&rft.date=1977&rft.aulast=White&rft.aufirst=T.+H.&rfr_id=info%3Asid%2Ftechinfodepot.shoutwiki.com%3ATemplate%3AMarkup%2Fdoc" class="Z3988"></span>

See also

  • {{Markup2}} for bulleted and indented markup.
  • {{Markupv}} for the vertical presentation (above/below) of markup/code and its output.
  • {{Automarkup}} does not require to write the code samples twice.