[スニペット] FAQList（FAQを簡単に作成できる）

[Guest]

Welcome, Guest. Please login or register.
Did you miss your activation email?

1 Hour 1 Day 1 Week 1 Month Forever
Login with username, password and session length

[MEGU]

概要
FAQListは、ListFAQfolder の亜種で、簡単にFAQページを作成でき、カテゴリー分けも可能です。
尚、FAQList では、出力テンプレートの指定が出来るよう改造されています。

ダウンロード


インストールとアンインストール

インストール
   1.  ダウンロード先からダウンロードしたZipファイルを解凍します。
          * FAQList.snippets.php が現れます。
   2. MODxの管理画面＞リソース＞リソース管理＞スニペット　「スニペットの作成」と進みます。
   3. 以下の要項で入力します
          * スニペット名：FAQList
          *  スニペット コード (php) ：FAQList.snippets.php の内容を丸ごとコピー
          * その他の項目：任意
   4. 保存します

アンインストール
上記で作成したスニペットを削除します。


使い方

★基本的な書式

Code:

[[FAQList]]

または

Code:

[!FAQList!]

★運用方法
   1.  新たにドキュメントを作成します。「FAQ」というタイトルで良いでしょう。
   2. ドキュメント「FAQ」の下に３つのカテゴリが出来るように、３つのドキュメントを作ってみます。
   3.  カテゴリＡ、Ｂ、Ｃの下に、質問と答えを書く、ドキュメントを作成します。以下が入力必須項目です。
          * タイトル ... 入力してもデフォルトでは表示されません
          * 要約 ... 質問を書きます
          * 内容 ... 答えを書きます
   4. [FAQ]、[カテゴリＡ]、[カテゴリＢ]、[カテゴリＣ]、にスニペットコールを書きます

          * [[FAQList]] または [!FAQList!]

          * [FAQ] ←スニペットコール
            　└ [カテゴリＡ]　 ←スニペットコール   
            　　　　└ 質問と答え１
            　　　　└ 質問と答え２
            　└ [カテゴリＢ]　 ←スニペットコール
            　　　　└ 質問と答え３
            　　　　└ 質問と答え４
            　└ [カテゴリＣ]　 ←スニペットコール
            　　　　└ 質問と答え５

v0.2では以下の現象は直っています。

★注意事項
スニペットコールを書いたドキュメントが「フォルダ」になっていないとエラーが起きますので、注意してください。
基本的に、ドキュメントの下にドキュメントを作成すれば、上のドキュメントは、自動的に「フォルダ」として認識されますのであまり意識しなくても結構です

注意したいのは、例えば以下のような場合：

[FAQ] ←スニペットコール
　└ [カテゴリＡ]　 ←スニペットコール   
　　　　└ 質問と答え１
　　　　└ 質問と答え２
　└ [カテゴリＢ]　 ←スニペットコール
　　　　└ 質問と答え３
　　　　└ 質問と答え４
　└ [カテゴリＣ]　 ←スニペットコール
　　　　子なし

「カテゴリＣ」がフォルダになっていないとエラーになります。

★パラメータ
startID
FAQ用のドキュメントを格納するドキュメント（フォルダ）のIDを指定します。デフォルトはカレントドキュメント

catTpl
カテゴリの出力形式用のテンプレートをチャンクで指定します。

itemTpl
質問及び答えの出力形式用のテンプレートをチャンクで指定します。


リソースの情報

作者	★ZeRo
Webサイト	★http://www.petit-power.com/
リソース名	★FAQList
バージョン	★0.2
ライセンス	★GPL
動作環境	★MODx 0.9.6系（evo系）
リソースの種別	★スニペット
タグ	★FAQ/スニペット
解説	★MEGU
サンプル/解説	★FAQListサンプル / FAQList解説(こちらのサイトの文献はGFDLではありません)

[MEGU]

エラーが修正されたv0.2がリリースされました。
利用方法については0.1と同じです。

ダウンロードのリンク先は、v0.2に変更になっています。

[aco]

こんにちは
すばらしいスニペット＆スニペット解説、ありがとうございます＞ZeRoさん、MEGUさん

FAQコンテンツって結構作成する場面がありそうな気がするのですが、
特化してるスニペットがほとんどなかったので、とても助かります。
# Jotで作ったりしてましたが、やっぱり管理画面で一括管理できる方が運営も楽です。

解説のページを見ていて一つだけ気になったところがあります。
テンプレート内に

Code:

{+title+}

を入力すると、pagetitleが取得されるとのことだったのですが、
今ダウンロードできるバージョンでは、longtitleが取得されているようです。

MEGUさんの解説ページにある「カスタマイズ」の項目を読んで解決したのですが、
念のため、ご報告させていただきます。

[MEGU]

ぁああ～。すみませんんん。
acoさん。どうもありがとうございます。
自分で直したファイルの方をアップしてしまってたようです。
ご報告どうもありがとうございます。

面倒かけてしまってごめんなさい。
ZeRoさんにもごめんなさい。。

オリジナルのものをここにアップし直します。

「ダウンロード」からのリンクも直しておきました。