コンテンツにスキップ

テンプレート:Template shortcut

提供: Wikisource
テンプレートの解説[表示] [編集] [履歴] [キャッシュを破棄]

このテンプレートは、テンプレートに対応するショートカット(リダイレクト、エイリアスとも呼ばれる)を1つ以上表示するためのものです。ページ右上のボックスのように表示されます。{{Tsh}} はこのテンプレート({{template shortcut}})へのショートカットであり、代わりに使用できます。実際、この文書のソースとなるウィキテキストでも使われています。

使い方

[編集]

このテンプレートと、1つまたは少数の厳選したショートカットのリストを、テンプレートの文書ページのウィキテキストの先頭、{{Documentation subpage}} の直下に配置してください。保存・表示された際には、これらのショートカットがこのテンプレートのショートカットボックス内に表示されます。

表示すべきショートカットの選び方

[編集]

このテンプレートでは最大10個までのショートカットを表示できますが、表示するショートカットは慎重に選ぶことを推奨します。多くのリダイレクトが存在する場合でも、せいぜい2 - 3個にとどめるのがほとんどの場合において十分です。ショートカットボックス内の表示を少なく保つことで、覚えやすくなり、文書ページの構成も整理された状態を保てます。

その他のショートカットの記載場所

[編集]

それ以外のショートカットは、テンプレート文書内の「リダイレクト」セクションに記載してください。ただし、すべてのショートカットを列挙する必要はありません。歴史的な理由で存在するものや、スペースや大文字小文字の違いなどごく些細なバリエーションにすぎないものもあります。そういった名前の違いは省略して、標準的でよく使われる形だけを掲載すれば十分です。

オプションパラメーター

[編集]

このテンプレートには、以下のオプションパラメーターがあります:

  • float — 「left」を指定すると、ボックスがページ左側に回り込み表示されます(デフォルトは「right」)。
  • clear — 「float=right」のときに「right」を指定すると、ボックスがページ右端に押し出され、他の右寄せ要素の左側に重ならないように配置されます。同様に「float=left」のときに「left」を指定すると、左端に押し出されます。
  • pre — ショートカットリンクの前に任意のテキストを追加できます(中括弧内に表示されます)。主に「subst:」を付けての構文を示す目的で使われます。
  • pre1, pre2, ... — 上記と同様ですが、特定のn番目のショートカットにだけ接頭辞を付けたい場合に使用します。

基本的なコード例

[編集]

テンプレート {{uw-v1}} に対応するショートカットを1つ表示したい場合:

{{template shortcut|uw-v1}}

テンプレート {{uw-vandalism1}} に対応する3つのショートカット {{uw-v1}}、{{uw-vand1}}、{{uw-vandal1}} を表示したい場合:

{{template shortcut|uw-v1|uw-vand1|uw-vandal1}}

floatパラメーターの使用例

[編集]

|float = left を使うと、テンプレートがページの左側に回り込み表示されます:

{{template shortcut|float=left|uw-v1}}

中括弧内にテキスト("subst:")を表示する例

[編集]

これは主に、subst展開の使い方を示すために使われます。

|pre2 = subst:|pre3 = subst: を使うと、ショートカットの前に「subst:」を追加して表示できます(中括弧内):

{{template shortcut|uw-v1|pre2=subst:|uw-vand1|pre3=subst:|uw-vandal1}}

|pre = subst: を使うと、すべてのショートカットに「subst:」を一括で付けることができます:

{{template shortcut|pre=subst:|uw-v1|uw-vand1|uw-vandal1}}

テンプレートデータ

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

Template shortcut

このテンプレートは、テンプレートに対応するショートカット(別名・リダイレクト)を1つ以上表示します。

テンプレートパラメーター[テンプレートデータを編集]

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

パラメーター説明状態
リダイレクトとして表示redirect

「ショートカット」を「リダイレクト」として表示するかどうか。

既定
0
ブール値省略可能
ターゲットの指定target

URL末尾に <code>redirect=no</code> を追加しないようにするかどうか。

既定
0
ブール値省略可能
配置位置(float)float

CSSの <code>float</code> プロパティの値。

値の候補
left right
既定
right
文字列省略可能
クリア(float解除位置)clear

CSSの <code>clear</code> プロパティの値。

値の候補
left right both
文字列省略可能
カテゴリ追加category

エイリアスや <code>msg</code> が指定されていない場合にエラーカテゴリへ追加するか。

既定
1
ブール値省略可能
メッセージmsg

ショートカットのリンクの後ろに表示するリンクされないメッセージ。

内容省略可能
共通接頭辞pre

すべてのショートカットに付ける接頭辞(例:「subst:」など)。

subst:
文字列省略可能
接頭辞1pre1

1番目のショートカットに付ける接頭辞

subst:
文字列省略可能
ショートカット11

1番目のテンプレートショートカット

テンプレート必須
接頭辞2pre2

2番目のショートカットに付ける接頭辞

subst:
文字列省略可能
ショートカット22

2番目のテンプレートショートカット

テンプレート省略可能
接頭辞3pre3

3番目のショートカットに付ける接頭辞

subst:
文字列省略可能
ショートカット33

3番目のテンプレートショートカット

テンプレート省略可能
接頭辞4pre4

4番目のショートカットに付ける接頭辞

subst:
文字列省略可能
ショートカット44

4番目のテンプレートショートカット

テンプレート省略可能
接頭辞5pre5

5番目のショートカットに付ける接頭辞

subst:
文字列省略可能
ショートカット55

5番目のテンプレートショートカット

テンプレート省略可能
接頭辞6pre6

6番目のショートカットに付ける接頭辞

subst:
文字列省略可能
ショートカット66

6番目のテンプレートショートカット

テンプレート省略可能
接頭辞7pre7

7番目のショートカットに付ける接頭辞

subst:
文字列省略可能
ショートカット77

7番目のテンプレートショートカット

テンプレート省略可能
接頭辞8pre8

8番目のショートカットに付ける接頭辞

subst:
文字列省略可能
ショートカット88

8番目のテンプレートショートカット

テンプレート省略可能
接頭辞9pre9

9番目のショートカットに付ける接頭辞

subst:
文字列省略可能
ショートカット99

9番目のテンプレートショートカット

テンプレート省略可能

関連項目

[編集]
  • {{shortcut}} — 標準のショートカット通知テンプレート。
  • {{template redirect}} — redirect=yes を自動的に付加