プロジェクトファイルの内容(KeiYu HelpLab)

HOME → HTML Help

HTML Helpの作成方法（応用編）
プロジェクトファイルの内容

プロジェクトファイル（*.hhp）には、HTML Helpを構成するファイル、ウインドウのスタイルや、コンパイルを行うために必要な情報などが定義されています。HTML Help Workshopの［Project］タブでダイアログボックスを表示して設定した内容が、プロジェクトファイルに保存されます。プロジェクトファイルはテキストファイルです。エディタで開いて内容を確認できます。

通常、プロジェクトファイルを直接編集する必要はないのですが、中にはHTML Help Workshopでは設定できず、プロジェクトファイルを直接編集しなければならないオプションもあります。

プロジェクトファイルのセクション

プロジェクトファイルには以下のセクションがあります。

OPTIONS
WINDOWS
FILES
ALIAS
MAP
TEXT POPUPS
MERGE FILES
INFOTYPES

OPTIONSセクション

（Change project options）で設定する内容です。

　
Auto Index=Yes: トピックファイル中に指定したキーワードをHTML Helpに含めます。Noを指定するか、この行を省略すると、トピック中のキーワードが［キーワード］タブに表示されず、キーワードリンクにも表示されません。
　
Auto TOC=n: トピックファイル中の見出し（<Hn>～<Hn>）から自動的に目次を作成します。何段階の見出しまでを目次にするかを、nで指定します。この行を省略すると、見出しから目次を作成しません。
　
Binary Index=Yes: バイナリのインデックスを作成します。Noを指定すると、バイナリのインデックスを作成せず、トピックに設定したキーワードが［キーワード］タブなどに表示されません。この行を省略すると、「Binary Index=Yes」になります。
　
Binary TOC=Yes: バイナリの目次を作成します。Noを指定するか、この行を省略すると、バイナリの目次を作成しません。
　
Compatibility=1.0 | 1.1 or later: HTML Help 1.0のランタイムコンポーネントしか入っていないような環境の場合に「1.0」を指定します。1.0より後で追加された機能は動作しなくなります。それ以外の場合は「1.1 or later」を指定します。
　
Compiled file=HTML Helpファイル名（*.chm）: コンパイルで作成されるchmファイル名を指定します。
　
Contents file=目次ファイル名（*.hhc）: コンパイルに使用する目次ファイル名を指定します。この行を省略すると、［目次］タブが表示されません。［WINDOWS］セクションでも目次ファイル名が指定されている場合は、WINDOWSの設定が優先されます。
　
Default Font=フォント名,フォントサイズ,言語: HTML Helpウインドウの各タブの文字のフォント、フォントサイズ、言語（日本語＝128）を指定します。
　
Default Window=ウインドウ名: ウインドウタイプを指定していない場合に使用されるウインドウタイプ名を指定します。
ウインドウタイプは、［WINDOWS］セクションで定義します。最初定義したウインドウタイプが自動的にこのデフォルトウインドウになります。
　
Default topic=トピックファイル名（*.htm、*.html）: HTML Helpウインドウを開いたときに最初に表示されるトピックファイル名を指定します。［WINDOWS］セクションでもデフォルトトピックファイル名が指定されている場合は、WINDOWSの設定が優先されます。
　
Display compile progress=Yes: コンパイル時にコンパイル中のファイル名などもすべて表示します。Noを指定するか、この行を省略すると、エラーメッセージと処理結果のみを表示します。
　
Display compile note= Yes: コンパイル時に注意（note）メッセージも表示します。Noを指定するか、この行を省略すると、警告やエラーメッセージのみを表示します。
　
Error log file=ログファイル名（*.log）: コンパイル時のメッセージが自動保存されるログファイル名を指定します。
　
Flat=Yes: トピック中のハイパーリンクのパスを削除し、ファイル名だけにしてコンパイルします。Noを指定するか、この行を省略すると、元のままパスも残ります。
　
Full-text search=Yes: ［検索］タブを付け、全文検索情報をヘルプに含めます。Noを指定すると［検索］タブは表示されますが、入力欄などが何も表示されません。この行を省略すると、［検索］タブが表示されません。
　
Full text search stop list file=ストップリストファイル名（*.spt）: ［検索］タブで検索されない単語を入れたストップファイル名を指定します。（今のところ、ストップリスト中で日本語を指定しても無効になります。）

