エディション

内容が微妙に異なるヘルプのファミリーを生成する必要がある場合、HUGOのConfiguration Directoryの仕組みを利用してエディションを作り分け、構成や記事内容を切り替えてビルドできます。

エディションのconfigを作成する

/config/chm_otherというディレクトリを作成し、/config/chm/config.tomlをコピーして編集することで簡単にchm_otherエディションを作成することができます。それぞれのエディションのconfigはヘルプの構成に沿って編集します。以下では主要な設定変更について説明します。

タイトル

ヘルプのタイトルがエディションごとに違う場合、各言語のtitleを設定します。

[languages]
  [languages.jp]
    title = "other"

特定記事・特定要素の表示/非表示を切り替える

ShowIf,HideIfショートコード/フロントマターと共にshowIfsを使用することで表示/非表示を切り替えます。

[params]
  showIfs = ["editionA"]

この場合、.mdの記事で以下のように記載した要素が表示されます。

{{% ShowIf editionA %}}
ここにeditionAをサポートする場合に表示するコンテンツを記述。
{{% /ShowIf %}}

以下のように記載し作用素は表示されません。

{{% HideIf editionA %}}
ここにeditionAの場合に非表示とするコンテンツ。
{{% /HideIf %}}

記事単位では以下のようにフロントマターを書いている場合にchmに含まれます。一つのエディションだけであってもリスト形式（["editionA"]）で書く必要があります。HideIfも同様です。

---
title: editionAの説明
ShowIf: ["editionA"]
---

ビルドする

エディションを指定してビルドするには、引数にエディションを指定します。例えばchm_otherエディションをビルドするには以下のように指定します。

.\CI\build.bat chm_other