Teamplaid:Markup

O Wiktionary
Jump to navigation Jump to search
Template documentation[view] [edit] [history] [purge]

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

Paramadairean na teamplaide

ParamadairTuairisgeulSeòrsaStaid
margin-leftmargin-left

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

Bun-roghainn
0
Sreangroghainneil
widthwidth

To set the table's overall width.

Bun-roghainn
100%
Sreangroghainneil
stylestyle

For CSS styles amending the table's overall appearance.

Sreangroghainneil
noheadersnoheaders

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

Sreangroghainneil
titletitle

Title above table.

Sreangroghainneil
colheaderstylecolheaderstyle

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

Sreangroghainneil
col1headerstylecol1headerstyle

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

Sreangroghainneil
col1col1

First column (markup/code)'s heading.

Bun-roghainn
"Markup"
Sreangroghainneil
col2headerstylecol2headerstyle

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

Sreangroghainneil
col2col2

Second column (output)'s heading.

Bun-roghainn
"Renders as"
Sreangroghainneil
codestylecodestyle markupstyle

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

Sreangroghainneil
outputstyleoutputstyle

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

Sreangroghainneil
11

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

Sreangroghainneil
22

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

Sreangroghainneil
33

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

Sreangroghainneil
44

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

Sreangroghainneil
3939

First column's content in last possible row.

Sreangroghainneil
4040

Second column's content in last possible row.

Sreangroghainneil

Ùsaid - Usage[deasaich]

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>...</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[deasaich]

<nowiki>...</nowiki>[deasaich]

If you don't wrap the content of the markup cell in <nowiki>...</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
{{[[Teamplaid:Tag|Tag]]}} 
{{Tl|Tag}}

HTML entities[deasaich]

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

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

Eisimpleirean - Examples[deasaich]

Simple[deasaich]

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

More complex[deasaich]

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

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

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

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}}}} 
<cite class="citation book">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%2Fgd.wiktionary.org%3ATeamplaid%3AMarkup" class="Z3988"></span>'"`UNIQ--templatestyles-0000002C-QINU`"'

Faic cuideachd - Also see

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

Iomraidhean - References[deasaich]