ツリー形式でメニューを表示する Wayfinder

このエントリーをはてなブックマークに追加

ナビゲーションメニュー用のスニペットです。パラメータはチートシートからコピペで実際試しながら翻訳中。
Wayfinderはエイリアスを取得するため、フレンドリーURLを使用していない場合エイリアスがかぶっていると取得されないようです。
フレンドリーURLを使用しない場合は、エイリアスを空にするか他とかぶらないものを付ける必要があるようです。

スニペットコール例

[[Wayfinder? &startId=`10`]]

パラメータ&プレースホルダ

基本的な項目だけ表示 全てを展開

&startId

取得するフォルダのリソースID
デフォルト
現在のリソースID
備考
The starting point (document ID) for the menu to list documents from. Specify 0 to start from the site root. 

&displayStart

見出しを表示します
デフォルト
備考
StartIDのリソースがある場合タイトルの見出しを表示します(0では何も表示されません)

&level

取得するツリーの深さ
デフォルト
備考
Depth (number of levels) to build the menu from. '0' goes through all levels. 

&limit

取得するリソース数
デフォルト
備考
The limit parameter causes Wayfinder to only process the number of items specified per level. 

&ignoreHidden

メニューに表示をチェックをしていないリソースの表示
デフォルト
備考
Ignore the "Show in menu" checkbox for documents, and include them in the menu anyway. 

&ph

デフォルト
備考
Name of a placeholder to set with the output results, instead of directly returning the output. 

&debug

デバッグモード
デフォルト
備考
Set to '1' to enable debug mode for extra troubleshooting. 

&hideSubMenus

サブメニューを非表示にする
デフォルト
備考
Set to '1' to only output the active submenu. 

&removeNewLines

未確認
デフォルト
備考
Set to '1' to remove newline characters from the output. 

&textOfLinks

リンクのテキスト部分に使用されるフィールド
デフォルト
menutitle
備考
The field to get the actual link text from. Possible values: menutitle, id, pagetitle, description, parent, alias, longtitle, introtext

&titleOfLinks

リンクのタイトル属性部分に使用されるフィールド
デフォルト
pagetitle 
備考
The field to get the link title from. Possible values: menutitle, id, pagetitle, description, parent, alias, longtitle, introtext

&rowIdPrefix

ツリーにリソースID付きのユニークなIDを付ける場合のプレフィックス
デフォルト
備考
例えば&rowIdPrefixを「res」にした場合リソースID10なら<LI>タグにid=”res10”というIDが付きます。

&useWeblinkUrl

デフォルト
備考
When set to 1, the link specified in a weblink document will be output to the placeholder [wf.link] instead of the link to the weblink. 

&includeDocs

オプション
カンマで区切られたリソースID
備考
Comma separated list of document IDs to be included in the menu.

&excludeDocs

オプション
カンマで区切られたリソースID
デフォルト
備考
Comma seperated list of document IDs to be excluded from the menu. 

&cacheResults

クエリーをキャッシュする (added in 2.2.0-rc1) 
デフォルト
 

&cacheTime

&cacheResults のキャッシュ有効期限
オプション
秒数を表す数字
デフォルト
3600
備考
The number of seconds to store the cached menu, if cacheResults is 1. Set to 0 to store indefinitely until cache is manually cleared.

&contexts

(added in 2.2.0-rc1) 
備考
Contexts to use for building the menu. Defaults to the current context.

&startIdContext

(added in 2.2.0-rc1) 

&config

Configファイルを読み込む
備考
snippets/wayfinder/configs/の中に作られたファイルを読み込めます

&scheme

(added in 2.3.1-pl) 
デフォルト
-1
備考
format for how URLs are generated. Possible values are (based on makeURL API call): 
-1 - (default value) URL is relative to site_url
0 - see http
1 - see https
full - URL is absolute, prepended with site_url from config
abs - URL is absolute, prepended with base_url from config
http - URL is absolute, forced to http scheme
https - URL is absolute, forced to https scheme  (added in 2.3.1-pl) 

&sortBy

ソートするフィールド
備考
指定しなければデータベースの並び順で取得
関連
&sortOrder

&sortOrder

昇順OR降順
オプション
ASC | DESC
備考
&sortByが指定されている場合は必須です
関連
&sortBy

&where

JSON書式で記述されたWhere文でフィルタリングします
備考
JSON style filtering option. For example when trying to hide blog or news from the Articles addon: &where=`[{"class_key:!=": "Article"}]`

&hereId

デフォルト
iterated ID
備考
Define the current ID to use for the snippet. Use a value of [[*id]] if the template specified by hereTpl and activeRowParentTpl is not applied correctly to the menu item. See here for more information.

&cssTpl

追加のCSSがある場合記述できます
備考
Name of a chunk containing the CSS you would like added to the page when the Wayfinder call is present. 

&jsTpl

追加のjavascriptがある場合記述できます
備考
Name of a chunk containing the JavaScript you would like added to the page when the Wayfinder call is present.

テンプレート用パラメータ&プレースホルダ

基本的な項目だけ表示 全てを展開

