Template:Markup

From Wikipedia, the free encyclopedia
Jump to: navigation, search
Documentation icon Template documentation[view] [edit] [history] [purge]

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

Template parameters
Parameter Description Type Default Auto value Status
Margin-left margin-left To set a margin on the table's lefthand side. string 0 empty optional
Width width To set the table's overall width. string 100% empty optional
Style style For CSS styles amending the table's overall appearance. string empty empty optional
Noheaders noheaders Set (as e.g. noheaders=on) to suppress the columns' headings and table's title. string empty empty optional
Title title Title above table. string empty empty optional
Colheaderstyle colheaderstyle For CSS styling to amend the appearance of each column's heading. string empty empty optional
Col1headerstyle col1headerstyle For CSS styling to amend the appearance of the first column's heading. Overrides (but does not replace) colheaderstyle. string empty empty optional
Col1 col1 First column (markup/code)'s heading. string "Markup" empty optional
Col2headerstyle col2headerstyle For CSS styling to amend the appearance of the second column's heading. Overrides (but does not replace) colheaderstyle. string empty empty optional
Col2 col2 Second column (output)'s heading. string "Renders as" empty optional
Codestyle codestylemarkupstyle For CSS styles amending the presentation of the first column (markup/code)'s content (e.g. a smaller font-size). string empty empty optional
Outputstyle outputstyle For CSS styles amending the presentation of the second column (output)'s content. string empty empty optional
1 1 row 1, first column (markup/code)'s content. string empty empty optional
2 2 row 1, second column (output)'s content. string empty empty optional
3 3 row 2, first column's content (etc). string empty empty optional
4 4 row 2, second column's content (etc). string empty empty optional
39 39 First column's content in last possible row. string empty empty optional
40 40 Second column's content in last possible row. string empty empty optional

Usage[edit]

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[edit]

<nowiki>[edit]

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 Expected rendering
{{[[Template:tag|tag]]}} 
{{tl|tag}}

HTML entities[edit]

HTML entities are parsed in the markup cell:

Nowikied markup shows as Expected markup
&nbsp;&ndash;

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

List and indent markup[edit]

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

Without <nowiki />
Markup Renders as
# Item 1
# Item 2
# Item 3
# Item 4 
# Item 1
  1. Item 2
  2. Item 3
  3. Item 4
With <nowiki />
Markup Renders as
<nowiki />
# Item 1
# Item 2
# Item 3
# Item 4 
  1. Item 1
  2. Item 2
  3. Item 3
  4. Item 4

Examples[edit]

Simple[edit]

Markup Renders as
'''Bold text''' 
Bold text
''Italic text'' 
Italic text

More complex[edit]

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

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[edit]

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[edit]

Foxes and dogs
Markup Renders as
The quick brown fox jumps over the lazy dog. 
The quick brown fox jumps over the lazy dog.

Showing rendered HTML[edit]

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

Markup Renders as
{{cite book |last=White |first=T. H. |title=The Book of Merlyn |year=1977}} 
White, T. H. (1977). The Book of Merlyn. 
{{code|{{cite book |last=White |first=T. H. |title=The Book of Merlyn |year=1977}}}} 
<span class="citation book">White, T. H. (1977). ''The Book of Merlyn''.</span><span title="ctx_ver=Z39.88-2004&rfr_id=info%3Asid%2Fen.wikipedia.org%3ATemplate%3AMarkup&rft.aufirst=T.+H.&rft.aulast=White&rft.au=White%2C+T.+H.&rft.btitle=The+Book+of+Merlyn&rft.date=1977&rft.genre=book&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook" class="Z3988"><span style="display:none;">&nbsp;</span></span>

See also[edit]

  • {{Markup2}} for bulleted and indented markup.
  • {{Markupv}} for the vertical presentation (above/below) of markup/code and its output.