FrameMaker と RoboHelp を使用したオーサリングと公開のワークフロー

オーサリングと公開の環境にこれら 2 つのツールが含まれている場合は、これらの強力な機能をワークフローに組み込むためのいくつかのオプションがあります。

FrameMaker の書式を標準の CSS で RoboHelp に直接マッピングすることができ、これによりプロジェクト全体の表示と動作の一貫性を保つことができます。また、FrameMaker 内でマーカーを使用して状況依存トピックを指定することができ、これらを RoboHelp 内で直接再利用して状況依存ヘルプシステムを作成できます。

個別の製品としての FrameMaker と RoboHelp
FrameMaker と RoboHelp を個別の製品としてお持ちの場合は、現在のオーサリングワークフローをそのまま維持できます。このワークフローでは、コンテンツを FrameMaker でオーサリングし、印刷と PDF 出力を行います。次に、RoboHelp を使用して、リッチな書式のオンラインヘルプを生成します。FrameMaker と RoboHelp のいずれも、FrameMaker コンテンツを RoboHelp プロジェクトに取り込むための拡張機能を持っています。これらを一緒に使用することで、WebHelp や Adobe AIR に基づいたヘルプなどのオンラインヘルプ書式を作成することもできます。

マルチチャネル、マルチデバイス パブリッシュ エンジンの FrameMaker
FrameMaker 12 はマルチチャネル、マルチデバイスの公開ソリューションに含まれています。このソリューションにより、FrameMaker から以下の書式に公開できるようになり、読者は異なるデバイスや異なるフォーム ファクタから文書にアクセスできます。
  • Responsive HTML5

  • WebHelp

  • ePub

  • Kindle

  • Microsoft HTML Help

注意: このソリューションでは RoboHelp や Adobe Technical Communications Suite をインストールする必要はありません。

Adobe Technical Communication Suite
Adobe® Technical Communications Suite はテクニカルコミュニケーターに対して、コンテンツをオーサリングしそれを複数の形式で配信するための能率的なワークフローを提供します。FrameMaker でオーサリングし、印刷およびオンライン表示のためのリッチな書式の PDF を公開できます。Technical Communication Suite はそれを構成する個々のアプリケーションよりも多くの機能を提供できます。FrameMaker と RoboHelp のオーサリングおよび公開機能を統合し、FrameMaker と RoboHelp のコンテンツを動的にリンクできます。

Adobe Technical Communication Suite には Adobe Captivate と Adobe Photoshop が含まれています。これらのツールを使用するとリッチなマルチメディア機能を出力形式に含めることができます。また、Adobe Acrobat を使用することで共有レビューを作成し、レビューコメントや編集内容を連結することができます。後でこれらのコメントや編集内容を FrameMaker 文書に取り込むことができます。

オンライン出力を最適化するためのオーサリングの注意事項

FrameMaker のオーサリングプロセスがプリント出力に最適化されている場合には、FrameMaker 文書を RoboHelp プロジェクトにリンクしたり取り込んだりする前に、以下の点を考慮してください。
見出し書式
FrameMaker の見出し書式から RoboHelp スタイルへの最善のマッピングを判断します。FrameMaker 文書には、印刷文書専用の様々な見出し書式が定義されています。 このような書式の中には、新しいページから始まるわき見出しや見出しスタイルがあります。このような書式は、オンラインフォーマットには適用されません。このような見出しスタイルは、一般に、RoboHelp プロジェクトの少数の標準スタイルにマップされます。

ページレイアウト設定
FrameMaker の章テンプレートは、新しい章が奇数(右)ページから始まるように、偶数ページを指定していることが多くあります。 オンラインヘルプは、このようなページ割り付けに関する考慮を無視します。

ヘッダーとフッター
RoboHelp は、変換時に、「機密」や著作権行のような法律文を含むヘッダーやフッターを無視します。そのようなテキストは、変換の後、独立した手順でヘッダーやフッターに取り込まれます。同じように、RoboHelp では、印刷文書で使われている透かし用のテキストや画像を作り直します。

ナビゲーション
印刷では、相互参照はページ番号を指定しますが、これはヘルプでは無意味です。オンラインヘルプを変換すると、ヘッダー、フッターの中の章や節のタイトルは削除されます。その代わり、ブレッドクラム、「戻る」、「次へ」ボタンなどによって、操作性を向上させることができます。

