PDF のドキュメントパーツテンプレートライブラリの作成

既定のテンプレートパッケージでは、ファイル docpart_templates.html によってライブラリと一部の既定のドキュメントパーツテンプレートが定義されています。ドキュメントパーツテンプレートライブラリで、レポートの各所で再利用するドキュメントパーツを作成します。ドキュメントの繰り返し部分をプログラムで再定義することなく、パーツテンプレートとして作成できます。

ドキュメントパーツテンプレートは一般的に固定コンテンツとホールで構成されます。これには、ページサイズ、余白、方向に加え、ページヘッダーとページフッターを記述するページレイアウト要素を含めることもできます。PDF のドキュメントパーツテンプレートライブラリの作成のために提供された DOM API HTML 要素と HTML 要素のサブセットを使用して、ドキュメントパーツテンプレートライブラリを作成します。

次のワークフローを使用して、ドキュメントパーツテンプレートライブラリを扱います。

パーツテンプレートライブラリファイルが含まれるテンプレートパッケージを解凍します。
ドキュメントパーツテンプレートファイル (既定の名前は docpart_templates.html) を HTML またはテキストエディターで開きます。
必要に応じて、PDF のドキュメントパーツテンプレートライブラリの構造で説明されている要素を使用してファイルを編集します。
テンプレートパッケージの .css ファイルに、ドキュメントパッケージテンプレートをサポートする任意のスタイルを追加します。PDF テンプレートでのスタイルの変更を参照してください。
編集したライブラリファイルを保存します。
ziptemplate を使用して、テンプレートを再パッケージ化します。

PDF のドキュメントパーツテンプレートライブラリの構造

<dplibrary> 要素を使用して、ドキュメントパーツライブラリを作成します。<dplibrary> 要素を docpart_template.html ファイルの <body> 要素の内部に追加します。テンプレートパッケージでは <dplibrary> 要素を 1 つだけ使用できます。

作成する各ドキュメントパーツテンプレートの <dplibrary> 要素の内部で <dptemplate> 要素を使用します。必要な数だけドキュメントパーツテンプレートを作成できます。

次のコードはドキュメントパーツライブラリの基本的な構造を示します。<dptemplate> 要素には属性 name があります。この属性は、ドキュメントパーツを呼び出すのに使用する名前に設定します。この名前は、Word のクイックパーツギャラリーのパーツの名前と同じです。複数の出力用にテンプレートを作成する場合、両方の場所で同じ名前を使用します。

<body>
    <dplibrary>

        <dptemplate name="myFirstDocPartTemp">
            [Document part template content here--
             holes, fixed content, page layout information, and HTML]
        </dptemplate>

     </dplibrary>
</body>

ドキュメントパーツテンプレートライブラリのコンテンツ

DOM API HTML 要素と、標準の HTML 要素のサブセットを使用して、PDF のドキュメントパーツテンプレートを作成できます。DOM API HTML の使用方法の例については、以下を参照してください。

DOM API HTML 要素

ライブラリとドキュメントパーツの定義に使用する <dplibrary> および <dptemplate> 要素に加え、次の DOM API HTML 要素も PDF テンプレートで使用できます。

目的	要素	属性	値
ページレイアウト	`layout`	`style`	`page-margin: top left bottom right header footer gutter; page-size: height width orientation; page-border: width style color margin surround-header surround-footer`
		`first-page-number`	レイアウトの最初のページの番号
		`page-number-format`	`n` または `N` (数値の場合)、`a`、`A`、`i`、`I`
		`section-break`	このレイアウトのセクションを開始する場所: `Odd Page`、`Even Page` または `Next Page`
ページヘッダー	`pheader`	`type`	`default`, `first`, `even`
ページヘッダー	`pheader`	`template-name`	ヘッダーを定義するドキュメントパーツテンプレート
ページフッター	`pfooter`	`type`	`default`, `first`, `even`
ページフッター	`pfooter`	`template-name`	フッターを定義するドキュメントパーツテンプレート
ページ番号の形式 (レイアウトの `first-page-number` および `page-number-format` と同じ)	`pnumber`	`format`	`n` または `N` (数値の場合)、`a`、`A`、`i`、`I`
	`pnumber`	`initial-value`	この要素を使用するレイアウトの最初のページの番号
