phpMyFAQの環境設定項目を解説～メイン設定編～

カテゴリ一ブログ

2020-01-29 #phpMyFAQ #OSS #オープンソース #FAQ

こんにちは！プログラマ歴約2年目のMです！

最近、業務でオープンソースのFAQシステム「phpMyFAQ」をいじる機会がありました。

システムそのものは日本語対応済みなのですが、インストール方法や使い方等をまとめたドキュメントは英語版のみです。

特に「環境設定」の説明に至っては。。。

Main FAQ configuration Here you can edit the general, the record, spam protection, search and social networks settings of phpMyFAQ. Should you want to enter multiple email addresses in the configuration separate them by a comma (“,”).
※引用：https://www.phpmyfaq.de/docs/3.0#5

和訳：環境設定 ここでは、phpMyFAQのメイン設定、FAQレコード設定、スパム制御、検索、SNS設定を行うことが出来ます。複数のEメールアドレスを設定したい場合は、カンマ(“,”)区切りで記載してください。

合計100近い項目があるにも関わらず、これだけ！！

現状、日本語で具体的な解説を検索してもあまりヒットしないので、自身の備忘録も兼ねて

環境設定の解説や使い方、仕様を本記事にまとめてみようと思います。

1 本記事で解説する項目
2 バージョン情報
3 メイン設定
4 まとめ

本記事で解説する項目

本記事では、「環境設定」の中でも、特に項目数の多い「メイン設定」を解説します。

以下項目の解説は掲載しておりませんので、予めご了承下さい。

FAQレコード設定
検索
セキュリティ構成
スパム制御センター
SEO
SNSの設定
Mail setup

バージョン情報

この記事では、以下のバージョンの機能を基に解説を行います。

phpMyFAQ 2.9.13

メイン設定

メイン設定では、FAQシステム全般にかかわる機能を制御します。全部で29項目です。

※各言語共通で使用できる29項目分のみ解説しています。日本語版にのみ表示される項目に関しては、記載しておりません。

no	項目名	説明
1	Set FAQ in maintenance mode	「FAQをメンテナンスモードにする」有効にすると、FAQサイト側画面がメンテナンスモードに切り替わります。
2	言語	利用言語を設定します。手動で設定するか、もしくはブラウザの言語設定を参照の上自動的に設定されます。(no3参照)
3	言語の自動認識を有効にする	有効にすると、ブラウザの言語設定を参照の上、言語を自動的に設定してくれます。
4	FAQの題名	FAQのタイトルを設定します。設定したタイトルは、FAQサイト側の画面やブラウザのタブに表示されます。
5	FAQバージョン	インストールされているphpMyFAQのバージョンが表示されます(編集不可)
6	ページの説明	ページの説明です。画面には表示されませんがHTMLのheadに組み込まれ、Google等検索エンジンの検索結果に説明文(description)として表示されます。(以下参照)
7	検索ロボット用キーワード	Google等検索エンジンによる検索時に使用されるキーワードです。no6と同じく画面には表示されず、HTMLのheadに組み込まれます。
8	管理者名	一番最初に作成されたユーザーの名前です。
9	管理者の電子メールアドレス	一番最初に作成されたユーザーのメールアドレスです。FAQサイト側画面の「問い合わせ」よりメールを送信した場合、このメールアドレス宛に送信されます。
10	問い合わせ情報	FAQサイト側画面の「問い合わせ」に表示する文面を任意のものに設定します。
11	友達に送信ページのテキスト	FAQサイト側画面にある「友達に教える」機能にて、送信するメールに追加する文言を設定します。(以下赤文字の箇所) ※例えば、上記の画像のように設定した場合、メール文面は以下のようになります。【メール文面例】テスト次のURLからこのFAQの確認ができます： [URL] 補足メッセージです。
12	追跡機能を使用する	「統計＞セッションの閲覧」に、セッション履歴を記録するか否かを設定します。有効にすると履歴が更新されるようになり、無効にすると履歴更新が止まります。
13	管理ログを使用する	「統計」＞「管理ログ」に、履歴を記録するか否かを設定します。有効にすると履歴が更新されるようになり、無効にすると履歴更新が止まります。
14	mod_rewrite のサポートを使用しますか? (初期値: 無効)	有効にすると、各FAQページへのリンクが「~.html」の形になります。Apache側で、動的リンクへリダイレクトするための設定が別途必要になります。例：【有効の場合のURL】https://XXX.jp/ja/FAQとは何の略ですか？.html 【無効の場合のURL】https://XXX.jp//index.php?action=faq&cat=2&id=3&artlang=ja
15	リンク確認の基準 URL (例: http://www.example.org/faq/)	FAQサイト側TOP画面のURL
16	AJAX リンクの確認間隔 (秒単位)	FAQ記事リンクの有効/無効を監視する間隔を設定します。初期値は86400秒(=24時間)
17	同梱の WYSIWYG エディターを有効にする (初期値: 有効)	有効の場合、管理画面側のFAQ追加画面で以下のようなテキストエディターが使えるようになります。no28が有効の場合、自動的に無効となります。 ※no17とno28が両方とも無効である場合、回答記載欄が表示されなくなってしまいます。どちらかは有効にしておきましょう。
18	使用するテンプレート	テンプレートを選択します。初期値は「default」のみ。
19	Mail address as mandatory field (default: deactivated)	「メールアドレスを必須項目にする」。初期値は無効。
20	日付フォーマット (初期値: Y-m-d H:i)	日付表示部分のフォーマットを設定します。
21	Enable bundled WYSIWYG editor in frontend	有効の場合、FAQサイト画面側の「内容の追加」にて、Answer部分にテキストエディターが使えるようになります。無効の場合、Answer記載部分はテキストボックスになります。
22	Gravatar Support (default: disabled)	「Gravatar連携を有効にする」。初期値は無効。
23	RSS Feeds (default: enabled)	「RSSフィード」。有効にすると、FAQサイト画面側でRSSが使えるようになり、画面にRSSのリンクが表示されます。
24	Enable GZIP compression (default: enabled)	「GZIP圧縮を有効にする」。初期値は有効。
25	Enable automatic link verification (default: enabled)	「リンク検証を有効にする」。初期値は有効。
26	Custom PDF Header (HTML allowed)	FAQエクスポート機能(PDF)にて出力されるPDFファイルの、ヘッダー部分を設定できます。
27	Custom PDF Footer (HTML allowed)	FAQエクスポート機能(PDF)にて出力されるPDFファイルの、フッター部分を設定できます。
28	Enable bundled Markdown editor (default: disabled)	「マークダウンエディターを有効にする」。有効にすると、以下のようなエディターが使えるようになります(no17と違い、HTMLで記載していく形式)。 no17が有効の場合は自動的に無効になります。初期値は無効。 ※no17とno28が両方とも無効である場合、回答記載欄が表示されなくなってしまいます。どちらかは有効にしておきましょう。
29	Enable smart answering for user questions (default: activated)	「「質問をする」にてFAQ記事を提案する機能を有効にする」。初期値は有効。 ※「質問をする」にて質問を送信した際、「質問：」に記載された内容で検索をかけます。FAQ記事がヒットした場合、送信処理が行われる前に検索結果を表示させます。