冗長な内容
印刷文書では一般に、様々なセクションに文脈を提供するために、そこまでに書かれた概念の簡単な概要のような冗長な情報が付加されます。 オンラインヘルプは、ランダムアクセスで非線形のメディアなので、より冗長でないコンテンツが必要です。出力内の冗長なコンテンツを最小限にするには、相互参照やコンディショナルテキストのオプションを利用してください。

章とトピック
印刷文書では、章は独立した論理的単位を示すもので、読者はこれによりコンテンツの範囲を把握することができます。オンラインヘルプでは、コンテンツはトピックのレベルで分離され、一度にアクセスされるのは 1 つのトピックだけになります。章内のコンテンツは、ユーザーが目次を開いたときに展開されるフォルダーにグループ化することができます。その場合でも、一度に表示できるのは、1 つのトピックだけです。この場合には、関連したトピックをまとめることによって冗長性を付け加えることなく、包括的な情報の提供を試みます。

状況依存性
RoboHelp では、トピックにマップ ID を割り当てることができますが、FrameMaker 文書でも、状況依存ヘルプマーカーを割り当てることができます。 RoboHelp は、このようなマーカーを読み込んで、生成されたトピックにマップ ID を割り当てます。 FrameMaker で作成するトピックに十分な情報を含めるよう心がけてください。

たとえば、短い手順のような独立したトピックは、読者に概念的なコンテキストを提供しません。不十分な情報でトピックを作成しないようにするために、状況依存ヘルプマーカーを上位レベルのトピックに割り当てます。このようにすることで、生成されたヘルプトピックに、概念、手順、関連グラフィックが含まれます。

ヘルプに変換する FrameMaker 文書の作成

取り込む FrameMaker 文書が非構造化 FrameMaker ブックである場合には、単一の FrameMaker テンプレートを変換用に定義することができます。 このテンプレートは、後で RoboHelp プロジェクトレベルで、各文書の書式に上書きされるプロジェクトテンプレートとして指定することができます。また、変換設定を書き出すことによって、変換設定をプロジェクト全体で再利用することができます。

汎用 FrameMaker テンプレートを利用するときなどには、RoboHelp に文書を取り込む前に、FrameMaker テンプレートを注意深く調べるようにしてください。 このテンプレートにブックでは使われていない書式が含まれている場合には、変換に使うテンプレートの中ではそのような書式を省略するようにしてください。

  1. ヘルプで必要な書式を含む FrameMaker テンプレートを作成します。または、FrameMaker テンプレートをカスタマイズします。テンプレートを手動で適用する必要はありません。RoboHelp では、RoboHelp に FrameMaker ファイルがリンクまたは取り込まれる前に、選択されたテンプレートを FrameMaker ファイルに適用するように設定することができます。

    構造化 FrameMaker では、構造化 FrameMaker テンプレートで使われるエレメント定義文書(EDD)やDTDが、書式を自動的に制御します。構造化 FrameMaker では、有効な構造や書式が強制的に適用されるので、構造化文書には書式の上書きが含まれません。

  2. 拡張テキストやドロップダウンテキストのような必要な DHTML エフェクトは、FrameMaker の中の RoboHelp メニューを使って作成します。

  3. 状況依存ヘルプマーカーを必要なトピックに適用します。

  4. FrameMaker グラフィックツールで作成したグラフィックス、コールアウト、グラフィック枠やテキスト枠は、アンカー枠の中に囲います。RoboHelp は、アンカー枠に囲われた FrameMaker グラフィックスだけを取り込みます。

    デフォルトでは、FrameMaker 文書に取り込んだグラフィックスやマルチメディアのファイルは、アンカー枠の中に配置されます。 FrameMaker 文書の中にグラフィック枠のグラフィックスが含まれている場合は、FrameMaker ファイルを RoboHelp にリンクしたり取り込んだりする前に、アンカー枠の中にそれらを配置する必要があります。

  5. オリジナルの画像品質を維持するためには、FrameMaker 文書内にそれらを参照によって挿入します。RoboHelp は、アンカー枠内に画像全体が表示できる場合は、参照画像をソースから直接コピーします。同様に、画像が大きい場合も、それらをソース文書内に参照によって挿入します。

  6. 未解決の相互参照、存在しないフォント、不規則な番号など、文書中のあらゆる問題を修正します。

  7. 利用しやすいオンラインコンテンツを作成するために、画像やグラフィックスに代替テキストやキャプションを設定します。

  8. FrameMaker 文書の中でコンディショナルテキスト設定を適用します。

  9. 様々なスタイルをもつインデントされた階層的な見出しを作成するには、FrameMaker TOC リファレンスページを編集します。

