Template:Legend/doc
 | これはTemplate:Legendの解説サブページです。 使用方法、カテゴリ、およびその他テンプレート自体に含まれない情報を収容しています。 |
 | このテンプレートはテンプレートスタイルを使用しています: |
画像に対する説明（レジェンド=legend、凡例）として、先頭に色付きボックスが付いた文章を1行ずつ表示するためのテンプレートです。色分けした画像を説明する際に補助的に活用できます。
使い方
[編集]書式
[編集]例示中の項目も参考になるでしょう。
引数
[編集]-
|1=色（必須） - 凡例の色をCSS形式で指定します。
- たとえば，
black，#00f，#30f088，rgb(100%,80%,0%)，rgb(255,0,0)，といった形で指定できます。 -
|2=説明文（必須） - 凡例の（短い）説明文を記述します。
-
|outline=囲み枠の色 - 囲み枠の色をCSS形式で指定します。指定例は
|1=の説明を参照してください。 -
|border=枠 - 枠をCSS形式で指定します。
|outline=より詳細な設定がしたいときに用います。 - たとえば
2px dotted #a00といった形で指定できます。 -
|text=色名 - 凡例の色の名前を明示するために用います。凡例を説明するための引数ではないことに注意してください。
- たとえば，
|1=rebeccapurpleと指定されていた場合，|text=レベッカの紫とするのが良いでしょう。 |textcolor=色名の文字色（非推奨）|text=に指定した色名の文字色をCSS形式で指定します。- 注意: 規定では，色名の文字色は第1引数に指定した色に合わせて自動的に決定されます。手動で指定することは視認性を損う可能性があり，推奨されません。
|size=大きさ（非推奨）- 凡例の色と色名の大きさをCSS形式で指定します。凡例の説明文の大きさは変化しないことに注意してください。
- 注意: むやみに大きさを変えることは凡例間・記事間の統一感をなくし，視認性を損う可能性があり，推奨されません。
例
[編集]| 記述例 | 表示例 |
|---|---|
| {{legend|black|アフリカ}} | アフリカ
|
| {{legend|#00f|アメリカ}} | アメリカ
|
| {{legend|#30f088|オセアニア}} | オセアニア
|
| {{legend|rgb(100%,80%,0%)|アジア}} | アジア
|
| {{legend|rgb(255,0,0)|ヨーロッパ}} | ヨーロッパ
|
| {{legend|#fff|南極|outline=#000}} | 南極
|
| {{legend|rebeccapurple|色々指定|border=2px dotted #a00|size=3em|text=レベッカの紫|textcolor=#afa}} | レベッカの紫 色々指定
|
この項目では色を扱っています。閲覧環境によっては、色が適切に表示されていない場合があります。
「この項目では色を扱っています。…」と表示されるTemplate:色テンプレートは含まれていないので、別途指定してください。
注意
[編集]下記の閲覧者にも説明の内容が伝わる、色や濃淡の違いのみに依存しないウェブアクセシビリティに富んだ記事作成にご協力ください。
テンプレートデータ
[編集]画像に対する説明（レジェンド=legend、凡例）として、先頭に色付きボックスが付いた文章を1行ずつ表示するためのテンプレートです。
| パラメーター | 説明 | 型 | 状態 | |
|---|---|---|---|---|
| 色 | 1 | 凡例の色をCSS形式で指定します。
| 文字列 | 必須 |
| 説明文 | 2 | 凡例の（短い）説明文を記述します。
| ウィキテキストの一部 | 必須 |
| 囲み枠の色 | outline | 囲み枠の色をCSS形式で指定します。
| 文字列 | 省略可能 |
| 枠 | border | 枠をCSS形式で指定します。outline引数より詳細な設定がしたいときに用います。
| 文字列 | 省略可能 |
| 色名 | text | 凡例の色の名前を明示するために用います。凡例を説明するための引数ではないことに注意してください。
| 文字列 | 省略可能 |
| 色名の文字色 | textcolor | text引数に指定した色名の文字色をCSS形式で指定します。 | 文字列 | 非推奨 |
| 大きさ | size | 凡例の色と色名の大きさをCSS形式で指定します。凡例の説明文の大きさは変化しないことに注意してください。 | 文字列 | 非推奨 |
関連項目
[編集]- Template:Legend-line
- Template:Legend2
- Template:Legend3 （Template:Colorbox）
- Template:Legend-col - 凡例を複数列に段組し，効率的に描画できます。