基本的なパラメータ
&startId - 基点となるリソースを指定する
基点となるリソースを指定します。基点となるリソース自体は出力されません。
「parent」を指定した場合は親リソースを、「index」を指定した場合は設置リソースがサブリソースを持つかどうかによって動的に出し分けます。
- 指定できる値：任意のリソースID・または0(ルート)・parentまたはp・indexまたはi
- デフォルト値：カレントリソースのID
&level - 出力する階層の深さを指定する
Wayfinderは複数の階層に渡るリソースの一覧をツリー形式で出力できますが、この階層の深さを指定します。デフォルトでは「0」がセットされており、全階層を出力対象とします。
- 指定できる値：整数値または0
- デフォルト値：0
&limit - 階層あたりのリソース数を制限
階層あたりのリソース出力数を制限します。デフォルトでは「0」がセットされており、階層内の全リソースを一覧出力します。
- 指定できる値：任意の整数値または0
- デフォルト値：0
&displayStart
&startItemTplパラメータと連携して利用します。&displayStartパラメータを利用すると、出力されるリストの最上位階層のリソースに関してHTML文を追加で出力できます。幹となる各ツリーをカテゴリーと見立てて、それぞれを見出しとして装飾したい場合にこのパラメータを使うとよいでしょう。
デフォルトでは「0」がセットされており、見出しに相当するHTMLを出力しません。
<h2[+wf.id+][+wf.classes+]>[+wf.linktext+]</h2>
「1」をセットしてパラメータを有効にすると、デフォルトでは上記のようなHTMLが各トップのリソースに対して追加で出力されます。このHTMLの内容は&startItemTplパラメータを指定することで自由に変更できます。
- 指定できる値：0または1
- デフォルト値：0
備考：This parameter is ignored if &startId is 0 (zero).
&ignoreHidden
Wayfinderはデフォルトでは「メニューに表示」にチェックが入ったリソースのみを出力対象とします。このパラメータを指定すると、メニューに表示しないリソースも出力対象になります。
- 指定できる値：0または1
- デフォルト値：0
&ph
スニペットコールで得た出力結果を、同じページ内の他のブロックで再利用できます。メンテ対象を１ヶ所にまとめることができるため便利です。デフォルト「しない（false）」。利用する場合は、プレイスホルダ名を指定します。
例：たとえばヘッダ付近とフッタ付近にパンくずリストを出力したい場合。
「&ph=breadcrumb」とし、ドキュメントの任意の場所に[+breadcrumb+]と記述します。
&hideSubMenus
Wayfinderはデフォルトではツリーに属する全てのリソースを対象として出力します。このパラメータを指定すると、現在開いているリソースのサブリソースのみを展開して出力します。他のリソースのサブリソースは展開しません。
- 指定できる値：0または1
- デフォルト値：0
&includeDocs
By default, Wayfinder will not list documents that MODx thinks should be invisible to the current user. This includes documents for which the user is unauthorized, that have their "show in menu" boxes unchecked, that have been deleted but not yet purged [???], etc. But if there are certain documents you wish to have listed despite these restrictions , then you can list them in this parameter and Wayfinder will include them in its output.
- 指定できる値：任意のリソースのID(コンマで区切って複数指定できます)
- デフォルト値：なし
備考：
- This parameter was added in Wayfinder 2.0.
- I think this only affects the visibility of documents that are below &startId in the document tree.
&excludeDocs
By default Wayfinder lists all documents that MODx thinks should be visible to the current user. But if there are certain documents you don't want listed under any condtion, then you can list them in this parameter and Wayfinder will exclude them from its output.
- 指定できる値：任意のリソースのID(コンマで区切って複数指定できます)
- デフォルト値：なし