文書のリンクオプション

文書を RoboHelp プロジェクトにリンクするときには、次の 2 つのオプションがあります。リンクオプションを指定するには、RoboHelp で、ファイル/プロジェクト設定を選択します。 「読み込み」タブをクリックし、次のうちの 1 つを選択します。
参照を作成
外部文書への参照を作成します。この場合、ソース文書は RoboHelp プロジェクトフォルダーにはコピーされず、プロジェクトの外に留まります。ただし、文書はプロジェクトマネージャーポッド内で表示できます。ソース文書は独立して編集および更新できます。後で、RoboHelp 内で、リンク先文書から生成されたトピックを更新できます。

複数のプロジェクトで共有されるコンテンツを取り込むために、参照によるリンクオプションを使用してください。文書のコピーは 1 つしか存在しないので、ソース文書に加えた変更は、この文書のリンク先のすべてのプロジェクトに反映されます。

コピーとリンクを作成
ソース文書のコピーと RoboHelp プロジェクトへのリンクを作成します。この場合、ソース文書のコピーが RoboHelp プロジェクトにコピーされ、プロジェクトマネージャーポッドに表示されます。ソース文書に影響を与えることなくこのコピー文書を編集および更新できます。文書を編集すると、コピー文書から生成されているトピックが更新されます。
「コピーとリンクを作成」オプションを使用して、RoboHelp 内にドキュメントを保持し、ソースドキュメントへのアクセスを制限します。このオプションを使用すると、RoboHelp プロジェクトで使用できるコピー内でのみの編集が可能になります。たとえば、静的な FrameMaker 文書からコンテンツを取り込む場合は、文書を RoboHelp プロジェクトにコピーすることで文書を取り込みます。
注意: FrameMaker ブックは常に参照によってリンクされ、リンクオプションを選択したかどうかには無関係です。

リンクと取り込みの得失

  • FrameMaker および Word のいずれかまたは両方を使用してすべてのオーサリングが行われる場合は、FrameMaker 文書および Word 文書をリンクします。目次、索引、用語集の変換や、状況依存ヘルプの作成など、RoboHelp の詳細な統合機能をすべて使用できます。ソースコンテンツが変更されると、リンク先文書から RoboHelp 内に生成されているトピックを迅速に更新できます。このような場合、数回クリックするかほとんどクリックしない、または RoboHelp 内でネイティブのオーサリングを行わないで、RoboHelp は FrameMaker 文書または Word 文書を複数のヘルプ出力に変換できます。

  • 複数の独立した文書を持っているときは FrameMaker および Word 文書を取り込み、RoboHelp の統合機能を注意して使用します。さらに、取り込む文書が安定していて、オンラインヘルプを公開し終わるまでに独立して更新する必要がないようにします。

  • 生成されたトピックを更新または上書きする必要がある場合に編集したものが失われないようにするために、RoboHelp 内で生成されたトピックは編集しないようにします。リンクされた文書から生成されたトピックは編集したものを保持できますが、取り込まれた文書から生成されたトピックは上書きされます。

  • 大きな RoboHelp プロジェクトに対して最小限の変更を行う場合は、文書を RoboHelp にリンクまたは読み込まないことをお勧めします。リンクまたは取り込むと、ネイティブに作成された目次、索引、用語集、ページ割り付け、状況依存ヘルプ設定が混乱する場合があります。

FrameMaker 文書のリンクと取り込み

FrameMaker 文書のリンクや取り込みを行うための RoboHelp ワークフローでは、以下を行うことができます。

  • FrameMaker ブックまたは DITAMAP を取り込んで、RoboHelp プロジェクトを作成します。

  • FrameMaker ブックまたは DITAMAP を RoboHelp プロジェクトにリンクまたは取り込みます。

  • FrameMaker 文書を RoboHelp プロジェクトにリンクまたは取り込みます。 FM、MIF、DITA、XML ファイルを取り込むことができます。

