|
FrameMaker 文書をリンクまたは取り込む場合には、FrameMaker のコンテンツを、RoboHelp の中でトピックとしてどのように表現するのかを定義します。 Technical Communication Suite では、コンテンツのページ割り付け、トピックの名前付け、製品との統合のための状況依存ヘルプトピックのマッピングを指定する方法を設定できます。
ページ割り付けとトピックタイトルの注意事項使用環境に適したページ割り付けオプションを、次の基準に基づいて決定します。
- トピック内容の完全性
- 生成されるトピックに、読者のための関連するすべての情報が含まれるようにします。例えば、見出し 3 レベルの段落にページ割り付けを設定した場合、他の見出し 3 レベルのトピックに含まれる文脈情報が失われて、タスク情報だけが含まれる可能性があります。このようにトピックが切り離されるのを避けるには、単一のヘルプトピックだけで詳細が得られるように、高いレベルでページ割り付けを設定してください。
- ドロップダウンテキスト
- ドロップダウンテキスト用の段落書式には、ページ割り付けを設定しないようにしてください。この書式が適用された段落には、ドロップダウンテキストキャプション段落書式が設定されている必要があります。
FrameMaker の段落書式に従ってページ割り付けやトピックタイトルの生成を定義することは簡単ですが、この方法には次のような制約があります。
- トピックレベルの制御がない
- ページ割り付け設定はプロジェクトレベルで設定されるので、定義された見出しレベル内にないトピックに対しては個別の制御ができません。たとえば、H3 レベルのトピックを別のヘルプトピックにしたいとします。プロジェクトに対して H2 でページ割り付けを設定しても、それを行うことができません。H3 トピックは、その直ぐ上にあるトピックの下に含まれます。
- トピックの統一的な名前付け
- ヘルプトピックは、変換設定で定義したものと同じファイル命名規則を使用します。オーサリング環境が構造化 FrameMaker の場合は特にこの規則が使用されます。この命名規則からはずれることはできません。
- トピックタイトルに柔軟性がない
- ソースコンテンツを変更しないでトピックのタイトルやファイル名を選択的に変更することはできません。RoboHelp 内でコンテンツを検索したときに、トピックタイトルが検索で表示されます。トピックに分かりやすいタイトルを付けると、読者は検索結果から最も関係のある情報を迅速に見つけ出すことができます。
- 複数のブックで文書に一貫性がなくなる可能性
- 複数のブックからリンクおよび取り込まれた FrameMaker 文書の場合は、生成されるトピックの見出しスタイルが不統一になる可能性があります。
たとえば、ユーザーガイドとリファレンスガイドから FrameMaker 文書をリンクまたは取り込むとします。この場合、トピックタイトルは、構造的なコンテンツとリファレンス的なコンテンツとでスタイルに違いが出てきます。トピックタイトルが、ページ割り付けが設定されている段落テキストから得られたものである場合、生成されるヘルプトピックに一貫性のないタイトルが付けられる可能性があります。
FrameMaker 内からページ割り付けを設定する利点FrameMaker 内でカスタムマーカーを使用することで、小さなプロジェクトの場合のこれらの欠点を克服し、次のことができます。 - ワークフローに基づいたコンテンツを作成
- FrameMaker でカスタムマーカーを賢く使用することで、ワークフローについての情報をユーザーに定義する RoboHelp トピックを作成できます。FrameMaker 文書内で適用されている見出しスタイルとは無関係に、ヘルプトピックを作成できます。
- オプションとしてトピックのタイトルを定義する
- 多くのトピックを組み合わせ、これらの組み合わせたトピックに 1 つのタイトルを割り当てるときに、このオプションは便利です。これを使用すると、見出しスタイルの 1 つからトピックタイトルテキストを取り出さなくてすみます。
- トピックの長さを最適化する
- ヘルプトピックを RoboHelp 内でどのように作成するかを FrameMaker で定義するので、トピックベースオーサリングに適したトピック長を正確に制御できます。ただし、ヘルプトピックでミニ目次機能を使用する場合は、トピックに含める見出し数を制限してください。ミニ目次が長くなると、トピック内容をスクロールしないと見られなくなります。
FrameMaker 文書内でこれらのマーカーを定義した後に、RoboHelp で変換設定を設定して、必要に応じてトピックを作成し名前を付けることができます。
ページ割り付けオプションFrameMaker コンテンツを RoboHelp 内のヘルプトピックとどのように違えるかを定義できます。
- FrameMaker の段落書式に基づいて個別に HTML トピックを作成する
- 改ページとして使用すべき見出しスタイルを FrameMaker で指定します。例えば、FrameMaker ファイルに 10 個のトピックが含まれていて、各トピックにサブトピック、タスク、表が含まれているような場合、各トピックを別々の HTML ファイルとして変換できます。このような各トピックの見出しの書式が見出し 1 である場合、見出し 1 のトピックがすべて別々の HTML トピックとして生成されるように設定することができます。一方、見出し 2 でページ割り付けを設定した場合、各見出し 2 トピックに対して別々の HTML ファイルが生成されます。
- FrameMaker コンテンツ内で改ページマーカーを定義する
- FrameMaker 文書内の段落の先頭に改ページマーカーを挿入できます。一般的に、選択した見出しレベルに改ページを作成します。このオプションを使用する場合は、段落書式に基づいてページ割り付け設定を定義しないでください。
- FrameMaker で定義されたカスタムマーカーを使用する
- 他のツールを使用してページ割り付けを定義するためにカスタムマーカーを使用した以前からのコンテンツを FrameMaker 内で変換する場合は、このオプションを使用できます。このような文書内では改ページマーカーの使用は避けます。
トピック名オプションFrameMaker コンテンツから生成されたトピックを RoboHelp 内でどのような名前にするかを定義できます。デフォルトでは、ページ割り付けのために設定されている段落のテキストをトピック名として定義できます。また、他の名前付け規則を定義することもできます。ファイル名に連続番号（たとえば helptopic001.html 、helptopic002.html など）を使用する場合は、その規則のパターンを定義できます。
- 段落テキストに基づく
- ページ割り付けの見出しスタイルを設定すると、見出しテキストが RoboHelp で作成されるトピックファイルのデフォルトファイル名になります。たとえば、ページ割り付けの見出し 2 を定義するとし、FrameMaker 文書には 2 つの見出し 2 トピック「Introduction」と「Beyond Basics」があるとします。この場合、RoboHelp はトピックとして introduction.html と beyond_basics.html を作成します。したがって、トピックタイトルを示す分かりやすい名前の HTML ファイルが作成されます。
- トピック名パターン
- トピックの名前は選択されたパターンに従って付けられます。次のいずれかのパターンを選択するか、RoboHelp で提供されている「トピック名パターン」構成要素を使用してトピック名パターンを作成することができます。また、トピック名パターンとして、標準的な固定テキスト（たとえば「HelpTopic」）とその後にシリアル番号を付けることができます。
構成要素
|
変換されたトピック名パターン
|
|---|
デフォルト
|
生成された HTML トピックは、段落テキストで構成されたファイル名があります。
|
<$filename_no_ext>-<$paratext>
|
生成された HTML トピックには、FrameMaker 文書のファイル名（.fm 拡張子を除く）、ハイフン、トピックタイトルで構成されたファイル名があります。たとえば、「Chapter.fm」という FrameMaker 文書に「1-Introduction」という段落テキストがある場合、「Chapter-1-Introduction.htm」というファイル名の HTML トピックに変換されます。
|
<$filename_no_ext>-<n>
|
生成された HTML トピックには、FrameMaker 文書のファイル名（.fm 拡張子を除く）、ハイフン、段落番号で構成されたファイル名があります。たとえば、「Chapter.fm」という FrameMaker 文書は、「Chapter-1.htm」というファイル名の HTML トピックに変換されます。
|
<$paratext_no_num>
|
生成された HTML トピックには、ページ割り付けが設定されている段落書式の段落テキスト（段落番号を除く）で構成されたファイル名があります。たとえば、「1. Introduction」という見出し 1 段落は「Introduction.htm」というファイル名の HTML トピックに変換されます。
|
<$paratext>
|
生成された HTML トピックには、ページ割り付けが設定されている段落書式の段落テキストで構成されたファイル名があります。たとえば、「Introduction」という見出し 1 段落は「Introduction.htm」というファイル名の HTML トピックに変換されます。
|
- トピック名マーカー
- FrameMaker ドキュメント内でトピック名マーカーを使用して、マーカーテキストからトピックのタイトルとファイル名を作成できます。このオプションを選択すると、段落スタイルペインで適用されたページ割り付け設定は無視されます。このオプションは、FrameMaker 文書から別個のヘルプトピックを作成する動作を正確にコントロールするために使用します。
- 改ページマーカー
- FrameMaker で新しいコンテンツを作成する場合およびカスタムマーカーを使用してページ割り付けを定義したくない場合は、改ページマーカーを使用できます。トピックタイトルを定義すると、FrameMaker はトピックタイトルに基づいたトピック名を自動的に作成します。
FrameMaker 文書にすでにページ割り付けのためのカスタムマーカーが含まれている場合や、FrameMaker の段落書式に基づいてページ割り付けを定義する場合は、このオプションを使用しないでください。
トピック名設定を定義するファイル／プロジェクト設定を選択します。
プロジェクト設定ダイアログボックスの「取り込み」設定タブで、「FrameMaker ドキュメント」の下にある「編集」をクリックします。
「その他の設定」タブで、必要なオプションを選択します。
FrameMaker 文書内の状況依存ヘルプマーカーTechnical Communications Suite を使用している場合は、他のマーカーを使用するほかに、FrameMaker 内で状況依存ヘルプマップ ID を定義できます。
FrameMaker 文書内で挿入する状況依存ヘルプマーカーを変換し、それらをマップ ID として再利用することができます。FrameMaker 文書をリンクする前に、プロジェクト設定ダイアログボックスで状況依存ヘルプマーカーを指定します。FrameMaker 文書を取り込むときも、この設定を指定できます。FrameMaker 文書での状況依存ヘルプマーカーは、次の 2 つの方法で処理できます。
- FrameMaker 文書からマップ ID の自動変換
- FrameMaker 文書内で状況依存ヘルプマーカーを適用し、変換設定でマーカータイプを指定します。RoboHelp は、FrameMaker 文書からマーカーを取り込み、状況依存ヘルプマーカー内で含まれる設定からマップ ID を追加します。
- 手動によるマップ ID の追加
- 開発チームから受け取ったマップ ID は、次の 2 つの方法で使用できます。
FrameMaker 内から、CSH マーカーオプションを使用して、生成したいトピックのマップ ID を入力します。このオプションが利用できるのは、Technical Communication Suite を使用している場合だけです。
FrameMaker 内から、状況依存へプルマーカーを使用したいマーカーのためのテキストとしてマップ ID を使用します。FrameMaker 文書をリンクまたは取り込むときは、変換設定で状況依存ヘルプマーカーを指定します。
1 番目のオプションを使用する場合は、変換設定で状況依存ヘルプマーカーを指定しないでください。
状況依存ヘルプマーカーを指定するファイル／プロジェクト設定を選択します。
プロジェクト設定ダイアログボックスの「取り込み」設定タブの「FrameMaker 文書」の下にある「編集」をクリックします。
変換設定ダイアログボックスの「その他の設定」グループで、「状況依存ヘルプマーカー」を選択します。
|
|
|
