Documentation update for the "output-profile" value necessary for PDF/X-3:2003.

Some updates for the config schema.

git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@428277 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/src/documentation/content/xdocs/trunk/configuration.xml b/src/documentation/content/xdocs/trunk/configuration.xml
index 53a48b2e8732cb15cf1dc353f2281a6f0761018b..99b92c7d377edb0b27ea028ad583b941b25b1d0d 100644 (file)
--- a/src/documentation/content/xdocs/trunk/configuration.xml
+++ b/src/documentation/content/xdocs/trunk/configuration.xml
@@ -221,6 +221,20 @@
       
       <fonts....
     </renderer>]]></source>
+      <p>
+        Another (optional) setting specific to the PDF Renderer is an output color profile, an ICC 
+        color profile which indicates the target color space the PDF file is generated for. This 
+        setting is mainly used in conjunction with the <a href="pdfx.html">PDF/X</a> feature. 
+        An example:
+      </p>
+    <source><![CDATA[
+    <renderer mime="application/pdf">
+      <filterList...
+      
+      <output-profile>C:\FOP\Color\EuropeISOCoatedFOGRA27.icc</output-profile>
+      
+      <fonts....
+    </renderer>]]></source>
     </section>
     <section id="ps-renderer">
       <title>Special Settings for the PostScript Renderer</title>

diff --git a/src/documentation/content/xdocs/trunk/pdfx.xml b/src/documentation/content/xdocs/trunk/pdfx.xml
index 7a526f8f658cf4848aebf3484232f4d8b29baab2..cf796c74dbf3c150c9bffc0e8e1ce16ce981fa2d 100644 (file)
--- a/src/documentation/content/xdocs/trunk/pdfx.xml
+++ b/src/documentation/content/xdocs/trunk/pdfx.xml
@@ -108,9 +108,10 @@ Fop fop = fopFactory.newFop(MimeConstants.MIME_PDF, userAgent);
         <li>
           Don't use CMYK images without an ICC color profile. PDF/X doesn't allow mixing
           color spaces and FOP currently only properly supports the sRGB color space. However,
-          you will need to specify an output device profile (usually a CMYK profile) in the
-          configuration. sRGB won't work here since it's a display device profile, not an
-          output device profile.
+          you will need to specify an 
+          <a href="configuration.html#pdf-renderer">output device profile</a>
+          (usually a CMYK profile) in the configuration. sRGB won't work here since it's a 
+          display device profile, not an output device profile.
         </li>
         <li>
           Don't use non-RGB colors in SVG images. Same issue as with CMYK images.

diff --git a/src/foschema/fop-configuration.xsd b/src/foschema/fop-configuration.xsd
index 2cc0fca56f97ea1055b2827c0e08b154a4e6362c..f1e792858873ad90d4ca4b28165ce9406cd649b1 100644 (file)
--- a/src/foschema/fop-configuration.xsd
+++ b/src/foschema/fop-configuration.xsd
@@ -60,126 +60,159 @@
       <xsd:attribute name="version" use="optional">
         <xsd:simpleType>
           <xsd:restriction base="xsd:string">
-            <xsd:enumeration value="1.0"></xsd:enumeration>
+            <xsd:enumeration value="1.0"/>
           </xsd:restriction>
         </xsd:simpleType>
       </xsd:attribute>
     </xsd:complexType>
   </xsd:element>
-
   <xsd:complexType name="rendererType">
-  <xsd:annotation>
-    <xsd:documentation>This type is stricter than required by FOP, in that it imposes an
+    <xsd:annotation>
+      <xsd:documentation>This type is stricter than required by FOP, in that it imposes an
       order of the elements, which is not required by FOP.</xsd:documentation>
-  </xsd:annotation>
-  <xsd:sequence>
+    </xsd:annotation>
+    <xsd:sequence>
       <xsd:choice minOccurs="0">
-        <xsd:element name="filterList" maxOccurs="2">
-        <xsd:annotation>
-          <xsd:documentation>filterLists are used by the PDF renderer, MIME type
-            application/pdf.</xsd:documentation>
-        </xsd:annotation>
-        <xsd:complexType>
-            <xsd:sequence>
-              <xsd:element name="value" type="xsd:string"
-                maxOccurs="unbounded">
-              </xsd:element>
-            </xsd:sequence>
-            <xsd:attribute name="type" use="optional">
-              <xsd:simpleType>
-                <xsd:restriction base="xsd:string">
-                  <xsd:enumeration value="image"></xsd:enumeration>
-                </xsd:restriction>
-              </xsd:simpleType>
-            </xsd:attribute>
-          </xsd:complexType>
-        </xsd:element>
-        <xsd:element name="auto-rotate-landscape">
-        <xsd:annotation>
-          <xsd:documentation>auto-rotate-landscape is used by the PostScript renderer,
-          MIME type application/postscript.</xsd:documentation>
-        </xsd:annotation>
-        <xsd:simpleType>
-            <xsd:restriction base="xsd:string">
-              <xsd:enumeration value="false"></xsd:enumeration>
-              <xsd:enumeration value="true"></xsd:enumeration>
-            </xsd:restriction>
-          </xsd:simpleType>
-        </xsd:element>
         <xsd:sequence>
