最新バージョン MadCap Flare 2020 の新機能

MadCap Authoring and Management System (AMS)、MadCap Flare、および MadCap Central 最新バージョンがリリースされ、マイクロコンテンツ オーサリングの拡張、新しいコード スニペット エディター、ServiceNow® へのパブリッシング、MadCap Central での非公開 (プライベート) アウトプットのホスティングなど、多数の新機能と拡張が追加されています。

このブログでは、最新バージョンの MadCap Flare 2020 と MadCap Central で利用可能な新機能を紹介します。

API ドキュメントに役立つコード スニペット エディター

多くのライターは、特に API ドキュメントでは、コードをドキュメント化して、さまざまなタイプのコード スニペットをトピックに追加する必要があります。以前のバージョンの Flare でもこれは可能でしたが、行番号を追加したり、シンタックスをハイライト表示するには CSS の知識が必要でした。Flare 2020 では、[Home] リボンから新しいコード スニペット エディターを利用して、トピックにさまざまな言語のコードを簡単に素早く追加できます。シンタックスは、Sublime Text や Notepad++ などのテキスト エディターと同様に、言語に応じて自動的にハイライト表示されます。HTML5 アウトプットでは、[Copy] ボタンをクリックしてコードをサードパーティのエディターにコピーすることができます。また、印刷用のアウトプットを生成する際には、コード スニペットが美しく変換されます。

さらに、コードの上または下にキャプションを追加したり、コード行に番号を振ることもできます。行番号は連番になっており、コード スニペットの途中にコードを追加した場合、自動的に振り直されます。

コード スニペットの外観は、Flare の CSS エディターを使用して変更することもできます。コードのキャプションやコピーボタンの外観、またはコードスニペットの枠線、背景色、パディングなどのスタイルを変更できます。

詳細は、オンライン ヘルプ (英語) を参照してください。

検索と置換機能の大幅な拡張

検索と置換機能が大幅に拡張され、要素の検索機能が同じウィンドウ ペインに統合されました。そのため、ウィンドウ ペインには、[Find Text] と[Find Elements] の 2 つのタブが表示されます。

[Find Text] タブ

このタブは、以前のバージョンの [Find and Replace in Files] ウィンドウ ペインと同様に機能します。プロジェクト内の 1 つまたは複数のファイルのテキストの検索と置換を行うことができます。外観や配置の変更に加えて、次の機能が新たに追加されています。

Find in reviews inbox: レビュー インボックス ([Review] > [File Reviews]) にあるファイルのテキストを検索します。

Create backup (Replace All): 開いていないすべての編集済みファイルのバックアップを作成します。

First result per file: このオプションは、[Find Results] ウィンドウ ペインのトグルボタンに移動しました。

[Find Elements] タブ

このタブは、以前のバージョンの [Find Elements] ウィンドウ ペインと同様に機能します。カスタム タグ、MadCap 固有機能 (ドロップダウン テキスト、コンセプト、式など)、マークアップ、インライン スタイル、スタイル クラスなど、特定の機能を含むファイルを検索できます。今回のリリースでは、複雑な正規表現を使用しなくても、要素を操作できるようにいくつかの機能が追加されています。

ファイル内の検索と置換機能の詳細は、オンライン ヘルプ (英語) を参照してください。

ServiceNow® へのパブリッシング

ServiceNow® は、IT サービス マネジメント (ITSM) をサポートする主要プラットフォームの 1 つであり、世界中の企業で採用されています。新しいプラグインの MadCap Connect for ServiceNow® は、Flare 2020 と連携して自動的に Flare トピックを ServiceNow® ナレッジベースにパブリッシュします。この統合は、Flare でシングルソースのトピックをオーサリングして、ServiceNow® ナレッジベースにパブリッシュしたいライターにとって便利です。

MadCap Connect for ServiceNow® の詳細は、オンライン ヘルプ (英語) と ServiceNow® へのパブリッシュ ガイド (英語) を参照してください。

このプラグインは、(Salesforce® と Zendesk® 用のプラグインと同様に) MadCap Authoring and Management System (AMS) に含まれています。別途購入することもできます。

マイクロコンテンツの拡張

