ヘッダーをスキップ

Oracle XML Publisher Enterpriseユーザーズ・ガイド
リリース5.6.2
B31296-01
目次へ
目次
前のページへ
前へ
次のページへ
次へ

ランタイム・プロパティの設定

構成ファイルでのプロパティの設定

XML Publisherの動作をカスタマイズするには、構成ファイルでプロパティを設定します。構成ファイルはオプションです。デフォルトの構成ファイルはありません。

ファイルは主に次の目的で使用されます。

重要: 大きいファイルを処理する場合は、この構成ファイルを設定して一時ディレクトリを作成することをお薦めします。一時ディレクトリを作成しないと、大きいファイルを処理する際にメモリー不足エラーが発生します。一時ディレクトリを作成するには、system-temp-dirプロパティ(後述)を設定します。

また、構成ファイルを使用してPDFセキュリティ・パスワードを設定する場合は、構成ファイルを保護することをお薦めします。

ファイル名と位置

このファイルにxdo.cfgという名前を指定する必要があります。

構成ファイルは<JRE_TOP>/jre/lib(jdk/jre/libなど)の下に配置します。

ネームスペース

この構成ファイルのネームスペースは次のとおりです。

http://xmlns.oracle.com/oxp/config/

構成ファイルの例

次に、構成ファイルの例を示します。

<config version="1.0.0"
  xmlns="http://xmlns.oracle.com/oxp/config/">

   <!-- Properties -->
   <properties>
      <!-- System level properties -->
      <property name="system-temp-dir">/tmp</property>

      <!--  PDF compression -->
      <property name="pdf-compression">true</property>

     <!--  PDF Security -->
     <property name="pdf-security">true</property>
     <property name="pdf-open-password">user</property>
     <property name="pdf-permissions-password">owner</property>
     <property name="pdf-no-printing">true</property>
     <property name="pdf-no-changing-the-document">true</property>
    </properties>

   <!-- Font setting -->
   <fonts>
      <!-- Font setting (for FO to PDF etc...) -->
      <font family="Arial" style="normal" weight="normal">
         <truetype path="/fonts/Arial.ttf" />
      </font>
      <font family="Default" style="normal" weight="normal">
         <truetype path="/fonts/ALBANWTJ.ttf" />
      </font>

      <!--Font substitute setting (for PDFForm filling etc...) -->
      <font-substitute name="MSGothic">
         <truetype path="/fonts/msgothic.ttc" ttcno="0" />
      </font-substitute>
   </fonts>
</config>      

要素仕様の解釈方法

次に、要素仕様の例を示します。

<Element Name Attribute1="value"
              Attribute2="value"
                                         AttributeN="value"
   <Subelement Name1/>[occurrence-spec]
   <Subelement Name2>...</Subelement Name2>
   <Subelement NameN>...</Subelement NameN>
</Element Name>

[occurrence-spec]は、要素のカーディナリティを示し、次のパターンに対応します。

構造

<config>要素はルート要素です。構造は次のとおりです。

<config version="cdata" xmlns="http://xmlns.oracle.com/oxp/config/">
   <fonts> ... </fonts> [0..n]
   <properties> ... </properties> [0..n]
</config>

属性

変数 説明
version 構成ファイル形式のバージョン番号。1.0.0を指定します。
xmlns XML Publisher構成ファイルのネームスペース。http://xmlns.oracle.com/oxp/config/を指定する必要があります。

説明

構成ファイルのルート要素。この構成ファイルは、次の2つの部分で構成されています。

<fonts>および<properties>要素は、複数回出現する可能性があります。競合する定義が設定されている場合は、最後に出現した定義が優先されます。

プロパティ

この項では、<properties>要素と<property>要素について説明します。

<properties>要素

properties要素の構造は次のとおりです。

<properties locales="cdata">
   <property>...
   </property> [0..n]
</properties>

説明

<properties>要素では、一連のプロパティを定義します。ロケール固有のプロパティを定義するには、ロケール属性を指定します。次に例を示します。

<!-- Properties for all locales -->
<properties>
 ...Property definitions here...
</properties>

<!--Korean specific properties-->
<properties locales="ko-KR">
 ...Korean-specific property definitions here...
</properties>

<property>要素

<property>要素の構造は次のとおりです。

