レポートテンプレート

レポートエクスプローラーでは、テンプレートを使用してレポートを書式設定できます。テンプレートは、レポートの固定コンテンツ、形式、およびレイアウトを指定する HTML または Word ドキュメントです。Microsoft^® Word テンプレートを使用すると Word レポートと PDF レポートを書式設定でき、HTML テンプレートを使用すると HTML レポートと PDF レポートを書式設定できます。MATLAB^® Report Generator™ には、PDF レポートと Word レポート用の Word テンプレートと PDF レポートと HTML レポート用の HTML テンプレートの既定のセットが用意されています。これらの既定のテンプレートをコピーしたりカスタマイズしたりすることで独自のテンプレートを作成できます。

テンプレートベースの出力タイプ

レポートエクスプローラーには、一連のテンプレートベースのレポート出力タイプが用意されています。これらの出力タイプは、Report Generator のルート形式コンポーネントまたは Reporter コンポーネントの [ファイル形式] ドロップダウンリストに表示されます。テンプレートベースの出力タイプを選択すると、隣のドロップダウンリストにその出力タイプで使用可能なテンプレート (レポートエクスプローラーの組み込みテンプレート、MATLAB パスまたは MATLAB セッション開始時の現在のディレクトリにあるテンプレートなど) が取り込まれます。既定では、レポートエクスプローラーは既定のテンプレートを使用し、指定された出力タイプにレポートを書式設定します。別のテンプレートを選択するには、隣のリストから選択します。

テンプレートベースの出力タイプ

Name on Form コンポーネント	Name on Report コンポーネント	生成物
`ダイレクト PDF`	`ダイレクト PDF (テンプレートを使用)`	PDF 固有の拡張子をもつ HTML テンプレートに基づくレポートコンテンツと形式の書式設定オブジェクト (FO) 表現。FO 表現は PDF に変換されます。
`PDF (Word 使用)`	`PDF (Word テンプレートを使用)`	Microsoft Word テンプレートを使用した Microsoft Word レポート。Microsoft Word を使用して Word レポートを PDF に変換します。この出力タイプは、Windows でのみ使用できます。レポートサイズは Word のページ容量 (一般的に約 500 ページ) に制限されています。
`HTML`	`HTML (テンプレートを使用)`	HTML テンプレートパッケージを使用した HTML レポートパッケージ。レポートとテンプレートは両方とも、HTML ドキュメント、スタイルシート、イメージ、および JavaScript を含む zip ファイルです。
`マルチページ HTML` (R2024a 以降)	`マルチページ HTML (テンプレートを使用)`	HTML テンプレートパッケージを使用した HTML レポートパッケージ。レポートとテンプレートは両方とも、HTML ドキュメント、スタイルシート、イメージ、および JavaScript を含む zip ファイルです。
`単一ファイルの HTML`	`単一ファイルの HTML (テンプレートを使用)`	HTML テンプレートパッケージを使用した HTML レポート。HTML レポートは、レポートのテキスト、スタイルシート、イメージ、および JavaScript が組み込まれた単一の HTML ファイルです。
`Word`	`Word (テンプレートを使用)`	Microsoft Word レポートを使用した Word レポート。

テンプレートと XSL スタイルシートおよび DSSSL スタイルシートの比較

テンプレート以外にも、レポートエクスプローラーは XSL スタイルシートや DSSSL スタイルシートの使用したレポートの書式設定をサポートしています。XSL スタイルシートは、XSL と呼ばれる XML の方言で作成されたプログラムであり、レポートの中間 XML コンテンツを HTML または PDF 出力に変換して書式設定します。DSSSL スタイルシートは、Lisp の方言で作成されたプログラムであり、レポートの中間 XML コンテンツを Microsoft Word 出力に変換します。レポートエクスプローラーはスタイルシートベースの書式設定をサポートしています。テンプレートが使用可能になる前のリリースでも、Report Generator のレポートエクスプローラーを使った開発と下位互換性があります。新しい Report Generator でレポートエクスプローラーを使って開発する場合は、テンプレートのみを使用してください。その理由は、スタイルシートに比べ、テンプレートには以下に示す大きな利点があるためです。

書式設定: XSL スタイルシートと DSSL スタイルシートの書式オプションは限られています。たとえば、レポート内のすべてのタイトルとすべての本文段落は同じ書式でなければなりません。一方、テンプレートでは、Microsoft Word と HTML ドキュメントで利用可能なすべての書式オプションを使用できます。
スケーラビリティ: レポートエクスプローラーでは、db2dom と呼ばれる MATLAB ベースのファイルコンバーターを使用し、テンプレートに基づいてレポートを変換します。レポートエクスプローラーは Java ベースのファイルコンバーターである xslt と JADE を使用して XSL スタイルシートと DSSSL スタイルシートに基づいてレポートを変換します。db2dom コンバーターは一般的に xslt や JADE よりはるかに高速で、Word 出力と HTML 出力には Java メモリを使用せず、PDF 出力に使用するメモリはかなり少量です。その結果、レポートエクスプローラーでは、スタイルシートベースの出力よりも、テンプレートを使用した方が、より大きいレポートを生成できます。

コンポーネントスタイル