マイクロコンテンツ オーサリングは、大幅に更新および拡張されています。各機能を説明する前に、マイクロコンテンツとは何か、なぜマイクロコンテンツがユーザー エクスペリエンスを向上したいと考えているテクニカル コミュニケーター、教材デザイナー、およびその他のコンテンツ開発者にとって重要なのか、簡単に概要を説明します。

マイクロコンテンツとは、テキスト、画像、動画など、簡単に確認できる、短く簡潔な情報です。検索エンジンを利用したり、チャットボットや音声制御の仮想アシスタントと対話したり、マイクロコンテンツはあらゆる場面で利用されています。特に検索では、検索結果ページの最上部に簡潔で有用なコンテンツを表示し、検索結果の長いリストをスクロールする手間を省いて、検索エクスペリエンスを大幅に向上します。MadCap Flare のオンライン ヘルプでも活用されています。

フレーズへの条件の適用

フレーズを右クリックして、プロジェクト レベルの条件タグを選択することで、個々のマイクロコンテンツ フレーズに条件を適用できるようになりました。これにより、異なるアウトプットに個々のフレーズを含めるか/含めないかを指定できます。

マイクロコンテンツ条件

マイクロコンテンツの利点の 1 つは、フレーズや代替フレーズをトピックやスニペットにリンクして、既存のコンテンツの再利用を容易にできることです。通常のトピックで表示するか、マイクロコンテンツ (例えば、検索結果など) で表示するかに応じて、特定のコンテンツを表示/非表示にしたい場合があります。マイクロコンテンツ条件を使用することで、これを容易に行うことができます。マイクロコンテンツ条件は、Flare のスニペット条件機能に似ていますが、マイクロコンテンツに対して適用されます。

「How to ride a bike.htm」というトピックがあるとします。

この手順には多くのステップがあり、それぞれのステップには説明のためのコンテンツと画像が含まれています。「how to ride a bike」、「ride a bike」、「learning to ride」といったマイクロコンテンツ フレーズを作成して特定のトピックにリンクすることで、読者に対応するマイクロコンテンツを表示できます。しかし、検索結果のマイクロコンテンツには、10 ~ 30 秒で読むことができる短文コンテンツが適しています。マイクロコンテンツ条件を使用することで、タグをリンク先のコンテンツに適用して、検索結果に表示されるものを制御できます。

上記の例では、「TopicOnly」というマイクロコンテンツ条件タグを作成して、トピック全体を表示する場合にのみ表示するコンテンツに適用します。次に、マイクロコンテンツ ファイルでフレーズを選択して右クリックし、[Properties] を選択します。そして、[Micro Content Conditions] タブで「TopicOnly」タグを [Exclude] に設定します。これで、検索結果ではこのコンテンツが表示されなくなります。

アウトプットで、検索結果は次のように表示されます。

4 つのステップのみが表示されており、トピック リンクを選択すると、そのトピックのコンテンツ全体が表示されます。このようにマイクロコンテンツ条件を使用すると、キュレーションされた結果に対して異なるトピックやスニペットを作成したり、マイクロコンテンツ エディターで重複するコンテンツを作成する必要がなくなります。トピックの既存のコンテンツを簡単に再利用できます。

マイクロコンテンツ変数

マイクロコンテンツ変数も同様に機能します。通常のトピックで表示するか、マイクロコンテンツ (例えば、検索結果など) で表示するかに応じて、変数の定義を変更したい場合があります。マイクロコンテンツ条件と同様に、マイクロコンテンツ変数を使用することで、リンクされたコンテンツに対してこれが可能です。マイクロコンテンツ変数は、Flare のスニペット条件機能に似ていますが、マイクロコンテンツに対して適用されます。

ヒント: マイクロコンテンツ条件とマイクロコンテンツ変数を追加する場合、ほかのプロジェクト レベルの条件や変数と切り分けて管理するため、新しい条件タグセットと変数ファイルを作成すると良いでしょう。

状況依存ヘルプ (CSH)

エイリアス エディターが変更され、マイクロコンテンツ フレーズに対して CSH 識別子 (ID) を設定できるようになりました。以前は、CSH ID はトピックにのみ割り当てることができました。

