[green]概要[/green]
FAQListは、
ListFAQfolder の亜種で、簡単にFAQページを作成でき、カテゴリー分けも可能です。
尚、FAQList では、出力テンプレートの指定が出来るよう改造されています。
ダウンロード
[green]インストールとアンインストール[green]
インストール
1. ダウンロード先からダウンロードしたZipファイルを解凍します。
* FAQList.snippets.php が現れます。
2. MODxの管理画面>リソース>リソース管理>スニペット 「スニペットの作成」と進みます。
3. 以下の要項で入力します
* スニペット名:FAQList
* スニペット コード (php) :FAQList.snippets.php の内容を丸ごとコピー
* その他の項目:任意
4. 保存します
アンインストール
上記で作成したスニペットを削除します。
[green]使い方[/green]
★基本的な書式
または
★運用方法
1. 新たにドキュメントを作成します。「FAQ」というタイトルで良いでしょう。
2. ドキュメント「FAQ」の下に3つのカテゴリが出来るように、3つのドキュメントを作ってみます。
3. カテゴリA、B、Cの下に、質問と答えを書く、ドキュメントを作成します。以下が入力必須項目です。
* タイトル ... 入力してもデフォルトでは表示されません
* 要約 ... 質問を書きます
* 内容 ... 答えを書きます
4. [FAQ]、[カテゴリA]、[カテゴリB]、[カテゴリC]、にスニペットコールを書きます
* [[FAQList]] または [!FAQList!]
* [FAQ] ←スニペットコール
└ [カテゴリA] ←スニペットコール
└ 質問と答え1
└ 質問と答え2
└ [カテゴリB] ←スニペットコール
└ 質問と答え3
└ 質問と答え4
└ [カテゴリC] ←スニペットコール
└ 質問と答え5
v0.2では以下の現象は直っています。
★注意事項
スニペットコールを書いたドキュメントが「フォルダ」になっていないとエラーが起きますので、注意してください。
基本的に、ドキュメントの下にドキュメントを作成すれば、上のドキュメントは、自動的に「フォルダ」として認識されますのであまり意識しなくても結構です
注意したいのは、例えば以下のような場合:
[FAQ] ←スニペットコール
└ [カテゴリA] ←スニペットコール
└ 質問と答え1
└ 質問と答え2
└ [カテゴリB] ←スニペットコール
└ 質問と答え3
└ 質問と答え4
└ [カテゴリC] ←スニペットコール
子なし
「カテゴリC」がフォルダになっていないとエラーになります。
★パラメータ
startID
FAQ用のドキュメントを格納するドキュメント(フォルダ)のIDを指定します。デフォルトはカレントドキュメント
catTpl
カテゴリの出力形式用のテンプレートをチャンクで指定します。
itemTpl
質問及び答えの出力形式用のテンプレートをチャンクで指定します。
[green]リソースの情報[/green]
[table]
[tr][td]
作者[/td][td]★ZeRo[/td][/tr]
[tr][td]
Webサイト[/td][td]★
http://www.petit-power.com/[/td][/tr]
[tr][td]
リソース名[/td][td]★FAQList[/td][/tr]
[tr][td]
バージョン[/td][td]★0.2[/td][/tr]
[tr][td]
ライセンス[/td][td]★GPL[/td][/tr]
[tr][td]
動作環境[/td][td]★MODx 0.9.6系(evo系)[/td][/tr]
[tr][td]
リソースの種別[/td][td]★スニペット[/td][/tr]
[tr][td]
タグ[/td][td]★FAQ/スニペット[/td][/tr]
[tr][td]
解説[/td][td]★MEGU[/td][/tr]
[tr][td]
サンプル/解説[/td][td]★
FAQListサンプル /
FAQList解説(こちらのサイトの文献はGFDLではありません)[/td][/tr]
[/table]