MadCap Flare は、XML ベースのシングルソースから レスポンシブ Web、ヘルプ、マニュアル、eラーニング コースなどのオンラインと印刷用の出力を生成できるコンテンツ オーサリング ツールです。HTML や XML の知識がなくても、テンプレートと Microsoft Office ライクな GUI を使用してプロのようなコンテンツを作成できます。
Flare は、コンテンツのインポートからオーサリング、パブリッシング、アウトプット分析まで、コンテンツ開発ワークフロー全体を支援します。この記事では、コンテンツを作成する際に役立つ Flare の主なオーサリング機能を紹介します。
レスポンシブ Web デザイン
レスポンシブ Web デザイン (RWD) は、デバイスに応じて表示とコンテンツが自動的に調整されるように HTML5 出力を構築する方法です。タブレットやスマートフォンなどのモバイル デバイスでは、小さな画面でも見やすいように、凝縮された外観と異なるテキストが表示されます。PC やラップトップでも、ブラウザーのサイズを縮小すると同じ効果が得られます。
レスポンシブ Web デザインは、スキンとコンテンツに適用できます。
HTML5 のサイド ナビゲーション スキンとトップ ナビゲーション スキンでは、レスポンシブ出力が常に有効で、必要に応じてターゲット エディターの [スキン] タブで設定を調整できます。Tripane 出力の場合、[スキン エディタ] でレスポンシブ出力を有効にできます。サイド ナビゲーション出力やトップ ナビゲーション出力と同様に、[ターゲット エディタ] で設定の調整が可能です。スキンがレスポンシブ対応の場合、ナビゲーション要素 (メニュー/目次項目 など) は画面のサイズに応じて自動的に調整されます。詳しくは、「レスポンシブ スキン」を参照してください。
出力形式に応じて、メディア クエリとレスポンシブ条件やレスポンシブ レイアウトを組み合わせることで、コンテンツをさまざまなデバイスや画面サイズに対応させることができます。詳しくは、「レスポンシブ条件」と「レスポンシブ レイアウト」を参照してください。
マイクロコンテンツ
マイクロコンテンツは独立した、短く、簡潔な情報です。Flare では、質問と回答のような短いフレーズとそれに対応するレスポンスのコレクションを作成します。このフレーズとレスポンスの組み合わせは、生成した HTML5 出力をユーザーが操作する際にさまざまな方法で使用できます。たとえば、HTML5 出力の検索エクスペリエンスを大幅に向上したり、フィールド レベルの状況依存ヘルプを作成することができます。詳しくは、「マイクロコンテンツ」を参照してください。
Flare の外部でスクリプトを作成したり、ちょっとした工夫をすることで、マイクロコンテンツはチャットボットなどの高度な目的に利用することもできます。
スニペット
スニペットは、シングルソースで繰り返し利用される書式設定されたコンテンツの塊です。スニペットには、テキスト、表、画像など、通常のトピックに含まれるあらゆるものが含まれます。スニペットは、プロジェクト内の 1 つまたは複数のトピックに挿入可能で、コンテンツを 1 つの場所で管理して再利用できます。他のスニペットに挿入して、ネストしたスニペットを作成することもできます。通常、単一の単語や頻繁に変更される非常に短いフレーズは、スニペットに適していません。そのような場合は、代わりに変数を使用するとよいでしょう。
スニペットを使用する主な利点は、トピックごとに同じ情報を繰り返し入力する必要がなく、コンテンツを一度だけ作成すればよいことです。スニペットの内容を変更する場合は、1 か所だけ変更すれば、スニペットが挿入されているすべてのトピックに変更が自動的に反映されます。詳しくは、「スニペット」を参照してください。
変数
変数は、1 か所で編集できる簡潔な書式なしのコンテンツで、プロジェクト全体を通して多くの場所で使用されます。特に、バージョン番号や日付など、頻繁に変更される可能性のあるテキストに適しています。変数は、複数の変数を格納できる変数セットに格納されます。プロジェクト作成時に選択したテンプレートに応じて、Flare は初期変数セットを提供しますが、後で任意の数の変数セットや変数を追加できます。詳しくは、「変数」を参照してください。
条件
条件とは、ファイルやコンテンツのさまざまな領域に適用できるシングルソース機能で、ある情報をある出力では表示し、他の出力では表示しないようにしたり、特定のデバイスや画面サイズでのみ表示するようにできます。たとえば、オンライン用と印刷用の出力の両方を生成する必要があるとします。作成するコンテンツの多くは両方の出力に共通ですが、コンテンツによっては、オンライン出力または印刷用出力のいずれかに専用のものもあります。そのため、それぞれの出力用に条件タグを作成し、出力をビルドする際にタグを使って特定のコンテンツを含めたり、除外することができます。詳しくは、「条件」を参照してください。
条件を使用して、コンテンツをレスポンシブ対応にすることもできます。たとえば、コンテンツを含める/除外するだけでなく、画面のサイズに応じてコンテンツが自動的に変更されるように指定することも可能です。条件をメディア クエリ (ウェブ、タブレット、モバイル) と関連付けることで、コンテンツをさまざまなデバイスで最適に表示したり、読みやすくすることができます。詳しくは、「レスポンシブ条件」を参照してください。
相互参照
相互参照は、あるトピックのテキストを別のトピック (またはトピック内のブックマーク) にリンクします。テキスト ハイパーリンクに似ていますが、コマンドに基づいてリンクを自動的に更新できるという点で、相互参照はより強力です。たとえば、オンライン出力ではテキスト リンクとして表示されますが、印刷用の出力ではページ番号になります。詳しくは、「相互参照」を参照してください。
ベスト プラクティスは、Flare プロジェクト内のファイルや場所へのリンクには相互参照を使用し、プロジェクト外 (Web サイトや外部 PDF など) へのリンクにはハイパーリンクを使用します。例外もありますが、ほとんどの場合、この方法が推奨されます。
リンク ビューア
Flare では、相互参照やテキスト ハイパーリンクの挿入、画像の挿入、トピックへのスタイルシートの適用など、あるファイルを別のファイルに関連付けるさまざまな方法があります。[リンク ビューア] ペイン ([表示] > [リンクビューア]) を使用すると、さまざまなファイルのリンクを確認できます。これは、Flare の最も便利なツールの 1 つです。詳しくは、「ファイル リンクの表示」を参照してください。
画像
コンテンツ ファイル (トピックやスニペットなど) に画像を挿入できます。Flare は、次の種類のラスターおよびベクター画像ファイルに対応しています: BMP、EMF、EPS、EXPS、GIF、HDP、JPG、JPEG、PDF、PNG、PS、SVG、SWF、TIF、TIFF、WDP、WMF、XAML、XPS。画像を挿入する最も簡単な方法の 1 つは、[コンテンツ エクスプローラ] から開いているコンテンツ ファイルにドラッグすることです。また、画像にスタイルを適用して、外観を調整することもできます (サイズ変更、サムネイル ポップアップなど)。詳しくは、「画像」を参照してください。
マルチメディア
YouTube、Vimeo、Windows Media、QuickTime、HTML5 など、さまざまな種類の動画ファイルを Flare プロジェクトに組み込むことができます。さらに、MadCap Flare に付属の MadCap Mimic で作成したムービーへのリンクを挿入することも可能です。3D を使って出力を強化したい場合、Flare は Universal 3D (U3D) ファイルをサポートしています。これらのファイルを使用すると、オンライン出力でインタラクティブな 3D モデルを提供できます。詳しくは、「マルチメディア」を参照してください。
また、PDF 出力でも多数のマルチメディア ファイルがサポートされています。これらのファイルは、PDF を電子フォーマットで閲覧する場合に再生されます。PDF を印刷する場合は、静止画像として表示されます。
目次
Flare では、オンラインと印刷用の両方の出力用の目次ファイルを簡単に作成して編集できます。[コンテンツ エクスプローラ] から [目次エディタ] にトピックをドラッグすることも、手動でブックや項目を追加してファイルにリンクすることもできます。リンクは通常トピックを指しますが、オンライン出力の場合は外部ファイル、他のヘルプ システム、およびムービーを指すことも可能です。ブックや項目はすべて、ユーザーに適した任意の構造に配置できます。オンライン出力では、ユーザーは目次を閲覧して情報を探すことができます。HTML5 のサイド ナビゲーション出力とトップ ナビゲーション出力では、目次項目がメニューのリンクになります。詳しくは、「目次」を参照してください。
[プロジェクト オーガナイザ] にある目次ファイルは、オンライン出力と印刷用出力では動作が異なります。オンライン出力の場合、目次ファイルから出力の目次やメニューが作成されます。印刷用出力の場合、同じ目次ファイルがアウトラインのように機能します。印刷用出力の目次を生成する要素は「プロキシ」と呼ばれ、トピックに挿入されます。プロキシは手動で作成することも、[ターゲット エディタ] の [アドバンスド] タブでオプションを選択して Flare に生成を任せることもできます。どちらの方法にも長所と短所があります。詳しくは、「印刷用の目次の作成」を参照してください。
状況依存ヘルプ (CSH)
状況依存ヘルプ (CSH) は、トピックまたはマイクロコンテンツをリンクやソフトウェア インターフェイスの特定の領域に関連付けます。たとえば、ユーザーがインターフェイスの特定の部分 (ヘルプ ボタンなど) をクリックすると、関連するトピックやマイクロコンテンツが開きます。詳しくは、「状況依存ヘルプ」を参照してください。
動的プレビュー
[プレビュー] ウィンドウを使用して、トピック、スニペット、またはテンプレート ページのクイック プレビューを表示できます。[プレビュー] ウィンドウは動的に変更されます。開いたまま作業することで、XML エディタで行った変更をすぐに確認できます。
このウィンドウは、最初はフローティング ウィンドウとして開きます。デュアル モニターで作業する場合、[プレビュー] ウィンドウを 1 つのモニターにドラッグし、もう一方のモニターでトピックを編集できるため、非常に便利です。[プレビュー] ウィンドウは、いつでもインターフェイスにドッキングできます。
詳しくは、「トピックのプレビュー」を参照してください。
検索
HTML5 ターゲットの場合、サイド ナビゲーション、トップ ナビゲーション、またはスキンレス出力で使用する検索エンジンを MadCap Search、Google Search、または Elasticsearch から選択できます。選択した検索エンジンに応じて、追加で実行できる手順や選択できる機能があります。MadCap Search と Elasticsearch では、出力にマイクロコンテンツを含めて、検索結果を向上させることができます。詳しくは、「検索」を参照してください。
関連情報とツール
MadCap Flare の概要、価格、評価版については、こちらを参照してください。
この資料は、MadCap 社の Web サイトで公開されている「Authoring Key Features」の日本語参考訳です。
This blog first appeared on the MadCap Software website. MadCap Software is the leading software provider for end to-end documentation solutions.