Wayfinderの使い方 - Lesson#1 その1

2009年11月28日 00:59

The Almost Complete Guide to Creating Menus in MODx using Wayfinderの拾い読みをメモ。

全140ページ近い英文PDFなので、端折りに端折ってます。感覚的に意訳しているので、もし参考にされる場合はその点に留意してください。

まずChapter 2 Lesson #1

ここではレストランのサイトを例にWayfinderの基本的な使い方を解説しています。

Lesson #1の概要

スニペットの記述方法
メニュー構造のベースとなる&outerTplを作る

関連するプレースホルダ/変数ほか
&startID
[+wf.classes+]
[+wf.classnames+]
[+wf.wrapper+]
&outerClass
&outerTpl
Wayfinderのパラメータは以下のようにカテゴライズできる。
ドキュメントをリスト化するためのパラメータ
CSSのクラス名を扱うパラメータ
プレースホルダを扱うパラメータ
テンプレート用パラメータ
ユーティリティ用パラメータ


Wayfinderの大まかな機能
MODxのドキュメント構造をリスト形式で出力する。
出力にはXHTMLの<ul>および<li>要素を使用する。
並べ替えの指定ができる。
スタイルシートの設定ができる。
プレースホルダを指定できる。
テンプレート(チャンク)を使用できる。
ユーティリティパラメータを指定できる。

これらの機能により、リンクテキストをプレースホルダを使って自動挿入したり、CSSクラスを使ってメニューのレイアウトデザインを指定することができる。


スニペットコール(機能の呼び出し方)
ドキュメント上に以下のような記述をすることでそこにWayfinderの出力結果を挿入することができる。

[[Wayfinder? &startID=`0`]] <出力結果をキャッシュする場合
[!Wayfinder? &startID=`0`!] <出力結果をキャッシュしない場合

パラメータの値はシングルクォートでなくバッククォート(原文ではbackticks)で括る。


&startID パラメータについて
&startIDパラメータは必須。これがないとメニューの起点となるドキュメントを指定できない。
&startIDで指定したドキュメントの下位のドキュメントを階層の深さに関わらず出力する。
値が`0`のとき、MODxの全ドキュメントを出力する(公開されていないもの、メニューに表示しないように設定しているモノを除く)。
パラメータを加えることで表示方法を制御できる。

サンプルサイトでのドキュメント構造の例(カッコ内はドキュメント番号)
 Home(1)
 About(2)
 Reservations(3)
 Menus(4)
 Awards(5)
 Locations(6)
  St.James Park(8)
  Aldington(9)
 Contact(7)

上記には表示されない(ドキュメントとしては存在していないため)が、サイトのルートが(0)で表される。そのため&startID=`0`を指定することで、全ページ(ルートの下位ドキュメントすべて)がメニューとして表示される。

&startIDの値は`0`である必要はなく、任意の値を指定できる。`1`を指定した場合、Homeには子ドキュメントがないため、結果的になにも表示されない。
しかし、`6`を指定した場合Locationsの下にある、St James ParkとAldingtonのふたつがメニューとして表示される。

 


以上が、page3~10のおおまかな内容です。
スポンサーサイト


コメント

    コメントの投稿

    (コメント編集・削除に必要)
    (管理者にだけ表示を許可する)

    トラックバック

    この記事のトラックバックURL
    http://flyingjunk.blog25.fc2.com/tb.php/182-13062edb
    この記事へのトラックバック


    最近の記事

    オンラインアルバム