<property name="cdata">
  ...pcdata...
</property>

属性

変数 説明
name プロパティ名を指定します。

説明

プロパティは名前と値のペアです。名前属性にプロパティ名(キー)を、要素値にその値を指定します。

<properties>
  <property name="system-temp-dir">d:\tmp</property>
  <property name="system-cache-page-size">50</property>
  <property name="pdf-replace-smart-quotes">false</property>
</properties>

プロパティのリスト

使用可能なプロパティを次の各表にリストします。次のグループに編成されています。

「一般」プロパティ

次の表は、「一般」プロパティを示しています。

プロパティ名 デフォルト値 説明
system-temp-dir N/A FOプロセッサで大きいファイルの処理時に使用される一時ディレクトリのディレクトリ・パスを入力します。メモリー不足エラーが発生しないように一時ディレクトリを設定することをお薦めします。

「PDF出力」プロパティ

次の表は、PDF出力でサポートされるプロパティを示しています。

プロパティ名 デフォルト値 説明
pdf-compression True TrueまたはFalseを指定して、出力PDFファイルの圧縮を制御します。
pdf-hide-menubar False Trueを指定すると、文書がアクティブなときにビューワ・アプリケーションのメニュー・バーが非表示になります。
pdf-hide-toolbar False Trueを指定すると、文書がアクティブなときにビューワ・アプリケーションのツールバーが非表示になります。
pdf-replace-smartquotes True PDF出力でカールした引用符を直線の引用符と置き換えない場合は、Falseに設定します。

PDFセキュリティ

次のプロパティを使用して、出力PDF文書のセキュリティ設定を制御します。

プロパティ名 デフォルト値 説明
pdf-security False Trueを指定した場合、出力PDFファイルは暗号化されます。次のプロパティも指定する必要があります。
  • pdf-open-password

  • pdf-permissions-password

  • pdf-encryption-level

pdf-open-password N/A このパスワードは、文書のオープンに必要です。このパスワードを使用すると、ユーザーは文書のオープンのみが可能です。このプロパティは、pdf-securityがTrueに設定されている場合のみ使用できます。
pdf-permissions-password N/A このパスワードを使用して、ユーザーはセキュリティ設定を上書きできます。このプロパティは、pdf-securityがTrueに設定されている場合のみ有効です。
pdf-encryption-level 0: 低 出力PDFファイルの暗号化レベルを指定します。指定できる値は次のとおりです。
  • 0: 低(40-bit RC4、Acrobat 3.0以上)

  • 1: 高(128-bit RC4、Acrobat 5.0以上)


このプロパティは、pdf-securityがTrueに設定されている場合のみ有効です。pdf-encryption-levelが0に設定されている場合、次のプロパティも設定できます。
  • pdf-no-printing

  • pdf-no-changing-the-document

  • pdf-no-cceda

  • pdf-no-accff


pdf-encryption-levelが1に設定されている場合、次のプロパティが使用可能です。
  • pdf-enable-accessibility

  • pdf-enable-copying

  • pdf-changes-allowed

  • pdf-printing-allowed

pdf-no-printing False pdf-encryption-levelが0に設定されている場合に使用できる権限。Trueに設定すると、PDFファイルを印刷できません。
pdf-no-changing-the-document False pdf-encryption-levelが0に設定されている場合に使用できる権限。Trueに設定すると、PDFファイルを編集できません。
pdf-no-cceda False pdf-encryption-levelが0に設定されている場合に使用できる権限。Trueに設定すると、コンテキストのコピー、抽出およびアクセシビリティ機能を使用できません。
pdf-no-accff False pdf-encryption-levelが0に設定されている場合に使用できる権限。Trueに設定すると、コメントおよびフォーム・フィールドの追加または変更機能を使用できません。
pdf-enable-accessibility True pdf-encryption-levelが1に設定されている場合に使用できる権限。Trueに設定すると、スクリーン・リーダー・デバイスのテキスト・アクセス機能が使用可能になります。
pdf-enable-copying False pdf-encryption-levelが1に設定されている場合に使用できる権限。Trueに設定すると、テキスト、イメージおよびその他のコンテンツのコピー機能が使用可能になります。
pdf-changes-allowed 0 pdf-encryption-levelが1に設定されている場合に使用できる権限。有効な値は次のとおりです。
  • 0: なし

  • 1: ページの挿入、削除および回転が許可されます。

  • 2: フォーム・フィールドへの入力および署名が許可されます。

  • 3: コメント、フォーム・フィールドへの入力および署名が許可されます。

  • 4: ページの抽出以外のすべての変更が許可されます。

