MadCap Flare クイック スタート ガイド

Transcription

1 クイックスタートガイド Version 12 エクセルソフト株式会社

2 はじめに このたびは MadCap Software 社製品をご利用いただき誠にありがとうございます このクイックスタートガイドでは初めてこの製品を使用される方を対象に サンプルプロジェクトの使用方法について説明しています 2016 年 3 月 17 日 ii

3 目次 目次 1. MadCap Flare 概要 はじめに FLARE のワークフロー インストール FLARE 12 インストールに必要な環境 インストールファイルのダウンロード... 7 インストールの開始 Flare の実行 スタートページの表示 新規プロジェクト開始ウィザード リボンメニューとクラシックメニューのインターフェース切り替え シングルソースからマルチ出力 (HTML HELP) シングルソースからマルチ出力 (WEBHELP モバイル ) トピックの編集 キーワードの追加 目次の編集 お問い合わせ iii

4 1. MadCap Flare 概要 1. MadCap Flare 概要 1.1. はじめに MadCap Flare は パワフルな XML ベースのプロフェッショナル仕様のコンテンツオーサリングとパブリッシングソフトウェア製品です テクニカルライターおよびドキュメントの専門家がマルチ チャンネルパブリッシング用のコンテンツを作成し管理することができます 複雑なデジタル印刷パブリッシング デスクトップパブリッシング ヘルプシステム Web ベースのオンラインパブリッシングなどのプロジェクトを作成する場合 MadCap Flare は プロフェッショナルなヘルプオーサリングとコンテンツ開発ツールのすべてを提供します PDF XPS Word FrameMaker(* 注 1) DITA 統合されたナビゲーション付きの XHTML ( クロスブラウザ クロスプラットフォーム ) Microsoft HTML ヘルプ モバイルプラットフォーム (iphone OS Windows Mobile Android BlackBerry) DotNet Help を MadCap Flare を使用してパブリッシュできます (* 注 1) 日本語版 FrameMaker はサポート対象外とします Flare は 日本語版 FrameMaker 8.0 またはそれ以降をインポートできますが 目次の取り込みができないことがあります インポート後 Flare 内で手動により作成する必要があります また 日本語ファイル名 フォルダ名はサポートされません ( なお Flare での日本語 FrameMaker ファイルの検証は引き続き行っています ) MadCap Flare の用途 : 会社の規定および手順書 リファレンスガイド イラスト付きのガイドブック ナレッジベース ハードウェアおよび保守マニュアル ソフトウェアドキュメント 従業員ハンドブック 状況依存オンラインヘルプ ユーザーマニュアル 他多数 MadCap 製品を Flare に統合すると Flare の機能をさらに強力に拡張できます : MadCap Capture は スクリンキャプチャー用のツールです Flare に無償バンドルされます MadCap Mimic は ムービー作成ツールです MadCap Lingo でローカライズが可能になります Analyzer は 効果的で一貫したプロジェクトの改良を提案し オーサリングの作業速度が向上します Contributor 寄稿モードを使用したコンテンツの寄稿 または Contributor レビューモードを使用したコメントの追加 4

5 1. MadCap Flare 概要 1.2. Flare のワークフロー MadCap Flare は 古いコンテンツをすべてインポートできます Microsoft Word ドキュメント HTML ドキュメント RoboHelp プロジェクト さらには HTML ヘルププロジェクトもインポートします MadCap Flare は HTML の XHTML への直接変換など XML フォーマットにすべて変換します 5

