コンテンツにスキップ

Template:Legend/doc

画像に対する説明(レジェンド=legend、凡例)として、先頭に色付きボックスが付いた文章を1行ずつ表示するためのテンプレートです。色分けした画像を説明する際に補助的に活用できます。

使い方

[編集]

書式

[編集]
{{Legend|〈色〉|〈説明文〉|outline=〈囲み枠の色〉|border=〈枠〉|text=〈色名〉|invert=〈必要に応じ明度反転指定〉}}

例示中の項目も参考になるでしょう。

引数

[編集]
|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形式で指定します。凡例の説明文の大きさは変化しないことに注意してください。
注意: むやみに大きさを変えることは凡例間・記事間の統一感をなくし,視認性を損う可能性があり,推奨されません。
|invert=明度反転指定
既定では、ダークモード(暗い背景)に切り替えたとき、|1=で指定した色の明度は反転しません。(特別な指定をしなければ)画像は明度が反転しないので、その凡例としての利用を優先するためです。提案を経て2026年10月から変わりました。
画像以外のマークアップの多くは(特別な指定をしなければ)色の明度が反転します。表に付けられた色なども同じで、その凡例に使用するときは、|invert=yes、あるいは|invert=に任意の値を入力することで反転させられます。

例

[編集]
記述と表示の例1(ダークモードでも明度が反転しません)
記述例表示例
{{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}}
レベッカの紫 色々指定
記述と表示の例2(ダークモードで明度が反転します)
記述例表示例
{{legend|#0000ff|100 - 50%|invert=yes}}
  100 - 50%
{{legend|#78c0ff|50 - 0%|invert=yes}}
  50 - 0%
{{legend|white|値なし|invert=yes}}
  値なし

「この項目では色を扱っています。…」と表示されるTemplate:色テンプレートは含まれていないので、別途指定してください。

注意

[編集]

下記の閲覧者にも説明の内容が伝わる、色や濃淡の違いのみに依存しないウェブアクセシビリティに富んだ記事作成にご協力ください。

テンプレートデータ

[編集]
これはビジュアルエディターやテンプレートウィザードにより使用されるテンプレートのためのTemplateData文書です。

Legend

画像に対する説明(レジェンド=legend、凡例)として、先頭に色付きボックスが付いた文章を1行ずつ表示するためのテンプレートです。

テンプレートパラメーター

このテンプレートは、パラメーターを1行で記述することが推奨されています。

パラメーター説明型状態
色1

凡例の色をCSS形式で指定します。

例
black/#00f/#30f088/rgb(100%,80%,0%)/rgb(255,0,0)
文字列必須
説明文2

凡例の(短い)説明文を記述します。

例
アフリカ/アメリカ/オセアニア/アジア/ヨーロッパ/南極
ウィキテキストの一部必須
囲み枠の色outline

囲み枠の色をCSS形式で指定します。

例
#000
文字列省略可能
枠border

枠をCSS形式で指定します。outline引数より詳細な設定がしたいときに用います。

例
2px dotted #a00
文字列省略可能
色名text

凡例の色の名前を明示するために用います。凡例を説明するための引数ではないことに注意してください。

例
1=rebeccapurpleなら「レベッカの紫」。
文字列省略可能
色名の文字色textcolor

text引数に指定した色名の文字色をCSS形式で指定します。

文字列非推奨
大きさsize

凡例の色と色名の大きさをCSS形式で指定します。凡例の説明文の大きさは変化しないことに注意してください。

文字列非推奨
明度反転指定invert

ダークモード時に色の明度を反転させたいとき、任意の値を指定します。

例
yes
文字列省略可能

関連項目

[編集]