pdf-printing-allowed 0 pdf-encryption-levelが1に設定されている場合に使用できる権限。有効な値は次のとおりです。
  • 0: なし

  • 1: 低解像度(150 dpi)

  • 2: 高解像度

RTF出力

次のプロパティを設定し、RTF出力ファイルを制御できます。

プロパティ名 デフォルト値 説明
rtf-track-changes False Trueに設定すると、出力RTF文書での変更追跡が使用可能になります。
rtf-protect-document-for-tracked-changes False Trueに設定すると、追跡された変更について文書が保護されます。

HTML出力

次のプロパティを設定し、HTML出力ファイルを制御できます。

プロパティ名 デフォルト値 説明
html-image-base-uri N/A イメージ・タグのsrc属性でイメージ・ファイル名の前に挿入されるベースURI。イメージがテンプレートに埋め込まれている場合のみ機能します。
html-image-dir N/A XML Publisherで、テンプレートに埋め込まれているイメージ・ファイルを格納するディレクトリを入力します。
html-css-base-uri N/A 出力HTML文書のカスケード・スタイルシート(CSS)が格納される場所を指定するためにHTMLヘッダーに挿入するベースURI。make-accessibleがTrueである場合はこのプロパティを設定する必要があります。
html-css-dir N/A XML Publisherによりcssファイルが格納されるCSSディレクトリ。make-accessibleがTrueである場合はこのプロパティを設定する必要があります。
html-show-header True Falseに設定すると、HTML出力でテンプレート・ヘッダーが非表示になります。
html-show-footer True Falseに設定すると、HTML出力でテンプレート・フッターが非表示になります。
html-replace-smartquotes True HTML出力でカールした引用符を直線の引用符と置き換えない場合は、Falseに設定します。
html-output-charset UTF-8 出力HTMLのキャラクタ・セットを指定します。
make-accessible False HTML出力をアクセス可能にする場合はTrueを指定します。

「FO処理」プロパティ

次のプロパティを設定し、FO処理を制御できます。

プロパティ名 デフォルト値 説明
digit-substitution None 有効な値は、NoneとNationalです。Noneに設定すると、東ヨーロッパの数字が使用されます。Nationalに設定すると、ヒンディー形式(アラビア・インド数字)が使用されます。この設定は、ロケールがアラビア語の場合のみ有効です。それ以外の場合は無視されます。
system-cache-page-size 50 このプロパティは、「一般」プロパティで「一時ディレクトリ」を指定した場合のみ有効になります。目次の生成に、FOプロセッサでは、ページ数がこのプロパティで指定した値を超えるまでページをキャッシュします。その後、キャッシュしたページを一時ディレクトリ内のファイルに書き込みます。
fo-prevent-variable-header False Trueの場合は、変数ヘッダーのサポートが無効になります。変数ヘッダーをサポートすると、ヘッダーのサイズがコンテンツに応じて自動的に拡張されます。
fo-merge-conflict-resolution False 複数のXSL-FO入力をマージする際、FOプロセッサでは、競合しているIDを解決するためにランダムなプリフィクスを自動的に追加します。このプロパティをTrueに設定すると、この機能が無効になります。
xslt-xdoparser True XML Publisherのパーサーの使用方法を制御します。Falseに設定すると、XSLTは解析されません。
xslt-scalable False XDOパーサーのスケーラブル機能を制御します。このプロパティを有効にするには、xslt-xdoparserプロパティをTrueに設定する必要があります。
rtf-adj-table-border-overlap False 隣接する表の上下の境界の動作を設定します。隣接する表の上下の境界を重ねる場合(たとえば、ある表を複数回繰り返し、その全体が1つの表に見えるようにする場合)は、このプロパティをTrueに設定します。

「RTFテンプレート」プロパティ

次のプロパティを設定し、RTFテンプレートを制御できます。

