---

オープンソースなcmsプログラム【modX】の中で使われる「スニペット」は、MTのプラグインやある種のMTタグのように、ナビゲーションやぱんくずリストを自動で生成する小さなphpアプリケーションのことです。

1.スニペット【Breadcrumbs】の使い方

ぱんくずリストを出力することに特化したスニペットです。表示するぱんくずの数を制限したりなど、様々な設定が可能です。
名前も【Breadcrumbs＝ぱんくず】で実に直球です。
以下のスニペットコール（スニペットを呼び出す記述）をテンプレート/チャンク内のぱんくずリストを挿入したい箇所で記述します

例えばこのページに記述すると、

と出力されます。
カスタマイズする時は、

のように記述します（スニペット共通）。
`設定値`の【`】ですが、シングル/ダブルクォーテーションではありません。バッククォーテーションです。
shift+@で入力しましょう（最初、これがわからなくてハマってしまいました。）

★オプションパラメータ

homePageId [ number ]…デフォルトはsite_start
記述例：[[Breadcrumbs &homePageId=`4`]]
ぱんくずのhome(top)ページをどのページにするか、idで設定します。
バージョン【0.9f】で追加されたパラメータです。
modX設定で設定したsite_start（home）と、実際のhomeが違う場合に使います。

---

maxCrumbs [number]
記述例：[[Breadcrumbs &maxCrumbs=`2`]]

表示するぱんくずの数を設定します。最初は100に設定されています。
上の例でいくと、記述したページがhomeから数えて5階層めにある場合、

と出力され、間の2～3階層がカットされます。homeとカレントページ（現在のページ）は表示されます。

---

pathThruUnPub [ 1 or 0 ]…デフォルトは1
記述例：[[Breadcrumbs &pathThruUnPub=`0`]]

非公開ページ（フォルダ）が途中にあった場合の表示を設定します

home > 会社概要 > 制作実績（非公開) > 2008年度（非公開） > webデザイン

となっている場合、1なら

0なら

と出力されます。

---

respectHidemenu [ 1 or 0 ]…デフォルトは1
記述例：[[Breadcrumbs &respectHidemenu=`0`]]
「メニューに非表示」を設定したページを隠すかどうかを設定します。（1＝隠す,0＝表示）

---

showHomeCrumb [ 1 or 0 ]…デフォルトは1
記述例：[[Breadcrumbs &showHomeCrumb=`0`]]
ぱんくずリストの中に、「home」を入れるかどうかを設定します。（1＝隠す,0＝表示）
home（topページ）へのリンクは大抵サイトロゴやナビゲーションに入ってるので、ぱんくずにまで表示させたくない、という場合に使います。

---

showCrumbsAtHome [ 1 or 0 ]…デフォルトは0
記述例：[[Breadcrumbs &showCrumbsAtHome=`1`]]
home（top）ページに、ぱんくずリストを表示するかどうかを設定します。（0＝隠す,1＝表示）

---

showCurrentCrumb [ 1 or 0 ]…デフォルトは1
記述例：[[Breadcrumbs &showCurrentCrumb=`0`]]
ぱんくずリスト内にカレントページ（現在のページ）を表示するかどうかを設定します。（0＝隠す,1＝表示）

---

currentAsLink [ 1 or 0 ]…デフォルトは0
記述例：[[Breadcrumbs &currentAsLink=`1`]]
ぱんくずリスト内のカレントページ（現在のページ）にリンクを貼るかどうかを設定します。（0＝貼らない,1＝貼る）
1に設定すると、そのページ自体へのリンクが貼られます。

---

crumbSeparator [ 文字列 ]…
記述例：[[Breadcrumbs &crumbSeparator=`»»»`]]
ぱんくず同士をつなぐ記号を設定します。
デフォルトでは【 » 】になっています。

---

homeCrumbTitle [ 文字列 ]…
記述例：[[Breadcrumbs &homeCrumbTitle=`top`]]
ぱんくずリスト内の第一階層（つまり一番左にくるぱんくず）の表示に使う文字列を設定します。
デフォルトでは【 home 】になっています。

---

homeCrumbDescription [ 文字列 ]…
記述例：[[Breadcrumbs &homeCrumbDescription=`topページへのリンク`]]
ぱんくずリスト内の第一階層（つまり一番左にくるぱんくず）にマウスを乗せた時表示されるツールチップの文字列を設定します。
デフォルトでは【 homeCrumbTitleの設定と同じ 】になっています。
実際表示される文字列と異なるものを設定したい時に使います。

---

titleField [ 文字列 ]…
記述例：[[Breadcrumbs &titleField=`longtitle`]]
ぱんくずリスト内に表示するリストタイトルの種類を選択します。
デフォルトでは【 pagetitle 】(modx変数：ページタイトル)になっています。
longtitleなど、modx変数などをリストとして表示できるということですね。でも普通はページタイトルでokでしょう。

---

descField [ 文字列 ]…
記述例：[[Breadcrumbs &descField=`longtitle`]]
ぱんくずにマウスを乗せた時に表示されるツールチップの種類を選択します。
デフォルトでは【 description 】(modx変数：概要）になっています。
そのページに概要が設定されてない時は、「ページタイトル」になります。