Oracle XML Publisherユーザーズ・ガイド

XMLパブリッシャ構成ファイル

管理インタフェースのプロパティ・セット（「管理」を参照）は、構成ファイルを使用して設定することもできます。構成ファイルはオプションです。システムには、デフォルトの構成ファイルはありません。

管理インタフェースでプロパティを定義し、構成ファイルで同じプロパティを定義済である場合、管理インタフェースで定義されたプロパティが優先されます。

重要: 大きいファイルを処理する場合は、一時ディレクトリを設定することをお薦めします。一時ディレクトリを設定しない場合は、大きいファイルの処理時にメモリー不足エラーが発生します。一時ディレクトリを作成するには、管理インタフェースを使用するか、またはsystem-temp-dirプロパティ（後述）を定義します。

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

構成ファイルの設定が必要なケース

管理インタフェースでは、サイト・レベル、データ定義レベルおよびテンプレート・レベルでのプロパティの設定をサポートしています。XMLパブリッシャが複数の中間層マシンにインストールされており、プロパティをサーバー・レベルで設定する場合は、構成ファイルを使用する必要があります。

ファイル名と位置

この構成ファイルにxdo.cfgという名前を指定し、<XDO_TOP>/resourceの下に配置する必要があります。

あるいは、構成ファイルを<JRE_TOP>/jre/libの下に配置できます。

注意: <JRE_TOP>は、コンカレント・ノードのAF_JRE_TOPまたはWebノードのOA_JRE_TOPを指します。

ネームスペース

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

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]は、要素のカーディナリティを示し、次のパターンに対応します。

[0..1]: 要素がオプションで、1回のみ発生する可能性があることを示します。
[0..n]: 要素がオプションで、複数回発生する可能性があることを示します。

構造

<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パブリッシャ構成ファイルのネームスペース。http://xmlns.oracle.com/oxp/config/を指定する必要があります。

説明

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

プロパティ（<properties>要素）
フォント定義（<fonts>要素）

<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>

使用可能なプロパティのリスト

プロパティのリストについては、「管理」の章の「構成」を参照してください。構成ファイルでプロパティを指定する場合、プロパティの内部名を使用します。たとえば、「PDF出力」プロパティの項では、次の内容をリストしています。


プロパティ名	内部名	デフォルト値	説明
PDF出力の圧縮	pdf-compression	True	TrueまたはFalseを指定して、出力PDFファイルの圧縮を制御します。

構成ファイルでこのプロパティを指定するには、次のとおり入力します。

<properties>
  <property name="pdf-compression">false</property>
</properties>

フォント定義

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

<fonts>
<font>
<font-substitute>
<truetype>
<type1>

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パブリッシャ・フォントを定義します。この要素は、主に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>

フォント代替メカニズム

構成ファイルを使用してフォント・マッピングを定義する場合、言語-国ロケール・セクション（たとえば「zh-TW」）を指定する前に、言語専用のロケール・セクション（たとえば「zh」）を指定する必要があります。セクションは順番に指定する必要があります。これは、複数のセクションが一致している場合、最後に一致したセクションが適用されるためです。

次の例は、「zh」および「zh-TW」ロケールに対して必要な代替を実現するマッピングの正しい定義方法を示しています。

 -  xdo.cfg  -
  <fonts locales="zh">     // section for all zh-* locale
     <font family="xxx" style="normal" weight="normal">
       <truetype path="xxx4zh.ttf" />
     </font>
     <font family="yyy" style="normal" weight="normal">
       <truetype path="yyy4zh.ttf" />
     </font>
  </fonts>
  <fonts locales="zh-TW">  // override "zh" section for "zh-TW"
                           // must be after "zh" section
    <font family="yyy" style="normal" weight="normal">
      <truetype path="yyy4zh-TW.ttf" />
    </font>
  </fonts>

この定義により、次の実行時フォント・マッピングが発生します。

「xxx」フォントを使用してzh-TWロケールを割り当てたテンプレートは、フォントxxx4zh.ttfにマッピングされます。
「yyy」フォントを使用してzh-TWロケールを割り当てたテンプレートは、フォントyyy4zh-TW.ttfにマッピングされます。
zhまたはzh-（他の任意の地域）ロケールを割り当てたテンプレートは、xxx4zh.ttfまたはyyy4zh.ttfにマッピングされます。