Template:Box-header/doc
| これはTemplate:Box-headerの解説サブページです。 使用方法、カテゴリ、およびその他テンプレート自体に含まれない情報を収容しています。 |
| Luaモジュールを使用しています: |
これはウィキポータルにおいて、コンテンツをボックスで囲って表示するテンプレートのひとつです。主に文章で構成されるコンテンツに適しています。スタイルをある程度標準化することを狙っています。
このテンプレートは単独ではうまく動作しません。必ず{{Box-footer}}と組み合わせて使います。
ポータル向けに最適化するため、デフォルトで目次を節編集のリンクを表示しない設定です。ポータル以外に使うときは、TOC や EDIT に yes の値を入れなければ前記のような表示になる点、注意してください。
構文
いくつかのパターンのひな形を提示します。
{{Box-header
| title = <!-- タイトル -->
| editpage = <!-- 編集リンク先ページ名 -->
| noedit = <!-- 入力した場合は編集リンク非表示 -->
| titleforeground = <!-- タイトルの文字の色 -->
| titlebackground = <!-- タイトルボックスの背景色 -->
| background = <!-- 本体ボックスの背景色 -->
| border = <!-- ボックス全体の線の色 -->
| viewpage = <!-- editpageと同じサブページ名。入力した場合は「表示」リンク表示、入力しなかった場合は非表示 -->
}}
{{<!-- editpageと同じサブページ名 -->}}
{{Box-footer | <!-- 本体ボックス末尾の右寄せテキスト --> }}
- ひな形2
- 以下のTemplate:ウィキポータルボックスヘッダの同じ引数名でも動作します。(なお、ウィキポータルボックスヘッダにnoedit、viewpage引数はありません)
{{Box-header
| タイトル = <!-- タイトル -->
| 編集ページ = <!-- サブページ名。 -->
| noedit = <!-- 入力した場合は編集リンク非表示。 -->
| タイトル字色 = <!-- タイトルの文字の色 -->
| タイトル背景色 = <!-- タイトルボックスの背景色 -->
| 背景色 = <!-- 本体ボックスの背景色 -->
| 線色 = <!-- ボックス全体の線の色 -->
| viewpage = <!-- editpageと同じサブページ名。入力した場合は「表示」リンク表示、入力しなかった場合は非表示。 -->
}}
{{<!-- 編集ページと同じサブページ名。 -->}}
{{Box-footer | <!-- 本体ボックス末尾の右寄せテキスト --> }}
- ひな形3
- サブページを作らず、ヘッダとフッタの間にコンテンツを記載する場合は以下のような構文にします。editpage、viewpage引数が不要となるため省かれています。
{{Box-header
| title = <!-- タイトル -->
| titleforeground = <!-- タイトルの文字の色 -->
| titlebackground = <!-- タイトルボックスの背景色 -->
| background = <!-- 本体ボックスの背景色 -->
| border = <!-- ボックス全体の線の色 -->
}}
<!-- 本体ボックス部分に載せたいテキストをここに書きます -->
{{Box-footer | <!-- 本体ボックス末尾の右寄せテキスト --> }}
「Portal:なになに/Box-header」「Portal:なになに/ボックスヘッダ」のような各ポータル専用テンプレートページを作ることが可能です。これで色などのスタイルを指定しておくと(例:Portal:文学/ボックスヘッダ、Portal:災害/box-header)、何度もTemplate:Box-headerを呼び出して色などの指定を行う必要がなくなります。
入力例
- 入力例1
- 文字色や背景色を指定するときは、例えば以下のようになります。
{{Box-header
| title = 特集項目
| editpage = Wikipedia:サンドボックス
| titleforeground = white
| titlebackground = #3366cc
| background = white
}}
[[Image:Castillo-de-arena.jpg|150px|left|サンプル画像左寄せ]]
'''特集項目'''とは、ウィキポータルにおいて導入部を引用して紹介される記事のこと。その分野の、主要なトピック、良質な記事といった受賞記事などの中から選定される。
{{Box-footer| ……[[Wikipedia:ウィキポータル|もっと見る]] }}
特集項目
- 入力例2
- 文字色や背景色を指定しない場合、以下のようにデフォルトの配色になります。
{{Box-header
| title = 特集項目
| editpage = Wikipedia:サンドボックス
}}
[[Image:Castillo-de-arena.jpg|150px|left|サンプル画像左寄せ]]
'''特集項目'''とは、ウィキポータルにおいて導入部を引用して紹介される記事のこと。その分野の、主要なトピック、良質な記事といった受賞記事などの中から選定される。
{{Box-footer| ……[[Wikipedia:ウィキポータル|もっと見る]] }}
特集項目
- 入力例3
- [編集]を表示させたくないときは、以下のようにnoedit引数を指定します。
{{Box-header
| title = 特集項目
| titleforeground = white
| titlebackground = #3366cc
| background = white
| noedit = yes
}}
[[Image:Castillo-de-arena.jpg|150px|left|サンプル画像左寄せ]]
'''特集項目'''とは、ウィキポータルにおいて導入部を引用して紹介される記事のこと。その分野の、主要なトピック、良質な記事といった受賞記事などの中から選定される。
{{Box-footer| ……[[Wikipedia:ウィキポータル|もっと見る]] }}
特集項目
- 入力例4
- 以下の引数でも、入力例3と同じ動作をします。
{{Box-header
| タイトル = 特集項目
| タイトル字色= white
| タイトル背景色 = #3366cc
| 背景色 = white
| noedit = yes
}}
[[Image:Castillo-de-arena.jpg|150px|left|サンプル画像左寄せ]]
'''特集項目'''とは、ウィキポータルにおいて導入部を引用して紹介される記事のこと。その分野の、主要なトピック、良質な記事といった受賞記事などの中から選定される。
{{Box-footer| ……[[Wikipedia:ウィキポータル|もっと見る]] }}
特集項目
引数
主要な引数
- editpage – [編集] をクリックしたときに編集画面を開くページ名を指定します。サブページを編集させたい時によく使用します。例えばPortal:日本で使う場合、未指定ではPortal:日本を編集するリンクになってしまいますが、「Portal:日本/特集」と入力すればPortal:日本/特集を編集するリンクにできます。名前空間を含むページ名({{FULLPAGENAME}}に相当)を指定する必要があります。既定値ではそのテンプレートを読み込んでいるページになります。
- noedit – デフォルトでは [編集] のリンクが右端に表示されますが、
|noedit=yes(または空白以外の何らかの文字)を入力すると、これを非表示にできます。なお、|EDITLINK=に空白以外の何らかの文字が入力されているときも、編集リンクは非表示です。 - section – デフォルトでは [編集] をクリックしたときにページ全体を編集します。この引数に
|section=2のような数字を指定すると、その番号の節単位編集の画面を開くようになります。 - title – ボックスのタイトルです。例:
|title=主要項目 - top – 右端の [編集] [表示] リンクの次に追加表示するテキストを指定できます。
|EDITLINK=に空白以外の何らかの文字が入力されているときは、非表示です。 - viewpage – 右端の [編集] の次に表示される [表示] のリンク先ページ名を指定します。無効なページ名を指定するとエラーになります。
|EDITLINK=に空白以外の何らかの文字が入力されているときは、非表示です。
動作のオプション
- EDIT – 読み込みテンプレート等で右端の [編集] リンクを表示させない設定になっていても、
|EDIT=yes(または空白以外の何らかの文字)を入力すると強制表示させることができます。 - EDITLINK –
|EDITLINK=no(または空白以外の何らかの文字)を入力すると、右端の [編集] [表示] リンクを非表示にできます。 - SPAN – デフォルトでは、ボックスのタイトル部分に
<h2>...</h2>タグを使用します|SPAN=yes(または空白以外の何らかの文字)を入力すると、<span>...</span>タグに変更できます。 - TOC – デフォルトでは、目次は非表示です。
|TOC=yes(または空白以外の何らかの文字)を入力すると、表示させることができます。
スタイルのオプション
(2025年7月調査時点の仕様)
- titlebackground – タイトルボックスの背景色
- titleforeground – タイトルの文字の色
- background – 本体ボックスの背景色
- foreground – 本体ボックスの文字の色
- title-font-family – タイトルの書体
- title-font-size, titlefont-size – タイトルのフォントサイズ
- title-font-weight – タイトルのフォントの太さ
- font-family – タイトルボックスの書体
- font-size – タイトルボックスのフォントサイズ
- extra – タイトルボックスの追加のCSSスタイルを指定します。
- border – ボックス全体の線の色
- border-top – タイトルボックスの上側・下側の線の太さ(px単位、単位は省略)
- border-type – ボックス全体の線の形式。CSSにおけるborder-styleに相当。規定値solid(1本線)から、double(2本線)、none(線なし)などに変更できる。
- border-width – ボックス全体の線の太さ
- titleborder – タイトルボックスの線の色
- background-opacity –
- padding – タイトルボックス内、本体ボックス内それぞれの余白
- padding-top – タイトルボックス内の上方向の余白(topのみ本体ボックスにも適用される模様-2025年7月時点)
- padding-left – タイトルボックス内の左方向の余白(left, right, bottomは本体ボックスには適用されない模様-2025年7月時点)
- padding-right – タイトルボックス内の右方向の余白
- padding-bottom – タイトルボックス内の下方向の余白
- title-align – タイトルの水平方向の寄せ位置(左・中央・右など)
- text-align – 本体ボックス内の水平方向の寄せ位置(左・中央・右など)
- title-border-radius – タイトルボックスの角を丸める半径。例えば
|title-border-radius=0.5em 0.5em 0 0と指定すれば、左上と右上の角が半径0.5emで丸められます。 - border-radius – 本体ボックスの角を丸める半径。例えば
|border-radius=0 0 0.5em 0.5emと指定すれば、左下と右下の角が半径0.5emで丸められます。
上下2つのボックスのうち、「タイトルボックス」(title-container)はタイトル部分のボックス、「本体ボックス」(box-header-body)はその下の中身部分のボックスを指します。「タイトル」は|title=に入力する文字部分を指します。「タイトルボックス」に適用するスタイルはタイトルおよびこのボックス内のほかの文字にも適用されますが、「タイトル」に適用するスタイルはこのボックス内のほかの文字には適用されません。
ほとんどの引数の名前はCSSのスタイルのプロパティに合わせられています。
{{Box-footer}} も参照。
同機能のテンプレートとの比較表
Template:ウィキポータルボックスヘッダ、Portal:Box-headerとこのテンプレート(Template:Box-header)の各引数は以下のように対応します。
| Template:ウィキポータルボックスヘッダ | Portal:Box-header | Template:Box-header | 説明 | |||
|---|---|---|---|---|---|---|
| 引数 | 既定値 | 引数 | 既定値 | 引数 | 既定値 | |
| タイトル | — | title | — | title | — | |
| 編集ページ | — | editpage | — | editpage | — | ※ |
| タイトル字色 | #333333 | titleforeground | #000000 | titleforeground | #000000 | |
| タイトル背景色 | #ccccff | titlebackground | #bcbcbc | titlebackground | #bcbcbc | |
| 字色 | #000000 | foreground | #000000 | foreground | #000000 | |
| 背景色 | #eeeeff | background | #fefeef | background | #fefeef | |
| 線色 | #aaaaaa | border | #ababab | border | #ababab | |
※編集リンクの表示/非表示について :
- ウィキポータルボックスヘッダでは、
|編集ページ=にする(空の値を入力する)と編集リンクは非表示になります。 - Portal:Box-headerでは、
|EDIT=noまたは|EDITLINK=no(あるいは、いずれも空白以外の何らかの文字)を入力したとき、編集リンクは非表示になります。 - Template:Box-headerでは、
|noedit=yesまたは|EDITLINK=no(あるいは、いずれも空白以外の何らかの文字)を入力したとき、編集リンクは非表示になります。
追跡カテゴリ
アクセシビリティの配慮に乏しい(Wikipedia:色の使用に準拠していない)配色を使っているページには、次のカテゴリが自動で付与され追跡対象となります。
- タイトルの配色コントラスト比が 4.5:1 未満 と不十分なもの - Category:タイトルの配色コントラスト比が不十分なBox-header
- 本体ボックス部分の配色コントラスト比が 7:1 未満 と不十分なもの - Category:本体の配色コントラスト比が不十分なBox-header
文字色に対してタイトル背景色が濃すぎる場合、また文字の方が明るい反転の配色の場合は文字色に対してタイトル背景色が薄すぎる場合に該当します。できるだけ修正したほうがよいでしょう。なお、下の配色の見本はすべて配色コントラスト比の基準を満たしているので参考となります。
配色の見本
テンプレートデータ
TemplateData
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
説明はありません。
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
関連テンプレート
ポータルページの特集コンテンツ用
- {{Transclude random subpage}}—特集サブページをランダムに読み込む。ボックスなし。
- {{Random portal component}}—特集サブページをランダムに読み込む。ボックス付き。
- {{Random subpage}}—各種サブページをランダムに読み込む。ボックスなし。
- {{Numbered subpages}}—管理用。通し番号が振られたサブページを一覧表示し比較しやすくしたもの。
ポータルページの特集サブページ用
ポータルページのレイアウト用
- {{Box-header}}—既定では長方形のボックス形式のヘッダ。文字・背景・線・余白のスタイル、編集リンクなどのレイアウト指定を行う。
- {{Box-header colour}}—配色を自動計算し、細かな指定が不要なヘッダ
- {{Box-header-round}}—ボックスの角が丸いヘッダ
- {{Box-header-watch}}—ウォッチリストへの追加アイコンをもつヘッダ
- {{Box-header-style1}}—タイトル左寄せのヘッダ
- {{Box-footer}}—ボックス形式のフッタ。Box-headerと必ずセットで使う。
- {{ウィキポータルボックスヘッダ}} & {{ウィキポータルボックスフッタ}}—長方形のボックス形式のヘッダ&フッタ
- Portal:Box-header & Portal:Box-footer—(旧式)長方形のボックス形式のヘッダ&フッタ。Box-headerの古いCSSスタイルを使用。
- {{標準コラム}}—(旧式)ボックスの角が丸いヘッダで、アイコン使用にも対応
- {{影付コラム}}—(旧式)長方形で影付きのボックス形式のヘッダ
- {{コラム}}—(旧式)タイトル下方に色付き線を表示するシンプルな見た目のヘッダ
- {{Flex columns}}—左右2列のレイアウト用
関連ポータル等への案内リンク用
- {{ウィキポータルリンク}}({{Portal}})—右寄せボックス、任意画像または自動アイコン、背景水色または灰色—主に記事、カテゴリ用
- {{Portal box}}—右寄せボックス、アイコンなし、背景水色—主に記事、カテゴリ用
- {{Portal bar}}—横長全幅ボックス、自動アイコン、文字アイコンやや小さめ—主に記事、カテゴリ、ポータル用
- {{Portal-inline}}—左寄せボックスなし、文字アイコン小さめ表示にも対応—主に記事、テンプレート内表示用
- {{Related portals}}—左寄せボックス、自動アイコン、アイコンやや大きめ—主にポータル用
- {{Related portals2}}—左寄せボックス、自動アイコン、アイコン大きめ、2段表示—主にポータル用
- {{WikimediaForPortals}}—姉妹プロジェクトへの案内リンク
汎用
- {{Portals}}—ポータル制度の簡易案内
- {{Purge page}}—サーバーのキャッシュ破棄リンク
