ထႅမ်းပလဵတ်ႉ:Markup/doc

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

တၢင်းၸႂ်ႉတိုဝ်း

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

The template accepts up to 40 unnamed parameters, resulting in up to 20 rows of examples.

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
–	 –

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

တူဝ်ယၢင်ႇ

Simple

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

Short cut

See Template:Mra.

Enter this:

{{subst:mra|'''Bold text'''|''Italic text''}}

To make this:

{{markup|
<nowiki>'''Bold text'''</nowiki>|'''Bold text'''|
<nowiki>''Italic text''</nowiki>|''Italic text''}}

Which renders as:

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. The cow jumped over the moon. Notes References

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="book" style="font-style:normal" id="Reference-White-1977">White, T. H.&#32;(1977). <i>The Book of Merlyn</i>.</cite><span class="Z3988" 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.aulast=White&rft.aufirst=T.+H.&rft.date=1977"><span style="display: none;">&nbsp;</span></span>

တူၺ်းပႃး

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

ၶေႃႈမုၼ်းထႅမ်းပလဵၵ်ႉ

ၶေႃႈမုၼ်းၸိူဝ်းၽၢႆႇတႂ်ႈၼႆႉ ပဵၼ် တူဝ်ထတ်းတႃႁၼ်(VisualEditor) ဢၼ်မီးတီႈ ဝီႇၶီႇၽီးတီးယႃးၼၼ်ႉ ယိူင်းဢၢၼ်း တႃႇဢဝ် ၶိူင်ႈၸိူဝ်းၼၼ်ႉ ၸႂ်ႉလႆႈတီႈ ဝီႇၶီႇၽီးတီးယႃးတႆးသေ ၸင်ႇလႆႈဢဝ် ပိူင် ၶေႃႈမုၼ်းထႅမ်းပလဵၵ်ႉ (TemplateData) ဢၼ်မီးတီႈ ဝီႇၶီႇၽီးတီးယႃး ဢိင်းၵလဵတ်ႈၼၼ်ႉ ႁဵတ်းဝႆႉပဵၼ် တီႈမၢႆတီႈတွင်းယဝ်ႉ။ ႁူမ်ႈဝႃႈ ပႆႇၸႂ်ႉၶိူင်ႈၸိူဝ်းၼၼ်ႉသေတႃႉ ပေႃးပဵၼ် ၵူၼ်းႁူႉလွင်ႈတႅမ်ႈပရူဝ်ႇၵရႅမ်ႇ (computer programming) ဢိတ်းဢွတ်းၵေႃႈ ႁႂ်ႈပေႃးႁၼ်လႆႈၸႅင်ႈလႅင်းလီၼႆသေ ၸၢင်ႈဢဝ်ၸႂ်ႉလႆႈ သၽေႃးတီႈၵႅပ်ႈမၼ်းလႆႈယူႇ။

Markup

Template parameters

Parameter		ၶေႃႈသပ်းလႅင်း	Type	Status
margin-left	margin-left	To set a margin on the table's lefthand side. Default 0	String	optional
width	width	To set the table's overall width. Default auto	String	optional
style	style	For CSS styles amending the table's overall appearance.	String	optional
noheaders	noheaders	Set (as e.g. noheaders=on) to suppress the columns' headings and table's title.	String	optional
title	title	Title above table.	String	optional
colheaderstyle	colheaderstyle	For CSS styling to amend the appearance of each column's heading.	String	optional
col1headerstyle	col1headerstyle	For CSS styling to amend the appearance of the first column's heading. Overrides (but does not replace) colheaderstyle.	String	optional
col1	col1	First column (markup/code)'s heading. Default "Markup"	String	optional
col2headerstyle	col2headerstyle	For CSS styling to amend the appearance of the second column's heading. Overrides (but does not replace) colheaderstyle.	String	optional
col2	col2	Second column (output)'s heading. Default "Renders as"	String	optional
Column 1 style	codestyle markupstyle	Use CSS style code to change the look of content in the Markup column. Example white-space: nowrap	String	optional
Column 2 style	outputstyle	Use CSS style code to change the look of content in the Renders-as column.	String	optional
1	1	row 1, first column (markup/code)'s content.	String	optional
2	2	row 1, second column (output)'s content.	String	optional
3	3	row 2, first column's content (etc).	String	optional
4	4	row 2, second column's content (etc).	String	optional
39	39	First column's content in last possible row.	String	optional
40	40	Second column's content in last possible row.	String	optional