Template:Markup

From MattWiki
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

ParameterDescriptionTypeStatus
Margin-leftmargin-left

To set a margin on the table's lefthand side.

Default
0
Example
empty
Auto value
empty
Stringoptional
Widthwidth

To set the table's overall width.

Default
100%
Example
empty
Auto value
empty
Stringoptional
Stylestyle

For CSS styles amending the table's overall appearance.

Default
empty
Example
empty
Auto value
empty
Stringoptional
Noheadersnoheaders

Set (as e.g. noheaders=on) to suppress the columns' headings and table's title.

Default
empty
Example
empty
Auto value
empty
Stringoptional
Titletitle

Title above table.

Default
empty
Example
empty
Auto value
empty
Stringoptional
Colheaderstylecolheaderstyle

For CSS styling to amend the appearance of each column's heading.

Default
empty
Example
empty
Auto value
empty
Stringoptional
Col1headerstylecol1headerstyle

For CSS styling to amend the appearance of the first column's heading. Overrides (but does not replace) colheaderstyle.

Default
empty
Example
empty
Auto value
empty
Stringoptional
Col1col1

First column (markup/code)'s heading.

Default
"Markup"
Example
empty
Auto value
empty
Stringoptional
Col2headerstylecol2headerstyle

For CSS styling to amend the appearance of the second column's heading. Overrides (but does not replace) colheaderstyle.

Default
empty
Example
empty
Auto value
empty
Stringoptional
Col2col2

Second column (output)'s heading.

Default
"Renders as"
Example
empty
Auto value
empty
Stringoptional
Codestylecodestylemarkupstyle

For CSS styles amending the presentation of the first column (markup/code)'s content (e.g. a smaller font-size).

Default
empty
Example
empty
Auto value
empty
Stringoptional
Outputstyleoutputstyle

For CSS styles amending the presentation of the second column (output)'s content.

Default
empty
Example
empty
Auto value
empty
Stringoptional
11

row 1, first column (markup/code)'s content.

Default
empty
Example
empty
Auto value
empty
Stringoptional
22

row 1, second column (output)'s content.

Default
empty
Example
empty
Auto value
empty
Stringoptional
33

row 2, first column's content (etc).

Default
empty
Example
empty
Auto value
empty
Stringoptional
44

row 2, second column's content (etc).

Default
empty
Example
empty
Auto value
empty
Stringoptional
3939

First column's content in last possible row.

Default
empty
Example
empty
Auto value
empty
Stringoptional
4040

Second column's content in last possible row.

Default
empty
Example
empty
Auto value
empty
Stringoptional

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

{{tl|tag}}

HTML entities

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

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
  1. Item 1
  2. Item 2
  3. Item 3
  4. 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

Simple

Markup 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 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.

Showing rendered HTML

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|lang=html|{{cite book |last=White |first=T. H. |title=The Book of Merlyn |year=1977}}}}

<cite class="citation book">White, T. H. (1977). ''The Book of Merlyn''.</cite><span title="ctx_ver=Z39.88-2004&rfr_id=info%3Asid%2Fwiki.mattrude.com%3ATemplate%3AMarkup&rft.aufirst=T.+H.&rft.aulast=White&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

  • {{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.