マイクロコンテンツは短いコンテンツを意図しているため、フィールドレベルまたは埋め込みヘルプの実装に最適です。

マイクロコンテンツ フレーズ/応答の組み合わせと CSH ID との関連付けは Flare が処理します。開発者は、アプリケーションからコンテンツを呼び出して、ユーザー エクスペリエンスを向上できます。

フレーズ プロパティ

Flare 2020 では、マイクロコンテンツ エディターでフレーズを右クリックして、[Properties] を選択することで、各マイクロコンテンツ フレーズのプロパティを編集できます。フレーズ ID やフレーズ タイトルを編集したり、検索結果からフレーズを除外するかどうかを指定できます。

フレーズ ID

マイクロコンテンツ フレーズを作成すると、Flare はそのフレーズをフレーズ ID として使用し、必要に応じて単語の間にハイフンを追加します。

フレーズ ID は、エイリアス エディターでフレーズの CSH ID を作成する際に使用されます。プロパティでフレーズ ID を変更すると、エイリアス エディターの CSH ID パスが変更されます。コンテンツを開発者に提供する際に、生成されるマイクロコンテンツ ファイルのファイル名を制御したい場合、フレーズ ID を編集します。

フレーズ タイトル

各マイクロコンテンツ フレーズにはタイトルがあり、デフォルトではメイン フレーズ テキストと同じになります。このタイトルは、CSH を作成して、それを開くブラウザータブに表示されるテキストを制御する場合に使用できます。

ブラウザータブに異なるものを表示する場合、このタイトルを編集します。上記の例では、「How to ride a bike」フレーズが呼び出されると、ブラウザータブに「How to ride a bike」と表示されます。この表示を短くするには、フレーズ タイトルを「Ride a Bike」などに変更します。[Phrase Title] フィールドの右側にあるボタンを使用して、タイトルに変数を挿入することもできます。

検索結果からフレーズを除外

[Phrase Properties] ダイアログの下部に [Include micro content in search results] オプションがあります。

これは、[Properties] ダイアログにあるトピック向けのオプションと似ています。

デフォルトでは、マイクロコンテンツ フレーズは HTML5 アウトプットの検索結果 に含まれます。特定のフレーズや応答を検索結果から除外したい場合は、対象フレーズでこのオプションをオフにします。

マイクロコンテンツ フレーズへの応答は、アプリケーションのフィールドに埋め込まれることがあります。ユーザーがアプリケーション内のフィールドのヘルプ アイコンをクリックまたはマウスオーバーすると、そのフレーズへの応答が表示されます。ユーザーがこのフレーズを検索すると、応答もスニペット検索結果に表示されます。コンテキストによっては、検索結果にそのようなコンテンツを表示したくない場合があります。このチェックボックスをオフにすることで、応答はアプリケーション内の文脈上では表示されますが、検索結果には表示されなくなります。

マイクロコンテンツの拡張の詳細は、MadCap Flare のオンライン ヘルプ (英語) を参照してください。

サイト管理

MadCap Central に「Sites」と呼ばれる新しいページが追加されました。この Sites (サイト) を使用して、複数のプロジェクトとターゲットのすべてのビルドの管理と表示を 1 箇所で行なうことができます。

サイトを追加して設定したら、新しい [Sites] ページで任意の行を展開して、出力情報やそのサイトに関連付けられているリンクを確認できます。これは、[Project] ページからプロジェクトにアクセスしたときに利用可能な [Builds] ページのようなものですが、単一のビューにまとめられています。

この新しい [Sites] ページに関して、いくつかの注目すべき点があります。

複数のドメイン

これまでは、ライセンスで使用可能なドメイン (URL) は 1 つだけでした。サイトの導入により、任意の数のドメインを使用できるようになりました。さらに、各ドメインで使用するプロジェクト、ターゲット、およびビルドを制御できます。ホスト マップ ドメインは、[License Settings] ダイアログではなく、[Sites] ページで設定します。

バニティ

ビルド バニティとターゲット バニティは、「サイト バニティ」に変わり、[Builds] ページではなく、[Sites] ページで管理されます。ライセンス バニティも [License Settings] ダイアログではなく、[Sites] ページ ([URLs] ページ ビュー) で設定できます。

ライブ アウトプット