プロパティ名 デフォルト値 説明
rtf-extract-attribute-sets Auto RTFプロセッサは、生成されたXSL-FO内に属性セットを自動的に抽出します。抽出されたセットは追加FOブロックに配置され、参照できます。これにより、処理パフォーマンスが向上し、ファイル・サイズが縮小されます。
有効な値は次のとおりです。
  • 「使用可能」: すべてのテンプレートおよびサブテンプレートの属性セットを抽出します。

  • 「自動」: テンプレートの属性セットは抽出しますが、サブテンプレートの属性セットは抽出しません。

  • 「使用不可」: 属性セットは抽出しません。

rtf-rewrite-path True RTFテンプレートをXSL-FOに変換する場合、RTFプロセッサは全XPath表記法を表すためにXMLタグ名を自動的にリライトします。このプロパティをFalseに設定すると、この機能は無効になります。
rtf-checkbox-glyph デフォルト値: Albany WT J;9746;9747/A XML PublisherのデフォルトPDF出力フォントには、チェック・ボックスを表すための絵文字は含まれません。テンプレートにチェック・ボックスが含まれる場合、このプロパティを使用して、PDF出力にチェック・ボックスを表すためのUnicodeフォントを定義します。次の構文を使用して、チェックした状態を表すUnicodeフォント数およびチェック解除状態を表すUnicodeフォント数を定義する必要があります。fontname;<true値の絵文字に対応するUnicodeフォント数 >;<false値の絵文字に対応するUnicodeフォント数>
例: Albany WT J;9746;9747/A
指定したフォントは、実行時にXML Publisherで使用できるようにする必要があります。

「PDFテンプレート」プロパティ

次のプロパティを設定し、PDFテンプレートから生成されるPDF出力ファイルのフォーム・フィールドの動作を構成できます。

プロパティ名 デフォルト値 説明
remove-pdf-fields False 出力からPDFフィールドを削除する場合はTrueを指定します。PDFフィールドを削除した場合、フィールドに入力されたデータは抽出できません。詳細は、「フィールドに対する更新可能または読取り専用の設定」を参照してください。
all-field-readonly True XML Publisherでは、デフォルトで、PDFテンプレートの出力PDFの全フィールドが読取り専用に設定されます。すべてのフィールドを更新可能に設定する場合は、このプロパティをFalseに設定します。詳細は、「フィールドに対する更新可能または読取り専用の設定」を参照してください。
all-fields-readonly-asis False 各フィールドの読取り専用設定をPDFテンプレートの定義どおりに保持する場合は、このプロパティをTrueに設定します。このプロパティはall-field-readonlyの設定より優先されます。詳細は、「フィールドに対する更新可能または読取り専用の設定」を参照してください。

「PDF文書マージ機能」プロパティ

プロパティ名 デフォルト値 説明
pdf-tempfile-max-size 無制限 このプロパティは、PDF文書マージ機能によるバッチ処理で使用される一時ファイルの最大サイズを設定します。最大サイズ(バイト単位)を入力します。詳細は、「PDF文書マージ機能」を参照してください。

XLIFF抽出

次のプロパティを設定し、XLIFF抽出を制御できます。

プロパティ名 デフォルト値 説明
xliff-trans-expansion 150(パーセント) このプロパティによって、抽出した翻訳単位に対する拡張の最大パーセントが決まります。たとえば、このプロパティを200に設定すると、XLIFF抽出装置で200%まで拡張できます。つまり、10文字の要素の場合は、最大幅が30文字になります。
xliff-trans-min-length 15(文字) 抽出される翻訳単位に対する最小の長さを文字数で設定します。たとえば、4文字のフィールドのデフォルト最大拡張は(翻訳拡張パーセントのデフォルト設定150に基づいて)10文字になりますが、最小翻訳長が15である場合、このフィールドが15文字にリセットされます。
xliff-trans-max-length 4000(文字) 翻訳単位(文字数)で算出された拡張に制限を設定します。たとえば、100文字のデフォルト最大拡張は250文字になりますが、最大翻訳長を200に設定すると、この拡張が200文字に制限されます。
xliff-trans-null False 空白のみが含まれたレコード(nullのレコード)の翻訳単位を作成するようXLIFF抽出装置に指示します。Trueに設定すると、この翻訳単位が生成されます。
xliff-trans-symbol False 記号文字を抽出するかどうかをXLIFF抽出装置に指示します。Falseに設定すると、A〜Zおよびa〜zのみが抽出されます。
xliff-trans-keyword True Falseに設定すると、アンダースコアを含む単語は抽出されません。