6 2. インストール 2. インストール 2.1. Flare 12 インストールに必要な環境 推奨システム 4096 MB 以上のメモリを推奨 700 MB 以上の空きディスク容量 Intel Pentium 4 以上を推奨 32 bit および 64 bit Windows: Windows 7 Windows 8 Windows 10; ( 必要なすべての更新を含む ) Microsoft.NET Framework サーバーホスティング WebHelp Plus またはサーバーベースの HTML5 は.NET Framework が必要 ソース管理統合のサポート : Team Foundation Server 2005, 2008, 2010, 2012, 2013 または 2015 Subversion 1.5.3, 1.6, 1.7, 1.8 または 1.9, GIT および Perforce , 等式 (Equation) 描画は Java ランタイム環境 (JRE) version 7.51 が必要 SharePoint 統合のサポート : SharePoint 2007, 2010 および 2013 (SharePoint 365 はサポートされません ) Adobe FrameMaker (FrameMaker コンテンツのインポート用 ) )(*1) WebHelp アウトプット HTML5 アウトプットは 次のブラウザーをサポートします : Google Chrome, Mozilla Firefox, および Internet Explorer 11 および Edge HTML5 レスポンシブアウトプットは IE 11 およびそれ以上でサポートされます スキンエディターは IE 11 またはそれ以上がシステムに必要です 注意 : コンパイル時間の減少および最適なパフォーマンスのため 7200 rpm またはそれ以上のハードディスクを推奨します MadCap 製品には Microsoft Windows が必要です Windows を実行可能にするプログラムを使用し Mac 上に Windows をインストールする場合 Mac 上で実行する Windows は 同じようなシステム要件となります (*1) 日本語版 FrameMaker はサポート対象外とします Flare は 日本語版 FrameMaker 8.0 またはそれ以上をインポートできますが 目次の取り込みができません インポート後 Flare 内で手動で作成する必要があります また 日本語ファイル名 フォルダ名はサポートされません 6

7 2. インストール 2.2. インストールファイルのダウンロード MadCap Flare のインストールファイルは 評価版と同じファイルです ライセンスキーを入力しないと評価版として動作します 評価版には 次の制限があります : 評価期間は 30 日間です 評価版で出力される内容はランダムに文字が置換 ( 文字化け ) します インストールファイルは 次のサイトからダウンロードできます エクセルソフト株式会社の評価版ダウンロードページ インストールの開始 ダウンロードしたファイルをダブルクリックすると インストールが開始します 画面の指示に従いイン ストール処理をしてください 1. インストールファイル (SetupMadCapFlare12xx.exe) をダブルクリックします 2. インストール先を確認して [Install] ボタンをクリックします 3. MadCap Flare の Setup ウィザードが表示されますので 画面の指示に従ってインストール操 作を進めます 7

8 2. インストール 4. MadCap Flare のインストールが完了したら MadCap Flare を起動します 最初にユーザーイ ンターフェースの言語を選択します 英語 フランス語 ドイツ語 日本語の中から選択します Japanese( 日本語 ) のユーザーインターフェースを選択します 5. [MadCap Flare のライセンス認証 ] ダイアログが表示されます 評価版として利用する場合は [ 評価版として使用 ] を選択して [FINISH] ボタンをクリックします 評価版は 30 日間利用でき ランダムに出力結果が文字化けしますが ソースファイルは文字化けしていませんので 製品版を購入した際に使用できます 購入してライセンスキーを受け取っている場合 [ ライセンスコードの提供 ] を選択して ライセンスの認証処理をして インストールしたマシンに Flare ライセンスを登録します 購入している場合 評価版として利用する場合 8

9 2. インストール 6. 製品版を購入してライセンスキーを受け取っている場合 手入力では誤ったコードを入力する 可能性が高いため メールで受け取ったライセンスキーをコピーしては貼り付けてください ライセンス認証処理については 別途 MadCap Flare v12 のライセンス認証 ガイドを用意していますので ご参照ください (1) インターネットで自動認証する場合 自動的に MadCap Software 社のライセンス管理サイトに接続し ライセンスが認証され 完了ダイアログが表示されます 完了画面を確認したら ダイアログを閉じます (2) 手動によるライセンス認証インターネット接続ができない場合 手動によるライセンス認証処理が必要になります E メール ライセンスコード PC ID を弊社までご連絡ください ライセンス認証コードの発行手続きをします ライセンス認証コード発行は米国 MadCap Software 社で行いますので 2 3 日 9

