Documentation

ナレッジベースシステム設定

管理者は、システム設定UIを使用して、ナレッジベースのグローバル設定(サイト間)を設定できます。 このUIへは、 [コントロールパネル] → [設定] → [システム設定] → [ナレッジベース] からアクセスできます。 ナレッジベースの構成設定には、次の5つのセクションがあります。

  • ナレッジベースサービス

  • ナレッジベース記事

  • ナレッジベース表示

  • ナレッジベース検索

  • ナレッジベースセクション

ナレッジベースサービス] セクションの設定では、すべてのナレッジベースウィジェットとサイト管理のナレッジベースアプリにデフォルトが適用されます。 他のセクションは特定のナレッジベースウィジェットに適用され、 ナレッジベースサービス のデフォルトを上書きします。

   ナレッジベースアプリケーションのシステム設定の詳細設定は、Liferay DXP管理者のみが実行する必要があります。

ナレッジベースには、デフォルトで無効になっているオプション機能がいくつかありますが、システム設定から有効にして設定できます。 これらには、インポーターファイルの規則、新しい記事の優先度の増分、ソースURL、およびセクション名が含まれます。

インポーターファイルのコンベンション設定

これらの設定は、サポートされるファイル拡張子、親ファイルのサフィックス、およびインポートされたZIPファイル内の画像フォルダのパスを定義します。 これらの設定には、ナレッジベースシステム設定の [ナレッジベースサービス] セクションからアクセスできます。

次の設定は、インポーターがサポートするファイル拡張子を指定します。

Markdown インポーターアーティクルエクステンション: サポートされている記事の拡張子を設定します。 デフォルト値は .markdown および .md です。

Markdown インポーター画像ファイルエクステンション: サポートされている画像のファイル拡張子を設定します。 デフォルト値は .bmp.gif.jpeg.jpg.png です。

サポートされているファイル拡張子を変更するには、

  1. 設定の横にある[+]または[-]ボタンをクリックして、サポートされているファイル拡張子をそれぞれ追加または削除します。

  2. 拡張子を追加する場合は、新しい値を入力します。

  3. 保存] をクリックします。

次の設定は、インポーターの追加の記事設定オプションを定義します。

Markdown インポーターアーティクルイントロ: 親記事のファイルサフィックスを設定します。 デフォルト値は intro.markdown です。

Markdown インポーター画像フォルダ: インポーターがZIPファイルで検索する画像のフォルダパスを設定します。 デフォルトのパスは /images です。

記事インクリメント優先度を有効にする: 有効にすると、新しい記事の優先度を 1.0 ずつ増やします。 この増分を無効にして、記事が 1.0 のフラット値を取得するようにするには、チェックボックスの選択を解除します。

または、システム設定の対応するウィジェットの設定メニューで、各ウィジェットの記事増分優先機能を有効または無効にすることができます。

ソースURL設定

ソースURL設定は、インポートするMarkdownファイルのソースの場所を定義します。 これは、ファイルが保存されているソースリポジトリを指している必要があります。 GitHubがデフォルトとして想定されています。 定義すると、ナレッジベースでは、表示されている各記事の上にボタン(デフォルトのラベルは [GitHub上で編集])が表示されます。 ユーザーはボタンをクリックして、記事のソースの場所に移動できます。

ソースURL設定には、ナレッジベースのシステム設定の [ナレッジベースサービス] セクションからアクセスできます。 ソースURLを有効にするには、 [ソースURLが有効です] チェックボックスをオンにします。

ソースURLボタンのラベルを変更するには、設定 [ソース URL 編集メッセージ キー] に新しい値を指定します。 ベストプラクティスは、値を言語キーとして指定することです。 たとえば、言語キー edit-on-bitbucket=Edit on Bitbucket を作成する場合、その言語キーをボタンの新しいラベルとして指定できます。

edit-on-bitbucket

または、ラベルを明示的に指定することもできます。

Edit on Bitbucket

セクション名の設定

セクション名の設定は、記事に関連付ける任意のトピックの名前を指定するためのものです。 ナレッジベースセクション ウィジェットを使用して、記事の1つ以上のセクション(グループ)を表示できます。 セクションを使用するには、まず ナレッジベースセクション ウィジェットのシステム設定でセクションを定義する必要があります。

新しいセクションを作成するには、

  1. ナレッジベースセクション] 設定メニューに移動します。

  2. ナレッジベース記事セクション管理] 設定の横にあるプラスボタンをクリックして、必要なセクションごとに新しいフィールドを追加します。

    プラスボタンをクリックして、新しいセクションを追加します。

  3. 新しいセクションごとに名前を入力し、 [保存] をクリックします。

セクションが追加されたら、 ナレッジベースセクションのドキュメンテーション の手順に従って、セクションの使用方法を学習できます。