Fyrimynd:Markupv/doc

Usage

This template is used to present markup or code in a vertical format above the rendered output.

Parameters:

• markup or m: Content of Markup cell
• renders or r: Content of Renders as cell
• title or t: Title of table; defaults to none
• margin: Set table left margin in em
• width: Table width; defaults to 90%
• style: Additional CSS for the table

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:

• If the first line includes wikimarkup that must start on a new line such as #, * or ; then use <nowiki /> before the first line.
• 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=1}} to ensure that the reference list is closed.
• Some templates will place the page in a maintenance category, which is usually undesired:
  • Instead of {{citation needed}}, use {{fake citation needed}}.
• 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.

Example

The following meta-example uses {{markupv}} to create an example of using <score>...</score>:

{{markupv|title=Example:
|markup=<score>\relative c' { c( b~ c b c b c b c~ c)}</score>
|renders=<score>\relative c' { c( b~ c b c b c b c~ c)}</score>
}}

It generates:

Example:

Markup	<score>\relative c' { c( b~ c b c b c b c~ c)}</score>
Renders as

Limitations

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}}:

Markup	Markup
Renders as	Renders

HTML entities are parsed in the markup cell

Markup	Markup
Renders as	Renders

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

Examples

Simple examples:

Markup	Markup
Renders as	Renders

Complex example: Note that the second argument to {{markupv}} uses {{fake heading}} and {{fake citation needed}}.

Markup	Markup
Renders as	Renders

With title:

Foxes and dogs

Markup	Markup
Renders as	Renders

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

Markup	Markup
Renders as	Renders

See also

• {{markup}}: side by side markup
• {{markup2}}: bulleted and indented markup
• {{markupv}}: above and below markup