FrameMaker ブックまたは DITAMAP をリンクするときに、プロジェクト設定を定義してヘルプトピックを生成するまで、HTML ファイルは作成されません。同時に、追加されたファイルを階層順に表示することができます。FrameMaker 文書を取り込んで、そこから生成された HTML ファイルを RoboHelp の中で編集しても、ソースの FrameMaker 文書には影響はありません。

FrameMaker文書を取り込む前に、FrameMaker の中で、非決定の相互参照や書式変更のようなエラーをチェックします。

FrameMaker ブックや文書をリンクしたりまたは取り込んで RoboHelp プロジェクトを作成する

FrameMaker ブックや文書を取り込んで RoboHelp プロジェクトを作成することができます。
  1. RoboHelp スターターページ上で、「取り込み」の下の「詳細」をクリックするか、ファイル/新規/ プロジェクトを選択します。

  2. 新規プロジェクトダイアログボックスの「取り込み」タブで、「FrameMaker ドキュメント」を選択して、「OK」をクリックします。

    FrameMaker ブックまたは ditamap を取り込み RoboHelp プロジェクトを作成する
  3. ファイルの種類ポップアップメニューから FrameMaker ブック文書を選択します。次に、「参照」から FrameMaker ブックを選択し、「開く」をクリックします。

FrameMaker ブックまたは DITAMAP を RoboHelp プロジェクトに取り込む

  1. RoboHelp でプロジェクトを作成するか、既存のプロジェクトを開きます。

  2. ファイル/取り込み/FrameMaker 文書を選択します。

    FrameMaker ブックまたは ditamap を RoboHelp プロジェクトに取り込む
  3. ファイルの種類ポップアップメニューから FrameMaker ブックまたは FrameMaker DITAMAP を選択します。

  4. 「参照」から FrameMaker ブックファイルまたは DITAMAP を選択し、「開く」をクリックします。

  5. オプションとして、DITAVAL ファイルを選択し、「開く」をクリックします。DITAVAL ファイルなしで続行するには、「キャンセル」をクリックします。

FrameMaker 文書を取り込む場合は、表示されたコンテンツ設定ウィザードから、取り込むコンポーネントを選択できます。目次、索引、用語集を選択して、変換設定を指定することができます。

注意: バージョン 6.0 以前で作成された FrameMaker 文書(FRMファイル)は、取り込むことはできますが、リンクすることができません。

FrameMaker ブックまたは DITAMAP を RoboHelp プロジェクトにリンクする

  1. RoboHelp でプロジェクトを作成するか、既存のプロジェクトを開きます。

  2. ファイル/リンク/FrameMaker 文書を選択します。

    FrameMaker ブックまたは ditamap を RoboHelp プロジェクトにリンクする
  3. ファイルの種類ポップアップメニューから FrameMaker ブックまたは FrameMaker DITAMAP を選択します。

  4. 「参照」から FrameMaker ブックファイルまたは DITAMAP を選択し、「開く」をクリックします。

注意: バージョン 6.0 以前で作成された FrameMaker 文書(FRMファイル)は、取り込むことはできますが、リンクすることができません。

リンクされた FrameMaker 文書から HTML トピックを生成する

FrameMaker 文書をリンクしても、トピックが自動的に作成されるわけではありません。 トピックは、プロジェクトや変換設定を設定してから生成します。

 次のいずれかの操作を行います。
  • プロジェクトマネージャーポッドからリンクされた FrameMaker ドキュメントを右クリックしてから、更新/生成を選択します。

  • ファイル/更新/生成を選択します。

ただし、FrameMaker 文書を取り込む場合は、指定した変換設定に従ってトピックが直ちに生成されます。さらに、取り込むコンポーネントを表示された取り込みウィザードから選択することもできます。 目次、索引、用語集を選択して、変換設定を指定することができます。

FrameMaker 目次を変換する

