使える方法が二つあります:
エイリアス エディタで、CSH 呼び出しからリンクしたいトピックの識別子を作成して割り当てます。
例:
たとえば、"Welcome.htm" というトピックがあれば、新規の識別子を作成してそれも "Welcome" と名付けるでしょう。それから "1000" という値を割り当てます。トピック "Welcome.htm" が確実にその識別子に割り当てられていることを保証します。
最後に、エイリアス エディタでのオプショナルステップはその識別子にスキンを割り当てることです。しかし、このステップを回避して、後で実際の JavaScript を作成するときにスキンを指定してもいいし、スキンを全く選択しなくても結構です。
ヘルプ システムへのリンクを含む別途ウェブ ページを作成または修正します。これを「リンク ページ」と呼びます。ヘルプ システムへのリンクを含む別のウェブ ページを作成または修正します;これを "リンク ページ" と呼びます。どのウェブサイトでも利用するような単純 .html ファイルで結構です。"リンク ページ" に、(出力をビルドするとき自動的に作成される)JavaScript ファイルへの参照を追加します。この .js ファイルはウェブヘルプ出力ファイルと同じく名付けられ、ウェブヘルプ出力フォルダのルート レベルに置いてあります。JavaScript ファイルへの参照は "リンク ページ" の <head> タグと </head> タグとの間に置いて、以下の書式を利用するべきです: <script type="text/javascript" src="パスとファイル名.js"></script>。
例:
ウェブヘルプ出力ファイル名が "MyFirstHelp.htm" なら、JavaScript ファイルは "MyFirstHelp.js" となります。"リンク ページ" ファイルを JavaScript ファイルと同じフォルダに(つまり、ウェブヘルプ出力フォルダのルート レベルに)置くと仮定します。参照は .js ファイルへの相対的パスを含み以下のように見えます:
<script type="text/javascript" src="MyFirstHelp.js "></script>
注目:もし "リンク ページ" が JavaScript ファイルと同じフォルダに入っていなければ、ファイルがローカルに参照されていても必ずファイルへの src パスにスラッシュ(/)を利用します。
<input type="button" value="Open Help System" onclick="FMCOpenHelp( ID、SkinName、SearchString、SearchStringValue );" />
必要なら input type 及び value を編集できます。調整する一番重要な部分は括弧内要素(ID、SkinName、SearchString、SearchStringValue)です。
例:
以下の例では、"Welcome" に関連するトピック及びスキンが利用されます。検索文字列情報が含まれません:
<input type="button" value="Open Help System" onclick="FMCOpenHelp( 'Welcome'、null、null、null );" />
以下の例では、"Welcome" に関連するトピックが利用されます。"BlueSkin" が "Welcome." に関連するスキンをオーバライドします。検索文字列情報が含まれません:
<input type="button" value="Open Help System" onclick="FMCOpenHelp( 'Welcome'、'BlueSkin'、null、null );" />
以下の例では、識別子値 1000 に関連するトピック及びスキンが利用されます。検索文字列情報が含まれません:
<input type="button" value="Open Help System" onclick="FMCOpenHelp( 1000、null、null、null );" />
以下の例では、識別子値 1000 に関連するトピックが利用されます。"BlueSkin" が識別子値 1000 に関連するスキンをオーバライドします。検索文字列情報が含まれません:
<input type="button" value="Open Help System" onclick="FMCOpenHelp( 1000、'BlueSkin'、null、null );" />
以下の例では、"Company/Employees.htm" はデフォルト スキンをもって利用されます。検索文字列情報が含まれません:
<input type="button" value="Open Help System" onclick="FMCOpenHelp( 'Company/Employees.htm'、null、null、null );" />
以下の例では、デフォルト トピックもデフォルト スキンも利用されます。"quarterly report" という単語の検索が自動的に行われるが、検索で最初に見つかるトピックは自動的に開かれません:
<input type="button" value="Open Help System" onclick="FMCOpenHelp( null、null、'quarterly report'、false );" />
以下の例では、デフォルト トピックが "BlueSkin" をもって利用されます。"quarterly report" という単語の検索が自動的に行われ、検索で最初に見つかるトピックは自動的に開かれます:
<input type="button" value="Open Help System" onclick="FMCOpenHelp( null、'BlueSkin'、'quarterly report'、true );" />
この方法はウェブヘルプ出力ファイルへのハイパーリンクを必要とします。ヘルプ システム起動時に利用する識別子またはスタート トピックを指定するのにハッシュ値が利用されます。
(オプション)エイリアス エディタで、リンクするトピックの識別子を作成して割り当てます。ヘッダー ファイル、エイリアス ファイル、及びトピックの識別子を作成したくなければ、代わりにリンクするトピックのファイル名を利用できます。
エイリアス エディタでのオプショナル手段はその識別子にスキンを割り当てることです。しかし、この手段を回避して後で実際のリンクを作成するときに指定してもよくて、またはスキンを全然選択しなくても結構です。
"リンク ページ" でリンクを表示する場所に、ヘルプ システムの指定部分を開くハイパーリンクを追加します。
リンクの作成方法や含める内容にはある程度の柔軟性があります。以下はリンクの基本的な構成です:
PathToOutput/OutputFileName_CSH.htm?SearchString|FirstPick#MapID または TopicName.htm|SkinName
この構成はすべての部分が必要のではなくて、オプションのもあります。いつでも必要な部分は: (1) OutputFileName_CSH.htm 及び (2) MapID あるいは TopicName.htm。
以下はこの構成の多様な要素の説明があります:
OutputFileName_CSH.htm これはウェブヘルプ出力の主要エントリ ファイルです。ファイル名はターゲット エディタの基本 タブで出力ファイル フィールドに入力するものによって決定されます。このフィールドで名称を与えなければ、"Default" という名称が利用されます。ファイル名の後ろに、アンダースコア並びに "CSH" を追加することが重要です。
注目: Flare でトピック ファイル名に "_CSH" 部分を含めなくても大丈夫です。そのトピックにつながるウェブページ ハイパーリンクだけに "_CSH" を付ける必要があります。
例:
以下の例では、主要エントリ ファイル名は "MyWebHelp"、識別子名は "MyTopic"、検索文字列は除きます:
<a href="MyWebHelp_CSH.htm#MyTopic" target="_blank">Open the Help system</a>
以下の例では、主要エントリ ファイル名は "MyWebHelp"、識別子値は "1000"、検索文字列は除きます:
<a href="MyWebHelp_CSH.htm#1000" target="_blank">Open the Help system</a>
以下の例では、主要エントリ ファイル名は "MyWebHelp"、行き先ファイル名は "MyTopic.htm"、検索文字列は除きます:
<a href="MyWebHelp_CSH.htm#MyTopic.htm" target="_blank">Open the Help system</a>
以下の例では、主要エントリ ファイル名は "MyWebHelp"、行き先ファイル名は "MyTopic.htm"、スキン名は "MySkin"、検索文字列は除きます:
<a href="MyWebHelp_CSH.htm#MyTopic.htm|MySkin" target="_blank">Open the Help system</a>
以下の例では、主要エントリ ファイル名は "MyWebHelp"、検索文字列は "World Cup Standings"、識別子値は "1000"(検索の最初に見つかるトピックは自動的に開かれません):
<a href="MyWebHelp_CSH.htm?World Cup Standings#1000" target="_blank">Open the Help system</a>
以下の例では、主要エントリ ファイル名は "MyWebHelp"、検索文字列は "World Cup Standings"、"FirstPick" は検索の最初に見つかるトピックが自動的に開かれることを指示し、識別子名は "MyTopic":
<a href="MyWebHelp_CSH.htm?World Cup Standings|FirstPick#MyTopic" target="_blank">Open the Help system</a>
以下の例では、主要エントリ ファイル名は "MyWebHelp"、検索文字列は "World Cup Standings"、"FirstPick" は検索の最初に見つかるトピックが自動的に開かれることを指示し、行き先ファイル名は "MyTopic.htm"、スキン名は "MySkin":
<a href="MyWebHelp_CSH.htm?World Cup Standings|FirstPick#MyTopic.htm|MySkin" target="_blank">Open the Help system</a>
MadCap Software, Inc.
11230 Sorrento Valley Road
San Diego, California 92121
Tollfree 1-888-MadCap1
Tel 858-320-0387
Fax 858-320-0338