ホール	`hole`	`id`	名前でホールを識別する ID
ホール	`hole`	`default-style-name`	スタイルがプログラムで設定されていない場合に使用するスタイルシートのスタイル
目次	`toc`	`number-of-levels`	目次に含める見出しレベルの数
目次	`toc`	`leader-pattern`	使用するリーダーパターン: `dots`、`space`、ピリオドまたは空白
自動番号付け	`autonumber`	`stream-name`	`counter-increment` スタイルで指定されたストリームの名前
現在のページ番号	`page`	属性なし
ドキュメントの総ページ数	`numpages`	属性なし
改ページ	`pagebreak`	属性なし
ターゲットが配置されているページへの番号参照	`pageref`	`target`	ターゲットの ID。`mlreportgen.dom.LinkTarget` を使用してレポート内にターゲットを作成
見出しなどのスタイルのコンテンツをページのヘッダーまたはフッターに挿入 (欄外見出しおよび脚注用)	`styleref`	属性なし	最も近い `h1` 要素のコンテンツを挿入
		`style-name`	ヘッダーまたはフッターに挿入するコンテンツに使用するスタイルの名前
		`outline-level`	ヘッダーまたはフッターに挿入するコンテンツに使用するスタイルのアウトラインレベル
透かしイメージをページレイアウトに挿入	`watermark`	`src`	透かしイメージとして使用するソースファイルのパス。テンプレートパッケージに透かしイメージを保存。PDF ページレイアウトの透かしを参照してください。
		`width`	透かしイメージをスケーリングする幅 (`valueUnits` の形式)。有効な単位は、`px`、`in`、`cm`、`mm`。`pc`、および `pt` です。
		`height`	透かしイメージをスケーリングする高さ (`valueUnits` の形式)

属性の詳細については、以下の対応する DOM API クラスのプロパティを参照してください。

標準の HTML 要素

PDF テンプレートでは、次の標準の HTML 要素を使用できます。

HTML 要素	属性
`a`	`class`, `style`, `href`, `name`
`address`	`class`, `style`
`b`	`class`, `style`
`big`	`class`, `style`
`blockquote`	`class`, `style`
`body`	`class`, `style`
`br`	N/A
`center`	`class`, `style`
`cite`	`class`, `style`
`code`	`class`, `style`
`dd`	`class`, `style`
`del`	`class`, `style`
`dfn`	`class`, `style`
`div`	`class`, `style`
`dl`	`class`, `style`
`dt`	`class`, `style`
`em`	`class`, `style`
`font`	`class`, `style`, `color`, `face`, `size`
`h1, h2, h3, h4, h5, h6`	`class`, `style`, `align`
`hr`	`class`, `style`, `align`
`i`	`class`, `style`
`ins`	`class`, `style`
`img`	`class`, `style`, `src`, `height`, `width`
`kbd`	`class`, `style`
`li`	`class`, `style`
`mark`	`class`, `style`
`nobr`	`class`, `style`
`ol`	`class`, `style`
`p`	`class`, `style`, `align`
`pre`	`class`, `style`
`s`	`class`, `style`
`samp`	`class`, `style`
`small`	`class`, `style`
`span`	`class`, `style`
`strike`	`class`, `style`
`strong`	`class`, `style`
`sub`	`class`, `style`
`sup`	`class`, `style`
`table`	`class`, `style`, `align`, `bgcolor`, `border`, `cellspacing`, `cellpadding`, `frame`, `rules`, `width`
`tbody`	`class`, `style`, `align`, `valign`
`tfoot`	`class`, `style`, `align`, `valign`
`thead`	`class`, `style`, `align`, `valign`
`td`	`class`, `style`, `bgcolor`, `height`, `width`, `colspan`, `rowspan`,`align`, `valign`, `nowrap`
`th`	`class`, `style`, `bgcolor`, `height`, `width`, `colspan`, `rowspan`,`align`, `valign`, `nowrap`
`tr`	`class`, `style`, `align`,`bgcolor`, `valign`
`tt`	`class`, `style`
`u`	`class`, `style`
`ul`	`class`, `style`
`var`	`class`, `style`

これらの要素の詳細については、https://developer.mozilla.org/en-US/docs/Web/HTML/Elementを参照してください。

参考

zipTemplate | unzipTemplate