FrameMaker ブックを RoboHelp プロジェクトに取り込む場合には、目次(TOC)を取り込むこともできます。 FrameMaker ブックで定義したナビゲーション構造を維持するには、RoboHelp プロジェクトに目次を取り込みます。

  1. ファイル/取り込み/FrameMaker ドキュメントを選択します。

  2. コンテンツ設定ダイアログボックスの中で、「FrameMaker 目次を変換する」を選択して、FrameMaker TOC ファイルの場所に移動して選択します。

  3. 次のいずれかのオプションを選択します。

    既存の目次に追加
    プロジェクト内の既存の RoboHelp 目次に目次エントリを追加します。リストから既存の RoboHelp 目次を選択します。

    新たに対応する目次を作成する
    RoboHelp プロジェクトに追加された、対応する新しい目次の名前を入力します。

FrameMaker 目次のスタイルは、どの目次項目がブック、サブブックまたはページになるかを決めます。 レベルを決定する際の最も重要な要素は、一番左のインデント、フォントサイズ、フォント太さの順です。その下にインデントされた項目を持つ目次エントリは、RoboHelp 目次の中ではブックになります。目次エントリのインデント、フォントサイズ、フォントの太さがすべて等しい場合には、RoboHelp には階層のない目次が表示されます。

  • 特定の見出しをメインブックにするには、その見出しの下にインデントされた見出しを含むようにするか、配下の見出しでより小さいフォントや太字以外のフォントを使うようにします。

  • 見出しをサブブックにするには、その見出しを主見出しの下に配置します。そして、サブブックの見出しの下にインデントされた見出しを含むようにするか、配下の見出しでより小さいフォントや太字以外のフォントを使うようにします。

  • 見出しをページにするには、その見出しの下にいかなるレベルの見出しも含まないようにします。ページ見出しは、インデントするか、小さいフォントまたは太字以外のフォントを使います。

FrameMaker 目次と RoboHelp 目次の違い

目次は、FrameMaker の目次から取り込むか、RoboHelp の中で生成されたトピックから自動的に生成することもできます。

  • FrameMaker では、目次は、目次に取り込んだ見出しスタイルにしたがって生成されます。RoboHelp では、目次はトピックタイトルにしたがって生成されます。FrameMaker の中でトピック名マーカーを使ってトピックの名前をつけた場合、FrameMaker 文書を取り込んだときの RoboHelp 内でのファイル名は、トピックタイトルとは違う名前になります。

  • FrameMaker 9 ブックの自動生成目次では、FrameMaker 9 ブックのフォルダー構造により、複数のレイヤーを持つコンテンツを作成することができます。

  • RoboHelp では、目次プレースホルダーを別の目次の中に配置することにより、入れ子になった目次を作成することができます。

FrameMaker 索引エントリを取り込む

RoboHelp は、取り込んでいる文書中の索引マーカーに基づいて索引を作成します。 ただし、FrameMaker ブックの中で生成された索引ファイルは、RoboHelp プロジェクトに取り込まれません。

  1. ファイル/取り込み/FrameMaker 文書を選択し、FrameMaker ブックまたは文書を選択します。

  2. コンテンツ設定ダイアログボックスで「索引を変換」を選択して、以下オプションのいずれか選択します。

    既存の索引に追加
    FrameMaker 索引エントリをプロジェクトの既存の RoboHelp 索引に追加します。

    新たに対応する索引を作成する
    RoboHelp プロジェクトに追加された、対応する新しい索引の名前を入力します。

    トピックに追加する
    FrameMaker 索引エントリを、それが表示される各トピックに追加します。

用語集定義を取り込む

RoboHelp は、取り込んでいる文書中の用語集マーカーに基づいて用語集を作成します。 用語集マーカー中のテキストは、用語集の用語であり、マーカーを含む段落のテキストは、その定義です。

  1. ファイル/取り込み/FrameMaker 文書を選択し、FrameMaker ブックまたは文書を選択します。

  2. コンテンツ設定ダイアログボックスで「用語集を変換」を選択して、以下オプションのいずれか選択します。

    既存の用語集に追加
    FrameMaker 用語集をプロジェクトの RoboHelp 用語集に追加します。リストから用語集を選択できます。

    新たに対応する用語集を作成する
    RoboHelp プロジェクトの中で、既存の用語集に関連付けられた対応する新しい用語集の名前を入力します。