テンプレート:Markup/doc

このテンプレートは、マークアップやコードの横に並べて、描画されたその出力結果を示します。

引数

• title: タイトルを表示します。
• t1:「マークアップ」の文字列を置き換えます。
• t2:「描画」の文字列を置き換えます。
• Style: CSSを指定します。
• Noheaders:|noheaders=onでカラムの見出しとタイトルを表示しません。

引数はen:Template:Markupを参照。

使い方

最初のカラム（「マークアップ」）における各々のセルは、<pre>が使われ、改行と空白をそのままにします。ただし、その内容によっては変化します。そのマークアップは、<nowiki>内でそのマークアップを囲うことによって表示されるように、通常はそれらのセルの内容がエスケープされるのが望ましいでしょう。この機能の追加は技術的に不可能です。

2番目のカラム（「描画」）における各々のセルは、対応した「マークアップ」のセルに一致する、通常はエスケープされていないマークアップです。これは異なる場合があり、例を以下に示します。

• もし最初の行が、#, * などのようなウィキマークアップを含んでいるなら、最初の行の前に<nowiki />を使います。例を参照。
• <syntaxhighlight lang="text" class="" id="" style="" inline="1">==</syntaxhighlight> のような見出しマークアップは、そのページの目次として表示されます。代わりに{{fake heading}}を使用します。
• 一部のテンプレートは、不要に整備用カテゴリに分類するでしょう。
  • {{要出典}}の代わりに、{{Fake}}を使います。
• 一部のテンプレートは、整備用カテゴリにそのページが分類されているかのエラーチェックをするでしょう。そのようなカテゴリはできるだけ抑制してください。
  • Citation Style 1（英語） テンプレートは|template doc demo=trueの設定によって整備用カテゴリを抑制します。

制限

<nowiki>

もし、マークアップ・セルの内容を<nowiki>にて囲まないなら、テンプレートのマークアップもエスケープされず、展開されます。

{{tl|tag}}のためのマークアップの例を挙げます。

展開されてしまいます	nowiki使用
{{[[テンプレート:tag|tag]]}}	{{tl|tag}}

HTML実体

nowiki中のマークアップ・セル中のHTML実体は解析されます。

nowikiを使ったマークアップ	マークアップを回避する以下置換記法の使用
–	 –

これを避けるには、& を &に置き換えてエスケープすることで、  とします。これは   と表示されます。

リストと字下げマークアップ

もし最初の行が、#, * などのようなウィキマークアップを含んでいるなら、<nowiki />を使います。

<nowiki />なし

マークアップ	描画
# Item 1 # Item 2 # Item 3 # Item 4	# Item 1 Item 2 Item 3 Item 4

<nowiki />使用

マークアップ	描画
<nowiki /> # Item 1 # Item 2 # Item 3 # Item 4	Item 1 Item 2 Item 3 Item 4

例

簡単なもの

マークアップ	描画
'''ボールド体の言葉'''	ボールド体の言葉
''イタリック体の言葉''	イタリック体の言葉

より複雑なもの

以下のような例の2番目のカラムでは {{fake heading}} と {{fake citation needed}}を使うことでカテゴリに分類されてしまうのを避けます。

マークアップ	描画
寿命を100年延ばす効果があったといいます{{#tag:ref|控えめな説によると5年ほど。<ref>『未開の秘術』</ref>|group=nb}}。飛ぶように売れました{{要出典}}。 == 注釈 == {{reflist|group=nb}} == 出典 == {{reflist}}	寿命を100年延ばす効果があったといいます。飛ぶように売れました[要出典]。 注釈 出典

複数の列

マークアップ	描画
山から尼が4人踊りながら歩いてきたというのです。	山から尼が4人踊りながら歩いてきたというのです。
山から尼が4人踊りながら歩いてきたというのです。	山から尼が4人踊りながら歩いてきたというのです。
山から尼が4人踊りながら歩いてきたというのです。	山から尼が4人踊りながら歩いてきたというのです。
山から尼が4人踊りながら歩いてきたというのです。	山から尼が4人踊りながら歩いてきたというのです。

題名をつける

|title=を使います。

Foxes and dogs

マークアップ	描画
The quick brown fox jumps over the lazy dog.	The quick brown fox jumps over the lazy dog.

描画されたHTMLを表示する

あるテンプレートが {{code}} に囲まれた場合、描画されたHTMLを表示します。

マークアップ	描画
{{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}}}}	<syntaxhighlight lang="html" class="" id="" style="" inline="1">White, T. H. (1977). The Book of Merlyn. </syntaxhighlight>

関連項目

• {{Markup2}} 点と字下げによってマークアップを示す。
• {{Markupv}} 縦に並べてマークアップ/コードとその出力結果を提示します。
• {{Automarkup}} コードを2度づつ書く必要がありません。