Importing Knowledge Base Articles
ライフレイ 7.4 U72+/GA72+
ナレッジベースの記事を Markdown ファイルとして下書きし、Liferay にインポートすることができます。 これを行うには、各 Markdown ファイルが適切にフォーマットされ、ZIP アーカイブにパッケージ化されていることを確認する必要があります。 インポートされた記事は自動的に HTML に変換され、ナレッジ ベース UI に表示されます。
この方法により、Liferay に公開する前に、外部ツールを使用して記事の下書き、ホスト、共同作業を行うことができます。
Markdown 記事をインポートするには、 ナレッジベース > ナレッジベース: 記事のインポート 権限が必要です。
インポート用のマークダウンファイルの準備
ナレッジベースは、表の書式設定、画像のキャプション、脚注などの機能で基本的な Markdown を拡張した マルチ Markdown 方言をサポートしています。 Markdown は読みやすく、直感的で、多用途な言語です。 GitHub などのサービスを使用すると、他のユーザーとドキュメントをレビューしたり共同作業を行ったりすることができます。
ファイル要件
Markdownファイルをインポートするには、
- ZIP ファイルにパッケージ化されます。
.mdまたは.markdownファイル拡張子を使用します。- 記事のタイトルを設定するには、H1 (例:
# Some Heading) で始めます。 - 記事のフレンドリ URL を設定するには、H1 の後に一意の ID (例:
# Some Heading [](id=some-heading)) を含めます。
たとえば、 modern-pentathlon.md という名前の記事には、次のコンテンツを含めることができます。
# Modern Pentathlon [](id=modern-pentathlon)
The modern pentathlon is a competition across five different sport disciplines.
Each athlete must compete in fencing, shooting, swimming, horseback riding, and running.
各 ZIP ファイルには、任意の数の新規ファイルまたは変更されたファイルを含めることができます。
オプション構成
ファイル名に数字のプレフィックスを追加することで、インポート時に記事の順序を決定できます (例: 00-foo.md、 01-bar.md)。 さらに、 -intro サフィックスを .markdown 拡張子を持つファイルに追加して、インポートされた記事の親/子階層を作成することもできます。
たとえば、次のファイルが同じフォルダーにあるシナリオを考えます: 00-foo-intro.markdown、 01-bar.markdown、 02-goo.markdown。 インポートすると、記事の順序と階層は次のようになります。
└── Foo
├── Bar
└── Goo
記事が画像を参照している場合は、ZIP ファイルのルートにある /images フォルダーに画像を追加することで、インポートに含めることができます。 サポートされている添付ファイルの拡張子は、 .bmp、 .gif、 .jpeg、 .jpg、および .pngです。
画像リソースは、記事内で参照されている場合にのみインポートされます。 それ以外の場合は無視されます。
システム設定を介してナレッジベースのインポート設定を表示および構成できます。 詳細については、 ナレッジベースのシステム設定 を参照してください。
ソースURLの設定
GitHubなどのサービスで Markdown ファイルをホストしている場合は、リポジトリの場所を指定するソース URL を設定できます。 この機能を使用するには、まず ナレッジ ベース システム設定でソース URL を有効にします。 次に、目的のリポジトリのベース URL を含む .METADATA ファイルを ZIP ファイルのルートに追加します。 インポーターは、ZIP アーカイブ内の各ファイルのパスをこのベース URL に追加して、完全なソース URL ([ベース URL]/[記事ファイル パス]) を形成します。
たとえば、次のベース URL を持つシナリオを考えてみましょう。
https://github.com/clarity/clarity-guide/blob/master/docs/latest/en
folder-01/file.mdで ZIP アーカイブをインポートすると、結果のソース URL は次のようになります。
https://github.com/clarity/clarity-guide/blob/master/docs/latest/en/folder-01/file.md
Markdownファイルのインポート
-
サイト メニュー (
) を開き、 コンテンツとデータ → ナレッジ ベースに移動します。 -
記事とフォルダー (
) セクションで、目的のフォルダーに移動し、 追加 (
) をクリックして、 インポートを選択します。
または、目的のフォルダーの アクション ボタン (
) をクリックし、 インポートを選択します。![目的のフォルダーの [アクション] ボタンをクリックし、[インポート] を選択します。](https://resources.learn.liferay.com/images/dxp/latest/en/content-management-system/knowledge-base/importing-knowledge-base-articles/images/02.png)
-
[ファイルを選択] をクリックし、目的の ZIP ファイルを選択します。

-
有効化/無効化 記事ファイルの数値プレフィックスを優先度として適用。 これにより、ナレッジ ベースが各ファイルの数値プレフィックスを使用してファイルを順序付けるかどうかが決まります。
-
[保存]をクリックします。
保存されると、インポーターは各ファイルの Markdown を HTML に変換し、結果の記事が公開されます。
インポートされた記事は、ワークフロー設定に依存しません。 つまり、インポートされた記事は自動的に承認されます。
インポートプロセスを理解する
Markdown インポーターは、開始されると、各ファイルの H1 と ID が既存のナレッジベースの記事と一致するかどうかを確認します。 一致が見つかった場合、インポーターは既存の記事のコンテンツを置き換えます。 一致するものがない場合は、新しい記事が作成されます。
インポーターは記事を作成および更新するだけです。 既存の記事は削除されません。 記事を手動で削除する必要があります。
Liferay でのファイルの順序を更新するために、ファイルの数値プレフィックスを更新することができます (例: 00-file.md を 01-file.mdに変更します)。
記事のヘッダー ID を更新すると、新しいフレンドリー URL を持つ新しい記事が作成され、既存の記事は更新または削除されません。