-        <xsd:annotation>
-          <xsd:documentation>rendering and text-rendering are used by the PCL renderer,
+          <xsd:annotation>
+            <xsd:documentation>Configuration elements used by the PDF renderer,
+          MIME type application/pdf</xsd:documentation>
+          </xsd:annotation>
+          <xsd:element name="filterList" minOccurs="0" maxOccurs="unbounded">
+            <xsd:annotation>
+              <xsd:documentation>filterLists are used by the PDF renderer, MIME type
+              application/pdf.</xsd:documentation>
+            </xsd:annotation>
+            <xsd:complexType>
+              <xsd:sequence>
+                <xsd:element name="value" type="xsd:string" maxOccurs="unbounded"/>
+              </xsd:sequence>
+              <xsd:attribute name="type" use="optional">
+                <xsd:simpleType>
+                  <xsd:restriction base="xsd:string">
+                    <xsd:enumeration value="default"/>
+                    <xsd:enumeration value="content"/>
+                    <xsd:enumeration value="image"/>
+                    <xsd:enumeration value="jpeg"/>
+                    <xsd:enumeration value="tiff"/>
+                    <xsd:enumeration value="font"/>
+                    <xsd:enumeration value="metadata"/>
+                    <!-- Available values: see PDFFilterList.java -->
+                  </xsd:restriction>
+                </xsd:simpleType>
+              </xsd:attribute>
+            </xsd:complexType>
+          </xsd:element>
+          <xsd:element name="output-profile" type="xsd:string" minOccurs="0">
+            <xsd:annotation>
+              <xsd:documentation>Output color profile used by the PDF renderer. Specifies a 
+              filename to an ICC file.</xsd:documentation>
+            </xsd:annotation>
+          </xsd:element>
+        </xsd:sequence>
+        <xsd:sequence>
+          <xsd:annotation>
+            <xsd:documentation>Configuration elements used by the PostScript renderer,
+          MIME type application/postscript</xsd:documentation>
+          </xsd:annotation>
+          <xsd:element name="auto-rotate-landscape">
+            <xsd:annotation>
+              <xsd:documentation>auto-rotate-landscape is used by the PostScript renderer,
+            MIME type application/postscript.</xsd:documentation>
+            </xsd:annotation>
+            <xsd:simpleType>
+              <xsd:restriction base="xsd:string">
+                <xsd:enumeration value="false"/>
+                <xsd:enumeration value="true"/>
+              </xsd:restriction>
+            </xsd:simpleType>
+          </xsd:element>
+        </xsd:sequence>
+        <xsd:sequence>
+          <xsd:annotation>
+            <xsd:documentation>rendering and text-rendering are used by the PCL renderer,
           MIME type application/vnd.hp-PCL</xsd:documentation>
-        </xsd:annotation>
-        <xsd:element name="rendering" minOccurs="0">
+          </xsd:annotation>
+          <xsd:element name="rendering" minOccurs="0">
             <xsd:simpleType>
               <xsd:restriction base="xsd:string">
-                <xsd:enumeration value="speed"></xsd:enumeration>
-                <xsd:enumeration value="quality"></xsd:enumeration>
+                <xsd:enumeration value="speed"/>
+                <xsd:enumeration value="quality"/>
               </xsd:restriction>
             </xsd:simpleType>
           </xsd:element>
           <xsd:element name="text-rendering" minOccurs="0">
             <xsd:simpleType>
               <xsd:restriction base="xsd:string">
-                <xsd:enumeration value="auto"></xsd:enumeration>
-                <xsd:enumeration value="bitmap"></xsd:enumeration>
+                <xsd:enumeration value="auto"/>
+                <xsd:enumeration value="bitmap"/>
               </xsd:restriction>
             </xsd:simpleType>
           </xsd:element>
         </xsd:sequence>
+        <xsd:sequence>
+          <xsd:annotation>
+            <xsd:documentation>The elements in this sequence apply only to the text renderer,
+          MIME type text/plain.</xsd:documentation>
+          </xsd:annotation>
+          <xsd:element name="encoding" type="xsd:string" default="UTF-8" minOccurs="0"/>
+        </xsd:sequence>
       </xsd:choice>
       <xsd:element name="fonts" minOccurs="0">
         <xsd:complexType>
           <xsd:sequence>