10 2. インストール ほどかかります ご連絡先 : 下記のお問い合わせページから [ 製品価格 & ライセンス ] を選択し 上記の必要事項をコメント欄に記載してください 発行されたライセンス認証コードを下記のダイアログにコピーして [FINISH] ボタンをクリックします 7. 製品登録 Flare のライセンス認証が完了すると 製品のアップグレード情報を受け取るための製品登録画面が表示されます この製品登録処理は必須ではございません 製品のアップデート情報は ヘルプメニューからも随時確認できます 8. これでインストールおよびライセンス認証は完了です 10

11 3. Flare の実行 3.1. スタートページの表示 Flare を実行すると最初に [ スタートページ ] が表示されます 新規プロジェクトの開始 既存プロジェクトを開く Flare の操作概要のチュートリアルビデオを見ることができます スタートページには テンプレート チュートリアル ヘルプソースのタブがあります テンプレート : Flare で作業を開始するとき テストプロジェクトを作成する前に テンプレートを選択して どのようにプロジェクトが構築されるかを見ることができます 各種テンプレートが用意されていますので 好みのテンプレートを選択してください チュートリアル : ビデオチュートリアルが多数用意されています 5 分から 10 分程度のチュートリアルを見て Flare の機能 操作方法などを理解できます ヘルプソース : オンラインヘルプ PDF ガイド 録画ウェイビナー ヘルプコミュニティ MadCap ブログなどにアクセスできます 新規プロジェクト開始ウィザード 新規プロジェクト開始ウィザードを開くには 次のようないくつかの方法があります メニューから [ ファイル ] [ 新規プロジェクト ] を選択する [ スタートページ ] の [ テンプレート ] タブからテンプレートを選択する メニューから新規プロジェクトを選択して サンプルトピックを含むテンプレートプロジェクトからクロスプラットフォーム対応の HTML5 ヘルプをビルドしてみます 11

12 1. [ ファイル ] メニューから [ 新規プロジェクト ] を選択します [ 新規プロジェクト開始ウィザード ] ダイアログが表示されます ここで プロジェクト名と保存場所 およびプロジェクトの言語を指定します 日本語プロジェクトとして作成する場合は ここで指定してください 2. 次に サンプルとして [ テンプレートから新規 ] グループから [Knowledge Base Template] を 選択します 3. 出力するターゲットを HTML5 形式にするため 利用可能ターゲットから [HTML5] を選択 します 12

13 4. サンプルファイルが読み込まれ プロジェクトが生成されます Flare の左側のウィンドウには プロジェクトオーガナイザ コンテンツエクスプローラが表示され 中央のウィンドウにはス タートページ トピックページなどの編集画面が表示されます 5. [ プロジェクトオーガナイザ ] から [ ターゲット ] の中に追加された [HTML5 ( プライマリ )] をダ ブルクリックして ターゲットの詳細な設定ができます 13

14 6. [ コンテンツエクスプローラ ] からコンテンツ内のトピックをダブルクリックして トピックを編集することができます 表示される XML エディタ画面では XML ベースのタグ構造も表示されます テキストエディタ画面では XML のソースが表示されます どちらのエディタでも編集ができます 7. サンプルのプロジェクトからプライマリターゲットとして設定された HTML5 形式の WebHelp をビルドします [ プロジェクト ] メニューから [ プライマリのビルド ] を選択します 14

15 8. 画面の下側のビルドペインでターゲットのビルド状況が表示されます 9. 評価版をご利用の場合は ここで生成された出力の文字がランダムにスクランブルされているこ とを示す警告メッセージが表示されます 10. 生成された結果を表示します ブラウザの表示サイズに応じて 自動的に表示が変わる レスポンシブ HTML5 アウトプットを Flare 10 からサポートしています デスクトップ タブレットなどサイズの異なるアウトプットを 別々に生成する必要がなくなります 15

16 16

