ナレッジベース記事のインポート

liferay 7.4 U72+/GA72+.

ナレッジベースの記事を Markdown ファイルとして下書きし、Liferay にインポートすることができます。そのためには、各Markdownファイルが適切にフォーマットされ、ZIPアーカイブにパッケージされていることを確認する必要があります。インポートされた記事は自動的にHTMLに変換され、ナレッジベースUIに表示されます。

こうすることで、Liferayに記事を公開する前に、外部ツールを使って記事の下書き、ホスト、共同作業を行うことができます。

note

ナレッジベース > ナレッジベース：Markdown記事をインポートするには、記事のインポート権限が必要です。

インポート用Markdownファイルの準備

Knowledge Baseは Multi-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）。さらに、インポートされた記事の親/子階層を作成するために、.markdown拡張子のファイルに接尾辞-introを追加することができます。

例えば、これらのファイルが同じフォルダにある場合を考えてみましょう：00-foo-intro.markdown、01-bar.markdown、02-goo.markdownです。インポートされると、これが記事の順序と階層になる：

└── Foo
    ├── Bar
    └── Goo

記事が画像を参照している場合、ZIPファイルのルートにある /images フォルダに画像を追加することで、インポートに画像を含めることができます。サポートされている添付ファイルの拡張子は .bmp、.gif、.jpeg、.jpg、.png です。

note

画像リソースは、記事の中で参照されている場合のみインポートされます。それ以外は無視される。

システム設定により、ナレッジベースのインポート設定を表示および設定することができます。詳しくはナレッジベースシステム設定をご覧ください。

GitHub のようなサービスでMarkdownファイルをホストしている場合、リポジトリの場所を指定するソースURLを設定することができます。この機能を使用するには、まずナレッジベースシステム設定でソース URL を有効にします。次に、ZIPファイルのルートに .METADATA ファイルを追加し、目的のリポジトリのベースURLを記述します。インポーターは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ファイルのインポート

サイトメニューを開き、 コンテンツとデータ → ナレッジベース に移動します。
記事とフォルダ()セクションで、目的のフォルダに移動し、追加()をクリックし、 インポート を選択します。

または、目的のフォルダの Actions ボタン（！ Action Button ）をクリックし、 Import を選択します。
ファイルを選択 をクリックし、目的のZIPファイルを選択します。
有効/無効 記事ファイルの数字の接頭辞を優先順位として適用 。これは、Knowledge Baseが各ファイルの数字の接頭辞を使って順番を決めるかどうかを決定します。
［保存］をクリックします。