Breadcrumbs (1.0.1)

参照ページ：Breadcrumbs

基本的な書式

[[Breadcrumbs]]

パラメータ

maxCrumbs

フロントページとカレントページの間のパンくずの最大数を指定します。デフォルト「100」。

インスタンス

例）階層レベルが以下のような場合：

frontpage
　└level1
　　　└level2
　　　　　└level3
　　　　　　　└level4
　　　　　　　　　└level5

「maxCrumbs=`2`」とすると、level5での表示は以下の様になる

Front Page ≫ ... ≫ level3 ≫ level4 ≫ level5

つまりカレントドキュメントの直前の２個を表示し、それ以前は省略されます。

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）」。

インストタンス

スニペットコール例：

[[Breadcrumbs? &showHomeCrumb=`1`]]

出力例：

Front Page » エレメント解説 » Breadcrumbs

スニペットコール例：

[[Breadcrumbs? &showHomeCrumb=`0`]]

出力例：

エレメント解説 » Breadcrumbs

linkTextField

パンくずとして表示するフィールドを指定します。デフォルト「megutitle」

以下を指定できます。

• pagetitle
• longtitle
•  description
•  menutitle

linkDescField

パンくずの説明（title=""）を指定します。デフォルト「longtitle」

以下を指定できます。

• pagetitle
• longtitle
• description
• menutitle

showCrumbsAsLinks

すべてのパンくずリストをリンクテキストにするかどうかを指定します。

デフォルト「1（する）」

templateSet

テンプレートは、コードに定義されています。どちらかのテンプレートを選んで指定します。

　・デフォルトは以下です。

　defaultString

以下が指定できます。

　defaultString．．．以前のバージョンの書式です。

　defaultList．．．リスト形式で出力します。

 crumbGap

以下の様なときの「...」を指定します。

Front Page ≫ ... ≫ level3 ≫ level4 ≫ level5

画像も指定できます。その場合、タグの中で「=」は、使わないでください。かわりに、「||」を使います。

インスタンス

crumbGap=`<img src||"/assets/images/sort.png">`

stylePrefix

 Breadcrumbs は、各パーツごとにクラス名をつけます。その各パーツのクラス名のプリフィックスを指定します。

デフォルト「_B」

各クラス名

• crumbBox. ... パンくずの大外のクラス名
• hideCrumb. ...  "..." などがある場合のクラス名
• currentCrumb ... :現在のリソースのクラス名
• firstCrumb ... 最初のパンくずのクラス名
• lastCrumb ... 最後の版くずのクラス名
• crumb ... 途中のパンくずのクラス名
• homeCrumb ... home のパンくずのクラス名

showHomeCrumb

パンくずリストの先頭にHOMEへのリンクを置くかどうかを指定します。デフォルト「おく（1）」

homeId

パンくずリストの先頭は、通常「サイトスタート」になりますが、それを変更することができます。パンくずリストの先頭に置きたい、リソースIDを指定します。

homeCrumbTitle [ string ]

ホームのリンクテキストを指定します。デフォルトNULL

インスタンス

&homeCrumbTitle=`ホームに戻る`

homeCrumbDescription

ホームリンクの、ツールチップを指定します。デフォルト「メニュータイトル」。

showCrumbsAtHome

フロントページでパンくずリストを表示するかどうかを指定します。デフォルト「しない（0）」

hideOn

パンくずリストそのものを隠したいリソースのIDを指定します。カンマで区切って複数指定できます。

インスタンス

hideOn=`16,18`

リソース16と、リソース18には、パンくずリストが現れません。たくさんある場合には、「hideUnder」を使うと良いでしょう。

hideUnder

直下のサブリソースでパンくずリストを隠します。カンマで区切って複数指定可能です。

インスタンス

以下の様な構成だった場合：

リソースＡ（１）
　└ リソースＢ（２）
　　└ リソースＣ（３）
　　　　└ リソースＤ（４）
　└ リソースＥ（５）
リソースＦ（６）

&hideUnder=`1`

とすると、リソースBと、リソースEで、パンくずリストが出現しません。

stopIds

（動作不明）

Comma separated list of document IDs that when reached, stops Breadcrumbs from going any further. This is useful in situations like where you have language branches, and you don't want the Breadcrumbs going past the "home" of the language you're in.

ignoreIds

パンくずリスト上に表示したくない、リソースをコンマで区切って指定します。デフォルト「なし」

showCurrentCrumb

カレントリソース自身のパンくずを表示するか否か。デフォルト「する（1）」

インスタンス

スニペットコール例：

[[Breadcrumbs? &showCurrentCrumb=`1`]]

出力例：

Front Page » エレメント解説 » Breadcrumbs

スニペットコール例：

[[Breadcrumbs? &showCurrentCrumb=`0`]]

出力例：

Front Page » エレメント解説

currentAsLink

カレントドキュメントのパンくずをリンクテキストにするかどうかを指定します。デフォルト「しない（0）」

Templates

Breadcrumbsのテンプレートは、ここに書きます。コード名は、必ずプリフィックスに、「defaultString」か「defaultList」をつけます。例えば、「defaultStringcode」のようにします。

インスタンス

1.以下の様にコードをワンセット*1をコピーペースとして、名前を変え、コードを書き替えます。

$templates = array(
  'defaultString' => array(
    'crumb' => '',
    'separator' => ' » ',
    'crumbContainer' => '<span class=""></span>',
    'lastCrumbWrapper' => '<span class=""></span>',
    'firstCrumbWrapper' => '<span class=""></span>'
  ),
  'defaultList' => array(
    'crumb' => '<li></li>',
    'separator' => '',
    'crumbContainer' => '<ul class=""></ul>',
    'lastCrumbWrapper' => '<span class=""></span>',
    'firstCrumbWrapper' => '<span class=""></span>'
  ),
  'defaultStringcode' => array(
    'crumb' => '',
    'separator' => ' zzz ',
    'crumbContainer' => '<span class=""></span>',
    'lastCrumbWrapper' => '<span class=""></span>',
    'firstCrumbWrapper' => '<span class=""></span>'
  ),
);

2.&templateSet=`defaultStringcode`　で、テンプレートを指定します。このようにして、テンプレートを増やしていけます。

ワンセット：defaultString

'defaultString' => array(
  'crumb' => '',
  'separator' => ' » ',
  'crumbContainer' => '<span class=""></span>',
  'lastCrumbWrapper' => '<span class=""></span>',
  'firstCrumbWrapper' => '<span class=""></span>'
),

ワンセット：defaultList

'defaultList' => array(
  'crumb' => '<li></li>',
  'separator' => '',
  'crumbContainer' => '<ul class=""></ul>',
  'lastCrumbWrapper' => '<span class=""></span>',
  'firstCrumbWrapper' => '<span class=""></span>'
),