Index file=索引ファイル名（*.hhk）: コンパイルに使用する索引ファイル名を指定します。この行を省略すると、［キーワード］タブが表示されません。［WINDOWS］セクションでも索引ファイル名が指定されている場合は、WINDOWSの設定が優先されます。
　
Language=0x411 日本語: HTML Helpで使用する言語を指定します。
　
Title=ウインドウタイトル: デフォルトウインドウのタイトルバーに表示する文字列を指定します。［WINDOWS］セクションでもタイトルが指定されている場合は、WINDOWSの設定が優先されます。

(一覧に戻る)

WINDOWSセクション

（Add/Modify window definitions）で設定する内容です。

「ウインドウタイプ名=」の後に、以下の順番でオプションを指定します。各オプションの間はカンマ（,）で区切ります。

ウインドウタイトル
目次ファイル名
索引ファイル名
デフォルトトピックファイル名
ホームボタンのトピックファイル名
ジャンプ1ボタンのトピックファイル名
ジャンプ1のボタンのラベル名
ジャンプ2ボタンのトピックファイル名
ジャンプ2のボタン名
ナビゲーションペインのスタイル（以下で説明）
ナビゲーションペインの幅（単位：ピクセル）
ボタンのスタイル（以下で説明）
ウインドウの位置とサイズ［左,右,下,上］（単位：ピクセル）
ウインドウスタイル
拡張ウインドウスタイル
Open with navigation pane closedのフラグ（1=ヘルプ表示時にナビゲーションペインを閉じる）
?
デフォルトのタブ（0=目次、1=キーワード、2=検索、3=お気に入り）
タブの配置（0x0=上、0x1=左、0x2=下: この指定は正式にはサポートされていません。）
ウインドウタイプの通知ID（HtmlHelp APIのidNotify）

例）

main="サンプルヘルプ","sample.hhc","sample.hhk","topic1.htm","home.htm","topic2.htm","ジャンプ1","topic3.htm","ジャンプ2",0x63520,250,0xc3046,[100,50,500,350],,,,,1,,0

ナビゲーションペインのスタイル

以下のうち、必要な項目の値を加算した数（16進数）を指定します。

0x1 ［Automatically show/hide navigation pane］オン
0x20 ［Window with navigation pane, topic pane, and button］オン
0x40 ボタンに文字を表示しない
0x100 ［Auto Sync］オン
0x400 ［Search Tab］オン
0x1000 ［Favorites Tab］オン
0x2000 ？
0x10000 MSDNライブラリのメニューバーを追加
0x20000 ［Advanced search］オン
0x40000 ［Save user defined window position after first use］オン

0x40を指定すると、Office 2000ヘルプのように、文字なしのアイコンのみのボタンを表示できます。しかし、文字なしのボタンにした場合、後で0x40を引いて再コンパイルしても、hh.datにその情報が残っているらしく、hh.datを削除するまで文字なしボタンになります。この機能は正式にはサポートされていませんので、ご注意ください。

ボタンのスタイル

0x2 表示/非表示
0x4 戻る
0x8 進む
0x10 中止
0x20 更新
0x40 ホーム
0x800 同期
0x1000 オプション
0x2000 印刷
0x40000 ジャンプ1
0x80000 ジャンプ2
0x100000 フォント
0x200000 前へ
0x400000 次へ

「フォント」「前へ」「次へ」は正式にはサポートされていません。
［前へ］［次へ］ボタンは、（Change project options）で［Compiler］タブの［Create a binary TOC］にチェックが付いている場合のみ有効です。

(一覧に戻る)

FILESセクション

（Add/Remove topic files）で設定する内容です。

HTML Helpに含めるファイルを指定します。HTMLファイルやイメージファイル（*.bmp、*.gif、*.jpg）は、ここで指定しないでも、そのァイルへのハイパーリンクが設定されていれば、自動的にHTML Helpに含められます。その他のファイルをヘルプに含めたい場合は、ここで明示的に指定します。

(一覧に戻る)