&outerTpl

基本のツリー外枠用(<UL>)
オプション
{{chunk_name}} | @CODE | @FILE
デフォルト
<ul[+wf.classes+]>[+wf.wrapper+]</ul>
備考
ツリーを囲むためのテンプレート

&rowTpl

基本のリソース用(<LI>)
オプション
{{chunk_name}} | @CODE | @FILE
デフォルト
<li[+wf.id+][+wf.classes+]><a href="[+wf.link+]" title="[+wf.title+]" [+wf.attributes+]>[+wf.linktext+]</a>[+wf.wrapper+]</li>
備考
通常のリソース用のテンプレート

&startItemTpl

メニューの見出し
オプション
{{chunk_name}} | @CODE | @FILE
デフォルト
<h2[+wf.id+][+wf.classes+]>[+wf.linktext+]</h2>[+wf.wrapper+]
備考
Name of the chunk containing the template for the start item, if enabled via the &displayStart parameter. Note: the default template shows the start item but does not link it. If you do not need a link, a class can be applied to the default template using the parameter &firstClass=`className`.

&parentRowHereTpl

子リソースを持っているカレントリソース用
オプション
{{chunk_name}} | @CODE | @FILE
備考
設定されていなければ&rowTplが使用されます

&parentRowTpl

子リソースを持っているリソース用
オプション
{{chunk_name}} | @CODE | @FILE
備考
設定されていなければ&rowTplが使用されます

&hereTpl

カレントリソース用(<LI>)
オプション
{{chunk_name}} | @CODE | @FILE
備考
設定されていなければ&rowTplが使用されます

&innerTpl

2階層目以降のツリー外枠用(<UL>)
オプション
{{chunk_name}} | @CODE | @FILE
備考
設定されていなければ&outerTplが使用されます

&innerRowTpl

2階層目以降のリソース用(<LI>)
オプション
{{chunk_name}} | @CODE | @FILE
備考
設定されていなければ&rowTplが使用されます

&innerHereTpl

2階層目以降の現在のリソース用(<LI>)
オプション
{{chunk_name}} | @CODE | @FILE
備考
設定されていなければ&hereTplが使用されます 

&activeParentRowTpl

カレントの全ての親リソース用(<LI>)
オプション
{{chunk_name}} | @CODE | @FILE
備考
設定されていなければ&parentRowTplが使用されます

&categoryFoldersTpl

カテゴリーとみなされるリソース用
オプション
{{chunk_name}} | @CODE | @FILE
備考
(blank)テンプレートを使用しているかリンク属性に「rel="category"」と指定されているもの

[+wf.classes+]

クラス属性
備考
「class="クラス名"」という形で表示されます
関連
&outerTpl, &rowTpl

[+wf.classnames+]

属性名なしのクラス名
備考
「クラス名」のみが表示されます
関連
&outerTpl, &rowTpl

[+wf.link+]

固有のリソースへのURL
備考
the href value for your link
関連
&rowTpl

[+wf.title+]

固有のリソース名
備考
&titleOfLinks で指定されたフィールド
関連
&titleOfLinks, &rowTpl

[+wf.linktext+]

固有のリンク済のテキスト
備考
&textOfLinks で指定されたフィールド
関連
&textOfLinks, &rowTpl

[+wf.wrapper+]

下階層のリストが入ります
備考
outputs inner contents such as submenus
関連
&outerTpl, &rowTpl

[+wf.id+]

固有のユニークID
備考
outputs a unique ID attribute. You will need to specify the &rowIdPrefix parameter in order for this placeholder to receive a value. The value is your prefix + the docId.
関連
&rowTpl

[+wf.attributes+]

固有のリンク属性(link_attributes)
関連
&rowTpl

[+wf.docid+]

固有のリソースID
備考
the document identifier for the current item
関連
&rowTpl

[+wf.description+]

固有のリソース説明(description)
備考
the current item's description
関連
&rowTpl

CSSクラス用パラメータ

基本的な項目だけ表示 全てを展開

&firstClass

各ツリーの最初の要素に付けるクラス

&lastClass

各ツリーの最後の要素に付けるクラス
デフォルト
last 

&hereClass

現在のリソース要素とその親に付けるクラス
デフォルト
active 

&selfClass

現在のリソースに付けるクラス

&parentClass

子リソースを持っているリソースに付けるクラス
デフォルト
parent 
備考
子リソースを持っていても、Wayfinderのlevel制限で取得していないなければコンテナと判断されないようです

&rowClass

各リソースに付けるクラス
備考
通常の<LI>タグにつきます

&levelClass

ツリーの階層数を表すクラスを付ける場合のプレフィックス
備考
「level」とした場合、1階層目は「level1」2階層目は「level2」というクラスが付きます。

&outerClass

1階層目のツリー要素を囲むための<UL>要素につけるクラス

&innerClass

2階層目以降のツリー要素を囲むための<UL>要素につけるクラス

&webLinkClass

リソースがウェブリンクの時に付けるクラス
Edited on 2014.05.27 Created on 2012.12.01 MODXEvoアドオン
PAGE TO TOP