Template:Markup/doc

From blackwiki
< Template:Markup
Revision as of 21:05, 25 February 2012 by imported>CharlesGillingham (→‎Examples: Added fake fact to this example.)
Jump to navigation Jump to search

Usage

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

Parameters:

  • unnamed 1: Content of row 1, column 1
  • unnamed 2: Content of row 1, column 2
through
  • unnamed 19: Content of row 10, column 1
  • unnamed 20: Content of row 10, column 2
  • t1: Title of column one; defaults to Markup
  • t2: Title of column two; defaults to Renders as
  • title: Title of table; defaults to none
  • notitle: When set, suppresses table and column titles
  • margin: set table left margin in em

The Markup cell is pre-formatted with <pre> to retain newlines and spaces, but styled to allow content to wrap within the cell. It is usually desirable to escape the content of the Markup cell so that the markup is displayed by wrapping the markup in <nowiki>. It is technically not possible to add this feature to the template.

In the Renders as cell, the content is usually the unescaped markup copied from the Markup cell. There are instances where this may differ:

  • Header markup such as == will show in the page table of contents; use {{fake heading}}.
  • When using {{reflist}} with no other parameters, use {{reflist|close}} to ensure that the reference list is closed.
  • Some templates (such as {{fact}}) will place the whole page in a maintenance category incorrectly; use {{fake fact}}.

Examples

Simple examples:

Markup Renders as
'''Bold text'''

Bold text

''Italic text''

Italic text

<strike>Struck text</strike>

Struck text

Complex example: Note that the second argument to {{markup}} uses {{fake heading}} and {{fake fact}}.

Markup 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 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 Renders as
The quick brown fox jumps over the lazy dog.

The quick brown fox jumps over the lazy dog.

See also