Importing Knowledge Base Articles
Liferay 7.4 U72+/GA72+
ナレッジベースの記事を Markdown ファイルとして作成し、Liferay にインポートできます。 そのためには、各Markdownファイルが適切にフォーマットされ、ZIPアーカイブにパッケージ化されていることを確認する必要があります。 インポートされた記事は自動的にHTMLに変換され、ナレッジベースのユーザーインターフェースに表示されます。
この方法を使えば、外部ツールを使って記事の草稿作成、ホスティング、共同編集を行い、その後Liferayに公開することができます。
Markdown 記事をインポートするには、 ナレッジベース > ナレッジベース: 記事のインポート の権限が必要です。
インポート用のMarkdownファイルの準備
ナレッジベースは、表の書式設定、画像キャプション、脚注などの機能で基本のマークダウンを拡張した マルチマークダウン 方言をサポートしています。 言語として、Markdownは読みやすく、直感的で、汎用性が高い。 GitHubのようなサービスを利用すれば、あなたや他のユーザーがドキュメントをレビューしたり、共同作業を行ったりすることができます。
ファイル要件
Markdown ファイルをインポートするには、
- ZIPファイルに圧縮してください。
.mdまたは.markdownファイル拡張子を使用してください。- 記事のタイトルを設定するには、H1 から始めます (例:
# 見出し)。 - 記事のフレンドリー 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)。 さらに、拡張子が .markdown のファイルに -intro サフィックスを追加することで、インポートされた記事の親/子階層を作成できます。
例えば、これらのファイルが同じフォルダにあるシナリオを考えてみましょう。 00-foo-intro.markdown、 01-bar.markdown、および 02-goo.markdown。 インポート後の記事の順序と階層構造は以下のようになります。
└── Foo
├── Bar
└── Goo
記事に画像が含まれている場合は、ZIP ファイルのルートにある /images フォルダーに画像を追加することで、インポートに含めることができます。 サポートされている添付ファイルの拡張子は、 .bmp、 .gif、 .jpeg、 .jpg、および .png です。
画像リソースは、記事内で参照されている場合にのみインポートされます。 そうでなければ、それらは無視される。
システム設定から、ナレッジベースのインポート設定を表示および構成できます。 詳細については、 ナレッジベースシステム設定 を参照してください。
ソースURLの設定
Markdown ファイルを GitHubのようなサービスでホストしている場合は、リポジトリの場所を指定するソース URL を設定できます。 この機能を使用するには、まず ナレッジベースシステム設定 でソース URL を有効にしてください。 次に、ZIP ファイルのルートに、目的のリポジトリのベース URL を含む .METADATA ファイルを追加します。 インポーターは、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ファイルのインポート
-
サイトメニュー (
) を開き、 コンテンツ & データ → ナレッジベース に移動します。 -
「記事とフォルダー (
)」セクションで、目的のフォルダーに移動し、 「追加 (
) をクリックして、 「インポート 」を選択します。
または、目的のフォルダーの アクション ボタン (
) をクリックし、 インポート を選択します。
-
ファイルを選択 をクリックし、目的の ZIP ファイルを選択します。

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