すべてのレポートテンプレートにスタイルシートが含まれます。このスタイルシート (XSL スタイルシートおよび DSSSL スタイルシートと混同しないでください) は、スタイルと呼ばれる、テキスト、段落、リスト、およびテーブルの書式の名前付きセットを定義するドキュメントです。レポート生成中、レポートエクスプローラーのファイルコンバーターである db2dom は、テンプレートスタイルシートを生成されたレポートにコピーして、Report Generator のコンポーネントで生成された段落、テキスト、リスト、およびテーブルにスタイル名を割り当てます。HTML ブラウザーや Microsoft Word などのレポートの表示や出力に使用するプログラムでは、スタイルを使用してレポートを書式設定します。

レポートエクスプローラーの既定のテンプレートは、レポート設定ファイルからレポートエクスプローラーが生成したレポートを書式設定するうえで必要なすべてのスタイルを定義します。このスタイルを他のスタイルと区別するには、たとえば rgParagraph のように、そのスタイルの名前を接頭辞 rg で始めます。既定のテンプレートのコピーでこれらのスタイルの定義をカスタマイズし (ただし、名前はカスタマイズしない)、カスタマイズしたコピーを使用してレポートを生成することで、レポートの外観を変更できます。

カスタマイズされたテンプレートで独自のスタイルを定義して、[StyleName] プロパティが含まれるダイアログのコンポーネントに、そのスタイルを割り当てることもできます。[StyleName] プロパティを含むコンポーネントには、テキスト コンポーネントと段落コンポーネントがあります。このように、コンポーネントの個別のインスタンスの外観をカスタマイズできます。たとえば、段落コンポーネントの既定のスタイルは rgParagraph です。たとえば、myParagraph) のような独自のスタイルを作成し、特定の段落コンポーネントに割り当てることで、そのコンポーネントの出力の外観を既定の rgParagraph スタイルをもつ段落の外観と差別化できます。

コンポーネントテンプレート

レポートエクスプローラーの既定のテンプレートには、コンポーネントテンプレートライブラリが含まれます。コンポーネントテンプレートライブラリは、タイトルページ コンポーネントと章/節コンポーネントなど、レポートエクスプローラーコンポーネントのテンプレートを定義するドキュメントです。ライブラリのテンプレートにはそれぞれ、rgRectoTitlePage のような名前があります。この名前を利用して、Report Generator はライブラリのコンポーネントテンプレートを特定できます。コンポーネントライブラリにより、必要なテンプレートすべてをメインテンプレートと呼ばれる単一のテンプレートに含めて、メインテンプレートから生成されるレポートを書式設定できます。

タイトルページなどのレポートコンポーネントの書式の変更は、既定テンプレートをコピーしたテンプレートの編集や、レポート生成のためにカスタマイズ済みのテンプレートの使用によって可能になります。また、形式コンポーネントのメインテンプレートにサブフォーム コンポーネント用のテンプレートを作成して保存することもできます。このように、カスタムコンテンツとカスタム書式を設定したカスタムレポートコンポーネントを作成できます。たとえば、カスタムタイトルページテンプレートを作成し、サブフォーム コンポーネントと併用すると、タイトルページ コンポーネントで定義されていないサインオフブロックのようなコンテンツを含むタイトルページを生成できます。

コンポーネントホール

レポートエクスプローラーの既定のコンポーネントテンプレートには、ホールと呼ばれるプレースホルダーが含まれます。ホールは、そのテンプレートに固定のコンテンツと他の生成済みのコンテンツに対して、生成済みのコンテンツの挿入先を指定します。たとえば、タイトルページ コンポーネントのテンプレートには、レポートのタイトル、サブタイトル、作成者、概要などのホールが含まれます。レポートエクスプローラーは、これらのホールをレポート生成中に生成されたコンテンツに置き換えます。たとえば、タイトルページ テンプレートのタイトルホールはタイトルページ コンポーネントのタイトルプロパティで指定されたタイトルに置き換えられます。

コンテンツを指定するコンポーネントのホールを再配置したり削除することで、そのコンポーネントのレイアウトとコンテンツを変更できます。たとえば、タイトルページ コンポーネントのテンプレート内でサブタイトルホールを移動または削除すると、タイトルページのサブタイトルの位置調整または削除ができます。また、形式コンポーネントとサブフォーム コンポーネント用に作成するテンプレートにホールを含め、Report Generator 設定ファイルのテンプレートのホール コンポーネントを使用してそのホールを埋めることができます。このようにして、たとえば、タイトルページのレイアウト要件および書式要件と、正確に一致するタイトルページを生成できます。

テンプレートキャッシュ

はじめてレポートエクスプローラーを MATLAB セッションで開くと、レポートエクスプローラーは MATLAB パスでテンプレートを検索します。見つかったすべてのテンプレートはキャッシュに保存されます。また、セッションで作成されたすべてのテンプレートはキャッシュに追加されます。その後、指定したテンプレートのうち、現在のディレクトリにないテンプレートをキャッシュ内で検索します。これによって、レポートエクスプローラーがテンプレートに基づいたレポートを生成する必要があるたびに MATLAB パスを検索する必要がなくなります。MATLAB セッションの最初に MATLAB パス上にないテンプレートを使用しようとすると、レポートエクスプローラーはテンプレートが見つからないことを示します。この場合、MATLAB 作業ディレクトリをテンプレートディレクトリに変更するか、MATLAB パスにそのディレクトリを追加してキャッシュを更新します。キャッシュを更新するには、

>> rptgen.db2dom.TemplateCache.getTheCache(true);

を MATLAB コマンドラインで実行します。