قالب:Markup/doc

هذه صفحة توثيق فرعية لـ قالب:Markup.
تتضمن معلومات الاستعمال، التصنيفات وأي محتوى آخر ليس من محتويات الأصل لصفحة القالب.

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

وسائط القالب
وسيط		وصف	نوع	حالة
margin-left	`margin-left`	To set a margin on the table's lefthand side. غيابي 0	نص	اختياري
width	`width`	To set the table's overall width. غيابي 100%	نص	اختياري
style	`style`	For CSS styles amending the table's overall appearance.	نص	اختياري
noheaders	`noheaders`	Set (as e.g. noheaders=on) to suppress the columns' headings and table's title.	نص	اختياري
title	`title`	Title above table.	نص	اختياري
colheaderstyle	`colheaderstyle`	For CSS styling to amend the appearance of each column's heading.	نص	اختياري
col1headerstyle	`col1headerstyle`	For CSS styling to amend the appearance of the first column's heading. Overrides (but does not replace) colheaderstyle.	نص	اختياري
col1	`col1`	First column (markup/code)'s heading. غيابي "Markup"	نص	اختياري
col2headerstyle	`col2headerstyle`	For CSS styling to amend the appearance of the second column's heading. Overrides (but does not replace) colheaderstyle.	نص	اختياري
col2	`col2`	Second column (output)'s heading. غيابي "Renders as"	نص	اختياري
codestyle	`codestyle` `markupstyle`	For CSS styles amending the presentation of the first column (markup/code)'s content (e.g. a smaller font-size).	نص	اختياري
outputstyle	`outputstyle`	For CSS styles amending the presentation of the second column (output)'s content.	نص	اختياري
1	`1`	row 1, first column (markup/code)'s content.	نص	اختياري
2	`2`	row 1, second column (output)'s content.	نص	اختياري
3	`3`	row 2, first column's content (etc).	نص	اختياري
4	`4`	row 2, second column's content (etc).	نص	اختياري
39	`39`	First column's content in last possible row.	نص	اختياري
40	`40`	Second column's content in last possible row.	نص	اختياري

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 <مساعدة:نص ويكي>. 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.

Limitations

`<مساعدة:نص ويكي>`

If you don't wrap the content of the markup cell in <مساعدة:نص ويكي>, 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 &nbsp; will show as  

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

**With `<nowiki />`**
Markup	Renders as
<nowiki /> # Item 1 # Item 2 # Item 3 # Item 4	Item 1 Item 2 Item 3 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.قالب:Fake citation needed

Notes

^ A footnote.^[1]

References

^ 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\|{{cite book \|last=White \|first=T. H. \|title=The Book of Merlyn \|year=1977}}}}	'"`UNIQ--templatestyles-00000028-QINU`"'<cite id="CITEREFWhite1977" class="citation book cs1">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%2Fwww.marefa.org%3A%D9%82%D8%A7%D9%84%D8%A8%3AMarkup%2Fdoc" class="Z3988"></span>