-            <xsd:element name="font" type="fontType"
-              maxOccurs="unbounded">
-            </xsd:element>
+            <xsd:element name="font" type="fontType" maxOccurs="unbounded"/>
           </xsd:sequence>
         </xsd:complexType>
       </xsd:element>
+      <xsd:element name="xml-handler" minOccurs="0" maxOccurs="unbounded">
+        <xsd:complexType>
+          <xsd:complexContent>
+            <xsd:extension base="xsd:anyType"/>
+          </xsd:complexContent>
+        </xsd:complexType>
+      </xsd:element>
     </xsd:sequence>
-    <xsd:attribute name="mime" type="MimeConstants" use="required"></xsd:attribute>
+    <xsd:attribute name="mime" type="MimeConstants" use="required"/>
   </xsd:complexType>
-
   <xsd:complexType name="fontType">
     <xsd:sequence>
-      <xsd:element name="font-triplet" type="fontTripletType" maxOccurs="unbounded"></xsd:element>
+      <xsd:element name="font-triplet" type="fontTripletType" maxOccurs="unbounded"/>
     </xsd:sequence>
-    <xsd:attribute name="metrics-url" type="xsd:anyURI" use="required"></xsd:attribute>
-    <xsd:attribute name="embed-url" type="xsd:anyURI" use="optional"></xsd:attribute>
-    <xsd:attribute name="kerning" use="optional">
+    <xsd:attribute name="metrics-url" type="xsd:anyURI" use="required"/>
+    <xsd:attribute name="embed-url" type="xsd:anyURI" use="optional"/>
+    <xsd:attribute name="kerning" use="optional" default="no">
       <xsd:simpleType>
         <xsd:restriction base="xsd:string">
-          <xsd:enumeration value="yes"></xsd:enumeration>
+          <xsd:enumeration value="yes"/>
+          <xsd:enumeration value="no"/>
         </xsd:restriction>
       </xsd:simpleType>
     </xsd:attribute>
   </xsd:complexType>
-
   <xsd:complexType name="fontTripletType">
-    <xsd:attribute name="name" type="xsd:string" use="required"></xsd:attribute>
-    <xsd:attribute name="style" type="xsd:string" use="required"></xsd:attribute>
-    <xsd:attribute name="weight" type="xsd:string" use="required"></xsd:attribute>
+    <xsd:attribute name="name" type="xsd:string" use="required"/>
+    <xsd:attribute name="style" type="xsd:string" use="required"/>
+    <xsd:attribute name="weight" type="xsd:string" use="required"/>
   </xsd:complexType>
-
   <xsd:simpleType name="MimeConstants">
     <xsd:restriction base="xsd:string">
-      <xsd:enumeration value="application/pdf"></xsd:enumeration>
-      <xsd:enumeration value="application/postscript"></xsd:enumeration>
-      <xsd:enumeration value="application/x-pcl"></xsd:enumeration>
-      <xsd:enumeration value="application/vnd.hp-PCL"></xsd:enumeration>
-      <xsd:enumeration value="application/x-afp"></xsd:enumeration>
-      <xsd:enumeration value="application/vnd.ibm.modcap"></xsd:enumeration>
-      <xsd:enumeration value="text/plain"></xsd:enumeration>
-      <xsd:enumeration value="application/rtf"></xsd:enumeration>
-      <xsd:enumeration value="text/richtext"></xsd:enumeration>
-      <xsd:enumeration value="text/rtf"></xsd:enumeration>
-      <xsd:enumeration value="application/mif"></xsd:enumeration>
-      <xsd:enumeration value="application/X-fop-awt-preview"></xsd:enumeration>
-      <xsd:enumeration value="application/X-fop-print"></xsd:enumeration>
-      <xsd:enumeration value="application/X-fop-areatree"></xsd:enumeration>
+      <xsd:enumeration value="application/pdf"/>
+      <xsd:enumeration value="application/postscript"/>
+      <xsd:enumeration value="application/x-pcl"/>
+      <xsd:enumeration value="application/vnd.hp-PCL"/>
+      <xsd:enumeration value="application/x-afp"/>
+      <xsd:enumeration value="application/vnd.ibm.modcap"/>
+      <xsd:enumeration value="text/plain"/>
+      <xsd:enumeration value="application/rtf"/>
+      <xsd:enumeration value="text/richtext"/>
+      <xsd:enumeration value="text/rtf"/>
+      <xsd:enumeration value="application/mif"/>
+      <xsd:enumeration value="application/X-fop-awt-preview"/>
+      <xsd:enumeration value="application/X-fop-print"/>
+      <xsd:enumeration value="application/X-fop-areatree"/>
+      <xsd:enumeration value="image/png"/>
+      <xsd:enumeration value="image/tiff"/>
     </xsd:restriction>
   </xsd:simpleType>
-
 </xsd:schema>