サイトおよびそのアウトプットは、各プロジェクトの [Builds] ページではなく、[Sites] ページで「ライブ」に設定できます。

URL

[Sites] ページには [URLs] ページビューもあります。

テーマ

[Themes] ページも MadCap Central に追加された素晴らしい機能です。テーマを使用して、マーケティングやブランディングと統一性を持たせるため、各プライベート サイトの異なるインターフェイス要素の外観を制御できます。プライベート サイトについては、後述します。ログイン フィールド、カードの色、グラデーション、ページ ローダー、404 ページ、会社のロゴなどの要素を制御できます。すべてのサイトに対して 1 つのテーマを使用することも、あるいはアウトプットごとに異なるブランディング要件を満たすため複数のテーマを作成することもできます。テーマを作成しない場合、MadCap Central のデフォルトのテーマが使用されます。

既存のテーマを複製して、設定が共通の別のサイト向けに新しいテーマをすばやく作成することもできます。

以下は、[Themes] を使用してブランド化されたプライベート サイトへのログイン ページの例です。

プライベート アウトプットのホスティングとパブリッシュ

[Sites] ページでライブ ビルドを「プライベート」に設定できます。「プライベート」に設定すると、コンテンツを表示するため、ユーザーはメール アドレスとパスワードの入力する必要があります。

資格情報がないと、ユーザーはアウトプットを見ることができません、これにより、SME、従業員、または顧客にターゲット アウトプットへのセキュアなアクセスを提供できます。SME と従業員など、異なるユーザー グループでチームを作成し、プライベート サイトに関連付けることもできます。

MadCap Central でサポートされるアウトプットは、HTML5 と PDF を含めすべてプライベートに設定できます。.CHM や Word など、一部のアウトプットは MadCap Central で表示できません。いったん、ダウンロードする必要があります。これらのアウトプットもプライベートに設定できます。その場合、ユーザーはログインしてから、アウトプット ファイルをダウンロードできます。

新しいビューアー ユーザー タイプ

MadCap Central に「Viewer」と呼ばれる新しいユーザー タイプが追加されました。任意の数の Viewer (ビューアー) に MadCap Central へのアクセスを無料で許可できます。ビューアーはアウトプットを表示できるだけで、ライターや対象分野の専門家 (SME) とは異なり MadCap Central 自体にはアクセスできません。ビューアーと SME でチームを形成し、プライベート サイトに関連付けることもできます。

MadCap Central の管理者は、ビューアーを 1 人ずつ、あるいはまとめて追加することができます。ビューアーを (1 人ずつまたはまとめて) 追加したら、すぐにチームと関連付けることができます。

その他の拡張: タスク、設定、およびコンテキスト メニュー

一新した [Tasks] ダイアログ

タスクの作成と編集に使用する [Tasks] ダイアログが一新されました。

フィールドを整理するため 3 つのタブがあります: [Details]、[Discussion]、および [Attachments]。フィールドも再編成され、スキャンと編集が容易になりました。また、新たに [Status] フィールドが追加されました。[Move] オプションの代わりにこのフィールドを使用して、タスクのマイルストーンや場所を選択できます。

設定とプロフィールの拡張

ユーザー設定 (プロフィール) とライセンス設定に関連したダイアログが拡張され、使いやすくなりました。

[Team Profile] ダイアログも変更され、左側に新しいオプションと、右上にチームに関連付けられたユーザー、プロジェクト、およびサイトを編集するオプションが追加されました。

… (コンテキスト) メニュー

インターフェイスのさまざまな場所で … (コンテキスト) メニューを利用できます。… をクリックすると、ドロップダウン メニューが表示され、インターフェイスのその部分に関連するオプションを選択できます。

これらの新機能の詳細は、MadCap Central のオンライン ヘルプ (英語) を参照してください。

無料のウェビナー

MadCap Flare 2020 の新機能と拡張機能を紹介したウェビナー (英語) もぜひご覧ください。

30 日間無料評価版

無料の評価版では、すべての機能をご利用いただけます。また、ご要望に応じて、製品デモで機能をご紹介いたします。

無料の評価版はこちらからお申込みいただけます。

MadCap Flare の最新リリースをご活用ください!