自分で、試したり、ドキュメントを読んで、自分なりに理解したことを書いています。
ので、間違いも多くあるかも知れません。間違いがありましたら、どうぞ、ご指摘下さい。
また、書いてある内容を試す場合は、自己責任でお願い致します。
尚サンプルは、こちらに書き出しています。
http://www.liolion.info/modx/resource/Breadcrumbs.html
テスト環境:
サーバ:さくらインターネット
PHP 4.4.4
MYSQL 4.0.27
MODX:0.9.5
Breadcrumbs 0.9d
概要:
Breadcrumbsは、パンくずリストを挿入するスニペットです
基本的な書式:
[[Breadcrumbs]]
パラメータ:
maxCrumbs
フロントページとカレントページの間のパンくずの最大数。デフォルト100
例:
階層レベルが以下のような場合、
frontpage
└level1
└level2
└level3
└level4
└level5
「
maxCrumbs=`2`」とすると、level5での表示は以下の様になる
Front Page » ... » level3 » level4 » level5
つまりカレントドキュメントの直前の2個を表示し、それ以前は省略される
pathThruUnPub
非公開ドキュメント以外を全て表示するか否か。デフォルト「1(表示)」
例:
階層レベルが以下のような場合で、level3が非公開の場合、
frontpage
└level1
└level2
└level3(非公開フォルダ)
└level4
└level5
「
pathThruUnPub=`1`」とすると、level5での表示は以下になる
Front Page » level1 » level2 » level4 » level5
「
pathThruUnPub=`0`」とすると、level5での表示は以下になる
Front Page » level4 » level5
つまりlevel3以前(level2、level1)は、省略される
respectHidemenu
メニューにしないドキュメントを隠すか否か。デフォルト「1(隠す)」
showHomeCrumb
パンくずリストの中で、フロントページへのリンクを表示するか否か。デフォルト「1(表示)」
showCrumbsAtHome
フロントページでパンくずリストを表示するか否か。デフォルト「0(隠す)」
showCurrentCrumb
カレントドキュメント自身のパンくずを表示するか否か。デフォルト「1(表示)」
currentAsLink
カレントドキュメントのパンくずをリンクテキストにするか否か。デフォルト「0(しない)」
crumbSeparator
パンくずを仕切る文字。デフォルト「»」
homeCrumbTitle
フロントページのタイトル。デフォルト「Home」
※homeCrumbTitle=`この中で実体参照は使えない`様なので注意。使うと、表示した時、文字が切れるようです
homeCrumbDescription
フロントページへのリンクのツールチップを変更出来る。デフォルトは「homeCrumbTitle」で定義された値
※homeCrumbDescription=`この中で実体参照は使えない`様なので注意。使うと、表示した時、文字が切れるようです
※以下のふたつのパラメータはちょっとわかりません。。
わかる方、おられましたらフォローお願い致します。
titleField
パンくずとして表示するタイトルを変更出来る??デフォルト「pagetitle」
descField
パンくずとして表示する概要を変更出来る??デフォルト「description」