17 11. なお プロジェクトの言語設定と各ターゲットの言語設定を確認することを忘れないでください この言語設定が正しく指定されていないと 日本語の検索およびビルドが正しく実行されません メニューから [ プロジェクト ] - [ プロジェクトのプロパティ ] を選択し プロジェクトの言語から Japanese (Japan) を選択します また 各ターゲットをダブルクリックして [ ターゲットエディタ ] の [ 言語 ] タブで適切な言語を 選択します 17

18 リボンメニューとクラシックメニューのインターフェース切り替え Flare では リボン UI 形式が採用され リボン機能 クイックアクセスツールバー 新しい入門ウィザードなどでオーサリングが向上し 使いやすくなりました 以前のバージョンのクラシックなメニューとの切り替えも簡単にできます [ ファイル ] メニューの一番下にある [ オプション ] を選択し [ インターフェース ] で [ ツールストリップ ] 選択してください また リボン UI に戻す場合は [ ツール ] メニューから [ オプション ] メニューを選択して メニュースタイルを切り替えてください 18

19 シングルソースからマルチ出力 (HTML Help) Flare は 同じプロジェクトソースから 異なる形式の出力を生成することができます まず Microsoft HTML Help (CHM ヘルプ ) を生成します 1. ターゲットに HTML Help を追加するため [ プロジェクトオーガナイザ ] ペインの [ ターゲット ] を右クリックし [ ターゲットの追加 ] を選択します 2. [ 出力形式 ] から [HTML Help] を選択し ターゲットのファイル名に分かりやすい名前を指定 します ここでは CHM Help とします 3. 次にターゲットの CHM Help を右クリックし ポップアップメニューから [ ビルド ] を選択し HTML Help を生成します 19

20 シングルソースからマルチ出力 (WebHelp モバイル ) Flare では iphone Android BlackBerry などのモバイルデバイス用の出力も生成可能です 1. 前のセクションと同様の手順で ターゲットに [WebHelp Mobile] を追加します 2. 次にターゲットの WebHelp Mobile を右クリックし ポップアップメニューから [ ビルド ] を選択し モバイル用 WebHelp を生成します WebHelp モバイルのプレビュー画面 20

21 3.2. トピックの編集 [ コンテンツエクスプローラ ] で編集するトピックをダブルクリックすると メイン画面に [XML エディ タ ] が開き そのトピックが表示されます この XML エディタで直接トピックを編集します 表示用レイアウトの選択 (Web 用 / 印刷用 ) トピックをダブルクリックして XML エディタで表示します または Flare では トピック画面を分割して ソース画面を表示する [ テキストエディタ ] 画面と ビ ジュアルに XML を編集できる [XML エディタ ] 画面の 2 つの画面を同時に表示することができ ます ソース画面 画面分割コントロール ビジュアルな画面 21

22 3.3. キーワードの追加 [ 表示 ] リボンメニューから [ 索引ウィンドウ ] を選択して トピックのキーワード挿入箇所にカーソル を置き キーワードを追加します 22

23 3.4. 目次の編集 [ プロジェクトオーガナイザ ] で [ 目次 ] を開き [Master ( マスター )] をダブルクリックします 目次エディタが開き 目次を編集できます 編集したい目次項目を選択し 右クリックメニューで [ プロパティ ] を選択します [ プロパティ ] ダイアログで目次にリンクするトピックファイルなどを編集します 23

24 プロジェクトをビルドします 以上で クイックスタートガイドは終了です MadCap Flare v12 には 豊富な機能が盛り込まれています 詳細は Flare Key Features Guide (PDF) または オンラインヘルプを参照してください 24

25 4. お問い合わせ 4. お問い合わせ エクセルソフト株式会社では メンテナンスプランを購入されたお客様からのテクニカルサポートを 下記のお問い合わせ窓口より承っております エクセルソフト株式会社 東京都港区三田 3 丁目 9 番 9 号森伝ビル 6 階 xlsoftkk@xlsoft.com 25