TopicPath
パンくずリストを出力します。Breadcrumbsスニペットと似ていますが、スニペット本体を改造せずにフルカスタマイズを行なえる点が異なります。
ダウンロード
https://github.com/modxcms-jp/evolution-jp/tree/stable/assets/snippets/topicpath
上記から最新版をダウンロードできます。MODX Evolution1.0.5J-r11以降では標準で同梱されています。
インストール
- アーカイブを解凍し、assets/snippets/ ディレクトリにtopicpathフォルダを転送します。
- topicpath.tplをテキストエディタで開き、内容をコピーしてスニペット新規作成画面に貼り付けて保存します。
- スニペット名は「TopicPath」としてください。他の名前でも問題なく使えますが、公式なマニュアルではスニペット名をTopicPathとして解説いたします。
基本的な使い方
テンプレートに [[TopicPath]] と書くだけで動作します。必須パラメータはありません。
見た目に関するパラメータ
TopicPathスニペットは、パンくずリストを５つの要素（ウェブリンク専用の&tplReferenceTopicを含めると６つ）に分けて構成します。各要素のHTMLは、下記のパラメータによって個別に指定できます。
&tplOuter
パンくずリストの最も外側のテンプレートパターン。パン屑リストが不要なページ(トップページなど)では何も出力しません。
デフォルト値 [+topics+]
使用例 <div class="topic_path">[+topics+]</div>
&tplHomeTopic
先頭のパンくず文字列。
デフォルト値 <a href="[+url+]" class="home" title="[+title+]">[+title+]</a>
&tplCurrentTopic
末尾(カレント)のパンくず文字列。
デフォルト値 [+title+]
&tplReferenceTopic
&tplCurrentTopicと同じですが、ウェブリンクの表現を指定したい場合はこのパラメータを指定します。
デフォルト値 [+title+]
&tplOtherTopic
その他のパンくず文字列。先頭の&tplReferenceTopicと末尾の&tplCurrentTopicの間に羅列される部分です。
デフォルト値 <a href="[+url+]" title="[+title+]">[+title+]</a>
&tplSeparator
各トピックを連結する文字列。通常は「 > 」や「 » 」などが用いられます。
デフォルト値 » ( » )
その他のパラメータ
&theme
TopicPath本体にプリセットされているテーマ(レイアウトパターン)を指定します。デフォルトでは直列のパンくずリストを出力しますので、スタイルシートによる調整をしなくてもそのまま使えます。
「list」を指定すると <ul><li>トピック名1</li><li>トピック名2</li><li>カレントトピック</li></ul> 形式で出力します。
使用例：[[TopicPath?theme=list]]
&menuItemOnly
「メニューに表示」をチェックしているリソースのみをパン屑リストに並べる
0|1
&ignoreIDs
パン屑リスト上「に」並べたくないリソース。カンマ区切りで複数指定できます。
&showTopicsAtHome
トップページにもパン屑リストを表示する。実際にはトップのリンクのみが出力されます。
&disabledOn
パン屑リスト「を」表示しないリソース。カンマ区切りで複数指定できます。
&disabledUnder
パン屑リスト「を」表示しないリソース・・・の「上の階層」のリソース。カンマ区切りで複数指定できます。
&limit
パン屑リスト表示数の上限。デフォルトでは100階層以上は表示しません
&topicGap
階層が深すぎて途中を省略した時に、省略部分の代わりに表示する文字列
&titleField
パン屑リストのトピック名として出力する対象フィールド。プレースホルダは[+title+]。デフォルトではmenutitle、入力されてなければpagetitle
&descField
パン屑リストのtips表示文字列として出力する対象フィールド。プレースホルダは[+desc+]。デフォルトではdescription、入力されてなければlongtitle・pagetitle
&homeId
トップとして指定するリソースID。デフォルトでは[(site_start)]
&stopIDs
ここで指定したリソースID以下はパン屑リスト上に並べない
