Template:Markupv/doc
表示
これはTemplate:Markupvの解説サブページです。 使用方法、カテゴリ、およびその他テンプレートページ自体に含まれない情報を収容しています。 |
このテンプレートは、マークアップやコードの縦に並べて、描画されたその出力結果を示します。
使い方
[編集]引数:
- markup あるいは m: 「マークアップ」セルの内容。{{Markup}}と異なり、表示するテキストの引数に名前があることに注意。
- renders あるいは r: 「描画」セルの内容。注意は上に同じ。
- title あるいは t: 表のタイトル; 標準状態ではなし。
- margin: 表の左の余白(margin) を em 単位で設定。
- width: 表の横幅(width); 標準では90%です。
- style: 表のCSSを指定します。
最初のカラム(「マークアップ」)における各々のセルは、<pre>
が使われ、改行と空白をそのままにします。ただし、その内容によっては変化します。そのマークアップは、<nowiki>
内でそのマークアップを囲うことによって表示されるように、通常はそれらのセルの内容がエスケープされるのが望ましいでしょう。この機能の追加は技術的に不可能です。
2番目のカラム(「描画」)における各々のセルは、対応した「マークアップ」のセルに一致する、通常はエスケープされていないマークアップです。これは異なる場合があり、例を以下に示します。
- もし最初の行が、#, * などのようなウィキマークアップを含んでいるなら、最初の行の前に
<nowiki />
を使います。 ==
のような見出しマークアップは、そのページの目次として表示されます。代わりに{{fake heading}}
を使用します。- 一部のテンプレートは、不要に整備用カテゴリに分類するでしょう。
- 一部のテンプレートは、整備用カテゴリにそのページが分類されているかのエラーチェックをするでしょう。そのようなカテゴリはできるだけ抑制してください。
- 出典表記形式1 テンプレートは
|template doc demo=true
の設定によって整備用カテゴリを抑制します。
- 出典表記形式1 テンプレートは
例
[編集]<score>...</score>
を使った例を挙げます。
{{markupv|title=Example: |markup=<nowiki><score>\relative c' { c( b~ c b c b c b c~ c)}</score></nowiki> |renders=<score>\relative c' { c( b~ c b c b c b c~ c)}</score> }}
以下のように表示されます。
マークアップ | <score>\relative c' { c( b~ c b c b c b c~ c)}</score> |
描画 |
TemplateData
[編集]マークアップやコードと、その描画された出力結果とを縦に並べて示します。
パラメーター | 説明 | 型 | 状態 | |
---|---|---|---|---|
マークアップ | markup m | コードを <nowiki> で囲います。 | 文字列 | 必須 |
描画結果 | renders r | コードをそのまま書きます。 | 文字列 | 必須 |
タイトル | title t | 表のタイトル | 行 | 省略可能 |
余白 | margin | 表の左の余白を em 単位で設定 | 行 | 省略可能 |
横幅 | width | 表の横幅
| 行 | 省略可能 |
スタイル | style | 表のCSS | 行 | 省略可能 |
関連項目
[編集]