Template:パンくず小路/doc
このテンプレートは、カテゴリのナビゲーション・パス(パンくずリスト)を自動的に生成します。
使い方
[編集 ]基本的には、目的のページで{{パンくず小路}}と入力して使います。カテゴリページでの使用を想定していますが、すべての種類のページで使用することができます。
テンプレートを設置するページとは別のページのパンくずリストを表示するには、
{{パンくず小路|メインページ}} または {{パンくず小路|page=メインページ}}
というふうに入力します。
上位カテゴリのツリーは大抵かなり複雑な構造になっているため、当テンプレートは任意のページからCategory:主要カテゴリまでの間のカテゴリツリー全体ではなく、直近の上位カテゴリツリーの一部を表示します。当テンプレートは、パンくずリストの表示結果が明確で有用な場合にのみ、使用するようにしてください。パンくずリストを調整するために下記のオプション引数が用意されています。
ページが同じカテゴリにある場合、二重ツリーは表示されず、 (...) に置き換えられます(例4を参照)。
隠しカテゴリは表示されますが、(隠しカテゴリが適用されることも多くある)テンプレートを介して追加されるカテゴリは表示されません。
新規のカテゴリ(またはページ)を作成中の場合
[編集 ]新規のカテゴリ(またはページ)を作成中に{{パンくず小路}}を直に置いた場合、パンくずリスト上、カテゴリが全く存在しないかのように示されることがあります。これは、タイミングの問題です。解決策は次の通りです。
- 放置する: 数分間から数時間以内に自動的にパンくずリストが表示されるようになるまで待ちます。
- カテゴリを作成した後に{{パンくず小路}}を追加します。
- もしくは、「キャッシュ破棄」してページを再読み込みします。アカウントの個人設定>ガジェット>外観の変更から
個人用ツールバーにキャッシュ破棄リンク付きの UTC の時計を表示するにチェックを入れると、ページのキャッシュを破棄するためのリンクが表示されます。
その他のオプション
[編集 ]デフォルトでは、パンくずリストは4つ以上の並列分岐があるか、5つのレベルの長さになるまで表示されます。
- length
オプション引数length=nを使用すれば、パンくずリストの最大長を指定可能です。length=1と指定すると、ページの直ぐ上のカテゴリのみが表示されます。length=2と指定すると、ページの2つ上までのカテゴリが表示されます。デフォルト値は5です。例8を参照。
- maxbranch
オプション引数maxbranch=nを使用すれば、パンくずリスト中の並列分岐の最大数を指定可能です。デフォルト値は4です。例3を参照。
- force=yes
オプション引数force=yesを使用すれば、並列分岐の数にかかわらず、ページの上位にあるすべてのカテゴリを指定した長さに達するまで表示します。例9を参照。
- fontsize
オプション引数fontsize=xを使用すれば、フォントサイズを指定可能です。デフォルト値は8です。
- image
このオプション引数で指定した画像をパンくずリストの先頭(左端)に配置します。デフォルトは右記:
- startsize
このオプション引数を指定すると、指定した開始サイズが直ぐ上のカテゴリのフォントサイズに適用され、カテゴリが遠ざかる(パンくずリストの左の方へ進む)ほどフォントサイズが小さくなります。例5を参照。
- ignore
このオプション引数で指定したカテゴリ(およびそれらの上位カテゴリ)を非表示にします。非表示にしたいカテゴリが複数ある場合はコンマで区切ります。例10および例11を参照。
使用例
[編集 ]1. {{パンくず小路|length=4}}
2. {{パンくず小路|Category:コンパイラ}}:
3. {{パンくず小路|Category:コンパイラ | maxbranch=2 }}:
4. {{パンくず小路|page=搾油機}}:
5. {{パンくず小路|Category:犬の用途 | startsize=10 | image=Airedale (PSF).png }}:
.png){kind=link}
6. {{パンくず小路|Category:犬の用途 | image=Airedale (PSF).png}}:
7. {{パンくず小路|コメツキムシ}}:
8. {{パンくず小路|コメツキムシ | length=2}}:
9. {{パンくず小路|コメツキムシ | length=8 | force=yes }}:
10. {{パンくず小路|コメツキムシ | length=8 | force=yes | ignore=前口動物 }}:
11. {{パンくず小路|コメツキムシ | length=8 | force=yes | ignore=前口動物,無脊椎動物 }}: