FAQList 0.2

[ スニペット ]

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

ダウンロード：公式フォーラム/国産リソース/FAQList

テスト環境

サーバ：さくらインターネット　
- PHP 5.2.6
- MYSQL 4.0.27
サーバ：XREA 　
- PHP 5.2.3
- MYSQL 5.1.20-beta
MODx： 0.9.6.1系
FAQList 0.2

導入方法

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

基本的な書式

[[FAQList]]

または

[!FAQList!]

運用方法

以下に運用方法の例を示します。

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

ドキュメントツリーは、以下のような感じになります。

[FAQ]
　└ [カテゴリＡ]	
　　　　└ 質問と答え１
　　　　└ 質問と答え２
　└ [カテゴリＢ]
　　　　└ 質問と答え３
　　　　└ 質問と答え４
　└ [カテゴリＣ]
　　　　└ 質問と答え５

※[ ] は、フォルダを現しています

[FAQ]、[カテゴリＡ]、[カテゴリＢ]、[カテゴリＣ]、にスニペットコールを書きます

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

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

[FAQ]での表示は、以下のようになります。

・カテゴリＡ(2)
・カテゴリＢ(2)
・カテゴリＣ(1)

注意事項

カテゴリとしたドキュメントがフォルダになってない場合：

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

カテゴリCがフォルダになってない場合、[FAQ]を表示すると、カテゴリCに書いてあるスニペットコールがそのまま表示されることになります。

カテゴリCがフォルダになっていれば、[FAQ]での表示は、以下のようになります。

・カテゴリＡ(2)
・カテゴリＢ(2)
・カテゴリＣ(0)

フォルダになっているかどうかの確認は以下で出来ます。

管理画面＞ドキュメントの編集画面＞ページ設定タブ　「フォルダ」　にチェックが入っていれば、OKです。

カテゴリ下のドキュメントが非公開だった場合：

例えば以下のような場合：

[FAQ] 
　└ [カテゴリＡ]	
　　　　└ 質問と答え１　公開
　　　　└ 質問と答え２　公開
　└ [カテゴリＢ]
　　　　└ 質問と答え３　非公開
　　　　└ 質問と答え４　非公開
　└ [カテゴリＣ]
　　　　└ 質問と答え５　公開

[FAQ]での表示は以下のようになります。

・カテゴリＡ(2)
・カテゴリＢ(0)
・カテゴリＣ(1)

パラメータ

startID

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

catTpl

カテゴリの出力形式用のテンプレートをチャンクで指定します。デフォルトは以下です。

<ul>
<!-- start -->
<li><a href="[~{+id+}~]" title="{+title+}">{+title+}</a>({+count+})</li>
<!-- end -->
</ul>

itemTpl

質問及び答えの出力形式用のテンプレートをチャンクで指定します。デフォルトは以下です。

<dl>
<!-- start -->
<dt>{+q+}</dt>
<dd>{+a+}</dd>
<!-- end -->
</dl>

テンプレートで使用できる独自変数タグ

※プレイスホルダと同じと思って問題ありません。ただし、この変数タグは、　～　　の間でのみ有効です。またカッコは、「[ ]」でなく、「{ }」になります。注意してください※

catTpl

{+id+} ... 対象ドキュメントのIDを挿入します
{+title+} ... 対象ドキュメントのpagetitle を挿入します
{+count+} ... 子ドキュメントの数を挿入します

itemTpl

{+id+} ... 対象ドキュメントのIDを挿入します
{+title+} ... 対象ドキュメントのpagetitle を挿入します
{+q+} ... 質問を挿入します（「要約」部分）
{+a+} ... 答えを挿入します（「内容」部分）

カスタマイズ

pagetitle でなく、longtitleを挿入する

プログラムコードの以下の部分を変更します

if ($child['isfolder'] == '1') {
$categorys[] = array(
"id" => $child['id'],
"title" => $child['pagetitle'],
"count" => count($modx->getDocumentChildren($child['id'],1,0,'id,isfolder','isfolder=0'))
);
} else
{ $items[] = array(
"id" => $child['id'],
"title" => $child['pagetitle'],
"q" => $child['introtext'],
"a" => $child['content']
);
}

↓

if ($child['isfolder'] == '1') {
$categorys[] = array(
"id" => $child['id'],
"title" => $child['longtitle'],
"count" => count($modx->getDocumentChildren($child['id'],1,0,'id,isfolder','isfolder=0'))
);
} else
{ $items[] = array(
"id" => $child['id'],
"title" => $child['longtitle'],
"q" => $child['introtext'],
"a" => $child['content']
);
}