テンプレート:Fix/doc
これはテンプレート:Fixの解説サブページです。 使用方法、カテゴリ、およびその他テンプレート自体に含まれない情報を収容しています。 |
これは{{要出典}}などのインラインテンプレートを作成するためのメタテンプレートです。記事の中で直接に用いてはいけません。
インラインで表示するテンプレートはほぼ同一の表示形式を採用しています。このメタテンプレートは単一の標準化された形式を提供し、個々のテンプレートに応じて文章やリンク、カテゴリをカスタマイズできるようになっています。
例えば、[検証のためには不十分です] という表示が欲しければ、以下のように書きます(カテゴリなど、あくまで例です)。
{{fix |link = Wikipedia:検証可能性 |text = 検証 |post-text = のためには不十分です |title = このタグがつけられた前後には検証可能性を充たすために十分な情報が欠けているおそれがあります |date = {{{date|}}} |cat = [[Category:検証を必要とする記事]] }}
この方法によって、新しいインラインテンプレートを作ることが、単にこのテンプレートのパラメータを入力するだけで済むようになります。また、様々なインラインテンプレート間で表示形式や機能、利用方法に一貫性を持たせることができます。
パラメータ
[編集]パラメータ | 指定する内容 | 既定値 | 説明 |
---|---|---|---|
link | テンプレートからリンクするページ | なし | そのテンプレートの意図を読者に説明するページにリンクします。リンクのための括弧 ([[ ]] ) は除いてください。(日本語版でのデフォルトのリンク先は未定です。)
|
text | リンク部分の文字列 | なし | リンク部分に表示される文章です。あまり長いものは避けてください。 |
pre-text | text の前の文字列 | なし | text で指定した文字列の前に表示します。 |
post-text | text の後の文字列 | なし | text で指定した文字列の後に表示します。 |
class | 全体の class 属性 | noprint Inline-Template | このテンプレートが生成する sup 要素の class 属性を指定します。デフォルトのものを消さないでください。ただし、class = noprint Inline-Template FooBarBazQuux のように追加の指定をすることはできます。
|
title | title 属性(の本文) | なし | テンプレートの補助説明を指定します。後述の date パラメータを指定した場合には、このパラメータを指定しなくても、title 属性に加えられます。title 属性は、マウスがテンプレートに重なったときにツールチップとして表示されます。ただし、一部のブラウザではウィキリンク部分が上書きされ、link パラメータが表示されます。 |
special | 代替パラメータ | なし | 標準の形式を採用せず、前述の text, link, title, pre-text, post-text パラメータの代わりに利用できます。特に理由がないかぎり、このパラメータを使用する必要はありません。 |
date | 日付 | なし | title 属性の一部と、テンプレートを貼り付けた記事を収めるカテゴリ名の一部に使われます。テンプレートを貼り付けた日付を表すのによく使われます。多くの場合、「yyyy年m月」の形式になっています。 |
cat | カテゴリ | [[Category:修正が必要なページ]] | テンプレートを貼り付けたページを収めるカテゴリです。記事名前空間のみを対象とします。括弧 ([[ ]] ) を含めてください。下記のcat-date パラメータを指定したときは使われません。
|
cat-date | 日付指定時のカテゴリ名前半 | Category:修正が必要なページ | date パラメータが指定してあると、ページを [[{{{cat-date}}}/{{{date}}}]] 形式のカテゴリに収めます。同様に記事名前空間のみを対象とします。 |
cat-date2 | 日付指定時のカテゴリ名前半(2) | Category:修正が必要なページ | cat-date および date パラメータが指定されているのに [[{{{cat-date}}}/{{{date}}}]] 形式のカテゴリが存在しない場合、ページを [[{{{cat-date2}}}/{{{date}}}]] 形式のカテゴリに収めます。 |
cat-nodate | 日付欠落時のカテゴリ名 | Category:貼り付け日が正しくないテンプレートのある記事 | date パラメータが指定されていない場合に、ページを {{{cat}}} や [[{{{cat-date}}}]] 形式のカテゴリだけでなく、[[{{{cat-nodate}}}]] 形式のカテゴリにも収めます。 |
year-min | 年別分類する場合の年の最小値 | なし | このパラメータを指定すると、カテゴリを年別に分類します。用意されているカテゴリのうち「XXXX年以前」を除く一番過去のカテゴリの年を4桁の数字で指定します。このパラメータより過去の年の日付は「XXXX年以前」に分類されます。まだカテゴリが用意されていない年の日付が指定された場合は、親カテゴリ直下に分類されます。 |
year-max | 年別分類と月別分類の境界年 | なし | year-min が指定されている場合のみ有効です。このパラメータを指定すると、このパラメータで指定された年までが年別分類となり、その翌年以後は月別分類となります。指定方法は year-min と同様です。 |
dateHandler | 例外カテゴライズ用テンプレート | なし | 必要な場合のみ指定します。{{{1}}}に年月を指定すれば当該サブカテゴリ名の末尾を返し {{{2}}}に年月を指定すればソートキーを返す仕様のテンプレートを作成し、そのテンプレート名を指定します。{{Fix}}はそのテンプレートの {{{year}}}に「yyyy年」形式の年を引き渡し{{{1}}}および{{{2}}}に「yyyy年m月」形式の年月を引き渡して呼び出します。 |
invalidarg | 仕様上で定義されていないパラメータ | なし | date パラメータを指定せずに年月が記入されている場合など、各テンプレートの仕様上で定義されていないパラメータが指定された場合に、ページを [[Category:テンプレートを正しく使用していないページ]] に収めます。 |
error-sw error-sw2 error-sw3 |
記入間違い検出フラグ | なし | error-swに値が指定された場合は {{Fix/error}}を呼び出します。それぞれが{{Fix/error}}のパラメータ1・2・3に渡されます。 |
歴史的な事情
[編集]このテンプレートは以前 fix-inline という名前で、現在のものとは別の fix テンプレートと組み合わせて使われていました。後に fix-inline が fix と改名されました。日本語版と英語版では経緯が異なりますので、それぞれの履歴を確認してください。
TemplateData
[編集]これは{{要出典}}などのインライン・テンプレートを作成するためのメタテンプレートです。**直接記事の中で用いてはいけません。**
パラメーター | 説明 | 型 | 状態 | |
---|---|---|---|---|
リンク文字列 | text | リンク部分に表示される文章です。あまり長いものは避けてください。 | 文字列 | 省略可能 |
fix-span | fix-span | 説明なし | 文字列 | 省略可能 |
title | title | 説明なし | 文字列 | 省略可能 |
date | date | 説明なし | 文字列 | 省略可能 |
class | class | 説明なし
| 文字列 | 省略可能 |
text前文字列 | pre-text | textで指定した文字列の前に表示します。 | 文字列 | 省略可能 |
リンク先 | link | そのテンプレートの意図を読者に説明するページにリンクします。リンクのための括弧 (<code><nowiki>[[ ]]</nowiki></code>) は除いてください。 | 文字列 | 省略可能 |
text 後文字列 | post-text | textで指定した文字列の後に表示します。 | 文字列 | 省略可能 |
代替パラメータ | special | 標準の形式を採用せず、前述の '''text''', '''link''', '''title''', '''pre-text''', '''post-text''' パラメータの代わりに利用できます。特に理由がないかぎり、このパラメータを使用する必要はありません。 | 文字列 | 省略可能 |
error-sw | error-sw | 説明なし | 文字列 | 省略可能 |
error-sw2 | error-sw2 | 説明なし | 文字列 | 省略可能 |
error-sw3 | error-sw3 | 説明なし | 文字列 | 省略可能 |
cat-date | cat-date | 説明なし | 文字列 | 省略可能 |
dateHandler | dateHandler | 説明なし | 文字列 | 省略可能 |
year-min | year-min | 説明なし | 文字列 | 省略可能 |
year-max | year-max | 説明なし | 文字列 | 省略可能 |
cat-nodate | cat-nodate | 説明なし | 文字列 | 省略可能 |
cat-date2 | cat-date2 | 説明なし | 文字列 | 省略可能 |
cat-undate | cat-undate | 説明なし | 文字列 | 省略可能 |
invalidarg | invalidarg | 説明なし | 文字列 | 省略可能 |
cat-invalidarg | cat-invalidarg | 説明なし | 文字列 | 省略可能 |
cat | cat | 説明なし | 文字列 | 省略可能 |
See also
[編集]- [[Wikipedia:Cleanup process]]