フォント定義

フォント定義には、次の要素が含まれます。

TrueTypeおよびType1フォントのリストについては、「事前定義済のフォント」を参照してください。

<fonts>要素

<fonts>要素の構造は次のとおりです。

<fonts locales="cdata">
   <font> ... </font> [0..n]
   <font-substitute> ... </font-substitute> [0..n]
</fonts>

属性

変数 説明
locales このフォント定義のロケールを指定します。この属性はオプションです。

説明

<fonts>要素では、一連のフォントを定義します。ロケール固有のフォントを定義するには、ロケール属性を指定します。

<!-- Font definitions for all locales -->
<fonts>
  ..Font definitions here...
</fonts>

<!-- Korean-specific font definitions -->
<fonts locales="ko-KR">
... Korean Font definitions here...
</fonts>

<font>要素

<font>要素の構造は次のとおりです。

<font family="cdata" style="normalitalic"
weight="normalbold">
   <truetype>...</truetype>
or <type1> ... <type1>
</font>

属性

変数 説明
family フォントのファミリ名を指定します。この属性にDefaultを指定した場合、デフォルトの代替フォントを定義できます。family属性では大/小文字が区別されません。
style フォント・スタイルのnormalまたはitalicを指定します。
weight フォント太さのnormalまたはboldを指定します。

説明

XML Publisherフォントを定義します。この要素は、主にFOからPDFへの処理(RTFからPDF)用のフォントを定義するために使用されます。PDFフォーム・プロセッサ(PDFテンプレート用)は、この要素を参照しません。

<!-- Define "Arial" font -->
<font family="Arial" style="normal" weight="normal">
  <truetype path="/fonts/Arial.ttf"/>
</font>

<font-substitute>要素

font-substitute要素の構造は次のとおりです。

<font-substitute name="cdata">
   <truetype>...</truetype>
or <type1>...</type1>
</font-substitute>

属性

変数 説明
name 代替するフォントの名称を指定します。

説明

フォントの代替を定義します。この要素は、PDFフォーム・プロセッサ用のフォントを定義するために使用されます。

<font-substitute name="MSGothic">
   <truetype path="/fonts/msgothic.ttc" ttccno=0"/>
</font-substitute>

<type1>要素

<type1>要素の形式は次のとおりです。

<type1 name="cdata"/>

属性

変数 説明
name Adobe標準のLatin1フォントのいずれかを指定します。たとえば、Courierなどです。

説明

<type1>要素では、Adobe Type1フォントを定義します。

<!--Define "Helvetica" font as "Serif" -->
<font family="serif" style="normal" weight="normal">
  <type1 name="Helvetica"/>
</font>

ロケール

ロケールは、ISO言語コードとISO国コードの組合せです。言語コードはISO 639で、国コードはISO 3166で定義されています。

locale文の構造は次のとおりです。

ISO言語コード-ISO国コード

ロケールでは大/小文字が区別されません。ISO国コードは省略できます。

ロケールの例:

フォント代替ロジック

XML Publisherでは、フォント・マッピング代替ロジックが使用されるため、テンプレートに使用されるフォント・マッピング結果は、テンプレート・レベルからサイト・レベルへのフォント・マッピングの組合せです。複数のレベルにおいてフォントに対するマッピングが見つかった場合、最も特定的なレベルの値がその他の値より優先されます。

特定のインスタンスで使用するフォント・マッピング結果は、すべての適用可能なフォント・マッピングを合せたものとなります。適用可能なマッピングの優先順位は次のとおりです。

Language + Territory match, territory null > Language + Territory null (global value)

次に例を示します。

特定のテンプレートについて、サイト・レベルおよびテンプレート・レベルで割り当てられた異なるフォント・マッピング・セットがあり、次の表に示すマッピングが含まれると仮定します。

レベル フォント・ファミリ スタイル 太さ 言語 地域 ターゲット・フォント
サイト Times New Roman 標準 標準 (なし) (なし) Times
サイト Arial 標準 標準 日本語 日本 Times
テンプレート Arial 標準 標準 日本語 (なし) Courier
テンプレート Trebuchet MS 標準 標準 (なし) (なし) Helvetica

