Template:FAQ/doc
 | これはTemplate:FAQの解説サブページです。 使用方法、カテゴリ、およびその他テンプレート自体に含まれない情報を収容しています。 |
 | このテンプレートはテンプレートスタイルを使用しています: |
 | このテンプレートの記述は複雑な構成となっています。編集後の結果が予想できないか、または変更にともなう影響を修正する用意ができていない場合は編集をお控えください。練習や実験はテンプレートのサンドボックス・サブページ、テストケース・サブページもしくはあなた自身の利用者スペースのページでお願いします。 |
記事[ヘルプ 1]やノートページ[ヘルプ 2]に FAQ サブページ[ヘルプ 3]を追加し、表示できるようにするテンプレート。
使い方
[編集]FAQ下位ページ（質問と回答のシリーズを記述する）はページ上部にFAQテンプレートを置く。ページを編集モードで開き、以下の文章の中から選んで最上部に追加する。
{{FAQ}}
と記述すると、標準的な見出しとなる。
 編集
|
よくある質問 (FAQ) |
|---|---|
| |
実際にFAQ下位ページに記述される質問と回答は、既定ではFAQテンプレートを置いたページで非表示で、利用者が「表示」ボタンを押すと表示される。
- 流用する
FAQを置き、その内容は他のページのFAQを参照読み込みさせることもできる。（内容がよく似た他のページにFAQがある場合、それを流用することで新規作成を避ける。）引数「page」を使うと、例えば下記のサンプルのように他のページのノートページにリンクさせることができる。Anita Sarkeesian:
{{FAQ|page=Talk:Universal Orlando Team Member Tool/FAQ}}
と記述して作成される見出しは
| 編集
|
よくある質問 (FAQ) |
|---|---|
| |
となり、見た目は{{FAQ}}テンプレートに似るが「表示」される内容は別のページのFAQとなる。
- リンク先を示す
他のページのFAQページを流用せず、その存在を読者に伝えるには、引数「see also」を用いるとリンクと一緒に「関連：」という文字列が表示される。
{{FAQ|see also=Wikipedia:FAQ}}と記述すると、次のサンプルのように、読者はウィキペディア全体のFAQページを読むことができる（注意：引数「see also」を使用するときはリンク先のページ名を二重カッコでくくること。）
| 編集
|
よくある質問 (FAQ) (関連： FAQ) |
|---|---|
| |
- 折りたたむ
読者に対して、質問集を折りたたんでおくか展開しておくか指定できる。引数「collapsed」を用いて値を「no」（展開）か「yes」（折りたたむ）に指定する。引数を用いない場合は既定で「yes」となり、折りたたまれる。
{{FAQ|collapsed=yes}}
という記述は次のように表示される。
| 編集
|
よくある質問 (FAQ) |
|---|---|
| |
FAQリストを必ず折りたたんでおくには、「collapsed」「no」と指定する。例えば
{{FAQ|collapsed=no}}
と記述すると、次のような見出しができ、質問と回答を示すQとAは太字で表示される。
| 編集
|
よくある質問 (FAQ) |
|---|---|
| |
- リンク先ページの表示
上記のサンプルでは、「編集」ボタンが左端の大きな疑問符「？」の右隣に、青色のリンクとして表示される。このボタンを押すと、読者は質問集をその場で編集することができる。FAQが表示されたページで編集する前に、実際にリンク先のページを開くように促すには、次のサンプルのように引数「quickedit」を「no」に指定する（既定では「yes」）。
{{FAQ|quickedit=no}}
と記述すると、実際は次のように表示される。
| FAQページ
|
よくある質問 (FAQ) |
|---|---|
| |
- 縮小表示
FAQのボックスをページ上部の横幅いっぱいにではなく、できるだけ小さくページの右端に表示することができる。次のサンプルのように、引数「small」を「yes」に指定する（既定値は「no」）。
{{FAQ|small=yes}}
と記述すると、次のサンプルのとおり表示される。
| 編集
|
FAQ |
|---|---|
| |
- ノートページに置いた場合
FAQをノートページに置いた場合、他のページ（水色）とは異なり、バナーの色が淡い茶色となる。読者はこれでFAQページの種類を判別できる。{{FAQ}} （ノートページの場合）と記述すると、ノートページには次のサンプルのとおり表示される。
| 編集
|
よくある質問 (FAQ) |
|---|---|
| |
{{FAQ|small=yes}} （ノートページに置き、縮小表示する場合）
| 編集
|
FAQ |
|---|---|
| |
- 引数の順序、区切り
テンプレート内で引数の順序に決まりはなく、一部の省略もしくはまったく用いないことも選択できる。テンプレートを正常に表示させるには、引数の間をパイプ記号（|）で区切り、テンプレートの前後を二重カッコでくくる。
FAQ質問集を作成するには、FAQを設けるページに{{FAQ}}テンプレートを置いて必要な引数を記述し、「保存」を押し、FAQボックスが表示されたことを確認する。次に、実際にFAQ下位ページを作成するには、FAQバナーの「編集」リンク（もしくは引数「quickedit」を「no」に指定した場合は「FAQページ」へのリンク）を押して移動する。ノートページでFAQ節が実際に作動するサンプルは、Talk:Taoを参照。ページ上部にFAQ節がある。
節の見出し
[編集]通常、FAQテンプレート内に節見出しを作ることはできない。もし作ると、その下位ページだけではなく、FAQを参照読み込みするページの見出し一覧に、FAQの見出しが反映される。回避するには、次のマークアップを用いる。
<includeonly>;</includeonly><noinclude>==</noinclude>Heading name<noinclude>==</noinclude>とその行に記述する。下位ページ /FAQ 自体にはナビゲート用に==Heading name==の形で節見出しが作られる。参照読込先（記事ページやノートページ）では「見出し」;Heading nameのように太字で表示される。（この方法は、{{To do}}リストが長文化するときにも応用できる。）
引数
[編集]| 引数 | 指定内容 | 既定値 | 説明 |
|---|---|---|---|
| see also | ページ名 | （なし） | 関連項目へのリンクを追加する |
| collapsed | yes または no | yes | |
| quickedit | yes または no | yes | FAQサブページの編集リンクを有効にする |
| small | yes または no | no | 小型にする |
| demospace |
関連項目
[編集]類似のテンプレート：
- {{FAQ}} – 基本形、展開したリスト
- template:FAQ 折りたたみ – 折りたたんだ質問集
- template:FAQ group begin – 質問をグループ化（開始）
- template:FAQ group end – 質問をグループ化（終了）
- template:FAQ ページ – 別の FAQ ページ上部に表示するメッセージ
- Template:循環定義 – FAQ ではない（FAQ へのリンク）; 議論再開に対する警告
- Template:FAQ テンプレート関連項目
注釈
[編集]