ထႅမ်းပလဵတ်ႉ:Markup/doc
ၼႃႈလိၵ်ႈဢၼ်ၼႆႉၼႆႉ မၼ်းပဵၼ် ၽိုၼ်ၵႅမ်မိုဝ်း လၢႆးၸႂ်ႉတိုဝ်း (documentation) ႁင်း တွၼ်ႈတႃႇ ၼႃႈလိၵ်ႈၽႄ (subpage) ထႅမ်းပလဵတ်ႉ:Markup ၼၼ်ႉယဝ်ႉ။ တီႈၼႃႈလိၵ်ႈဢၼ်ၼႆႉၼႆႉ မၼ်းတေၶဝ်ႈပႃးဝႆႉ လၢႆးၸႂ်ႉတိုဝ်း လႄႈ ၶေႃႈၶၢဝ်ႇဢၼ်ၵဵဝ်ႇၵပ်း၊ ပိူင်ထၢၼ်ႈ လႄႈ ၶေႃႈမုၼ်းတၢင်ႇၸိူဝ်း ဢၼ်ဢမ်ႇၵဵဝ်ႇၵပ်း တင်း ထႅမ်းပလဵတ်ႉ page ၼၼ်ႉယဝ်ႉ။ |
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}}
.
- Instead of
- 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
.
- Citation Style 1 templates can suppress the maintenance category by setting
The template accepts up to 40 unnamed parameters, resulting in up to 20 rows of examples.
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}}:
Renders as | Expected rendering |
---|---|
<span style="white-space:nowrap;">{{</span>[[Template:tag|tag]]<span style="white-space:nowrap;">}}</span> |
{{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 &nbsp;
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.[nb 1] The cow jumped over the moon.[လူဝ်ႇ လွင်ႈဢၢင်ႈဢိင်]
|
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
မႄးထတ်း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}}}} |
|
တူၺ်းပႃး
မႄးထတ်း- {{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.
ၶေႃႈမုၼ်းထႅမ်းပလဵၵ်ႉ
မႄးထတ်းMarkup
Parameter | ၶေႃႈသပ်းလႅင်း | Type | Status | |
---|---|---|---|---|
margin-left | margin-left | To set a margin on the table's lefthand side.
| String | optional |
width | width | To set the table's overall width.
| 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.
| 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.
| String | optional |
Column 1 style | codestyle markupstyle | Use CSS style code to change the look of content in the Markup column.
| 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 |