実行時にテンプレート・ファイルのロケールが日本語/日本である場合、次のフォント・マッピングが使用されます。

フォント・ファミリ スタイル 太さ ターゲット・フォント
Times New Roman 標準 標準 Times
Arial 標準 標準 Times
Trebuchet MS 標準 標準 Helvetica

テンプレート・レベルでArialのマッピングが存在しても、サイト・レベル値の方がロケールにより適しているため、この値が使用されます。

事前定義済のフォント

XML Publisherには、事前定義済のフォントがいくつかあります。これらのフォントについては、管理インタフェースでのフォント設定が不要です。

次の表に、Type1フォントを示します。

Type1フォント
番号 フォント・ファミリ スタイル 太さ フォント名
1 serif 標準 標準 Time-Roman
1 serif 標準 太字 Times-Bold
1 serif イタリック体 標準 Times-Italic
1 serif イタリック体 太字 Times-BoldItalic
2 sans-serif 標準 標準 Helvetica
2 sans-serif 標準 太字 Helvetica-Bold
2 sans-serif イタリック体 標準 Helvetica-Oblique
2 sans-serif イタリック体 太字 Helvetica-BoldOblique
3 monospace 標準 標準 Courier
3 monospace 標準 太字 Courier-Bold
3 monospace イタリック体 標準 Courier-Oblique
3 monospace イタリック体 太字 Courier-BoldOblique
4 Courier 標準 標準 Courier
4 Courier 標準 太字 Courier-Bold
4 Courier イタリック体 標準 Courier-Oblique
4 Courier イタリック体 太字 Courier-BoldOblique
5 Helvetica 標準 標準 Helvetica
5 Helvetica 標準 太字 Helvetica-Bold
5 Helvetica イタリック体 標準 Helvetica-Oblique
5 Helvetica イタリック体 太字 Helvetica-BoldOblique
6 Times 標準 標準 Times
6 Times 標準 太字 Times-Bold
6 Times イタリック体 標準 Times-Italic
6 Times イタリック体 太字 Times-BoldItalic
7 Symbol 標準 標準 Symbol
8 ZapfDingbats 標準 標準 ZapfDingbats

次の表に、TrueTypeフォントを示します。すべてのTrueTypeフォントは、サブセット化されてPDFに埋め込まれます。

番号 フォント・ファミリ名 スタイル 太さ 実際のフォント 実際のフォント・タイプ
1 Albany WT 標準 標準 ALBANYWT.ttf TrueType(Latin1のみ)
2 Albany WT J 標準 標準 ALBANWTJ.ttf TrueType(日本語用)
3 Albany WT K 標準 標準 ALBANWTK.ttf TrueType(韓国語用)
4 Albany WT SC 標準 標準 ALBANWTS.ttf TrueType(簡体字中国語用)
5 Albany WT TC 標準 標準 ALBANWTT.ttf TrueType(繁体字中国語用)
6 Andale Duospace WT 標準 標準 ADUO.ttf TrueType(Latin1のみ、固定幅)
6 Andale Duospace WT 太字 太字 ADUOB.ttf TrueType(Latin1のみ、固定幅)
7 Andale Duospace WT J 標準 標準 ADUOJ.ttf TrueType(日本語用、固定幅)
7 Andale Duospace WT J 太字 太字 ADUOJB.ttf TrueType(日本語用、固定幅)
8 Andale Duospace WT K 標準 標準 ADUOK.ttf TrueType(韓国語用、固定幅)
8 Andale Duospace WT K 太字 太字 ADUOKB.ttf TrueType(韓国語用、固定幅)
9 Andale Duospace WT SC 標準 標準 ADUOSC.ttf TrueType(簡体字中国語用、固定幅)
9 Andale Duospace WT SC 太字 太字 ADUOSCB.ttf TrueType(簡体字中国語用、固定幅)
10 Andale Duospace WT TC 標準 標準 ADUOTC.ttf TrueType(繁体字中国語用、固定幅)
10 Andale Duospace WT TC 太字 太字 ADUOTCB.ttf TrueType(繁体字中国語用、固定幅)