HTML Helpの構成ファイル

HTML Help をビルドするには以下のような構成ファイルが必要です。

ファイル	説明
project.hhp	ヘルプのプロジェクトファイル。オプションなどを定義。
toc.hhc	目次定義ファイル
Map.h	HelpID定義ファイル。

mdhelpはこれらの構成ファイルを基本的に自動で生成します。ただし、プログラムからヘルプIDを指定して特定ページを呼び出すためにヘルプのAPI情報を定義する場合は、自前でMap.hを準備する必要があります。mdhelpは/static/Map.hを使用してヘルプをコンパイルするため、/static/Map.hにマップファイルを作成します。

Map.h を作成する

mdhelpのbuild.batでヘルプをビルドすると、publishDirに成果物のヘルプファイルと共にMapTemplate.hが生成されます。これはヘルプのすべてのページのHelpIDのテンプレートを含みます。プログラムからヘルプのページを呼び出すためにMap.hを用意する場合、このテンプレートの各IDに対して一意の数値をふり、/static/Map.hとして保存してから、再ビルドしてください。

Note

この作業はページが増えた際にも必要になります。増えたページのID分を/static/Map.hに足します。

project.hhp をカスタマイズする

project.hhpはHUGOのテンプレートの仕組みで生成しています。そのため通常のテンプレートと同様/themes/mdhelp/layouts/index.hhpを/layouts/index.hhpにコピーして編集すれば自由にカスタマイズすることができます。