camel-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From acosent...@apache.org
Subject camel git commit: Added camel-fop docs to gitbook
Date Fri, 25 Mar 2016 09:38:41 GMT
Repository: camel
Updated Branches:
  refs/heads/master ac7662e53 -> 21f5ea96d


Added camel-fop docs to gitbook


Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/21f5ea96
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/21f5ea96
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/21f5ea96

Branch: refs/heads/master
Commit: 21f5ea96d4a18ffb35584daf41e1ce2cf2cd4f60
Parents: ac7662e
Author: Andrea Cosentino <ancosen@gmail.com>
Authored: Fri Mar 25 10:38:00 2016 +0100
Committer: Andrea Cosentino <ancosen@gmail.com>
Committed: Fri Mar 25 10:38:00 2016 +0100

----------------------------------------------------------------------
 components/camel-fop/src/main/docs/fop.adoc | 162 +++++++++++++++++++++++
 docs/user-manual/en/SUMMARY.md              |   1 +
 2 files changed, 163 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/21f5ea96/components/camel-fop/src/main/docs/fop.adoc
----------------------------------------------------------------------
diff --git a/components/camel-fop/src/main/docs/fop.adoc b/components/camel-fop/src/main/docs/fop.adoc
new file mode 100644
index 0000000..43ee192
--- /dev/null
+++ b/components/camel-fop/src/main/docs/fop.adoc
@@ -0,0 +1,162 @@
+[[FOP-FOPComponent]]
+FOP Component
+~~~~~~~~~~~~~
+
+*Available as of Camel 2.10*
+
+The FOP component allows you to render a message into different output
+formats using http://xmlgraphics.apache.org/fop/index.html[Apache FOP].
+
+Maven users will need to add the following dependency to their `pom.xml`
+for this component:
+
+[source,xml]
+------------------------------------------------------------
+<dependency>
+    <groupId>org.apache.camel</groupId>
+    <artifactId>camel-fop</artifactId>
+    <version>x.x.x</version>
+    <!-- use the same version as your Camel core version -->
+</dependency>
+------------------------------------------------------------
+
+[[FOP-URIformat]]
+URI format
+^^^^^^^^^^
+
+[source,java]
+----------------------------
+fop://outputFormat?[options]
+----------------------------
+
+[[FOP-OutputFormats]]
+Output Formats
+^^^^^^^^^^^^^^
+
+The primary output format is PDF but other output
+http://xmlgraphics.apache.org/fop/0.95/output.html[formats] are also
+supported:
+
+[width="100%",cols="10%,10%,80%",options="header",]
+|=======================================================================
+|name |outputFormat |description
+
+|PDF |application/pdf |Portable Document Format
+
+|PS |application/postscript |Adobe Postscript
+
+|PCL |application/x-pcl |Printer Control Language
+
+|PNG |image/png |PNG images
+
+|JPEG |image/jpeg |JPEG images
+
+|SVG |image/svg+xml |Scalable Vector Graphics
+
+|XML |application/X-fop-areatree |Area tree representation
+
+|MIF |application/mif |FrameMaker's MIF
+
+|RTF |application/rtf |Rich Text Format
+
+|TXT |text/plain |Text
+|=======================================================================
+
+The complete list of valid output formats can be found
+http://svn.apache.org/repos/asf/xmlgraphics/commons/trunk/src/java/org/apache/xmlgraphics/util/MimeConstants.java[here]
+
+[[FOP-EndpointOptions]]
+Endpoint Options
+^^^^^^^^^^^^^^^^
+
+// endpoint options: START
+The FOP component supports 5 endpoint options which are listed below:
+
+[width="100%",cols="2s,1,1m,1m,5",options="header"]
+|=======================================================================
+| Name | Group | Default | Java Type | Description
+| outputType | producer |  | FopOutputType | *Required* The primary output format is PDF
but other output formats are also supported.
+| fopFactory | producer |  | FopFactory | Allows to use a custom configured or implementation
of org.apache.fop.apps.FopFactory.
+| userConfigURL | producer |  | String | The location of a configuration file which can be
loaded from classpath or file system.
+| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern
when creating an exchange
+| synchronous | advanced | false | boolean | Sets whether synchronous processing should be
strictly used or Camel is allowed to use asynchronous processing (if supported).
+|=======================================================================
+// endpoint options: END
+
+The location of a configuration file with the following
+http://xmlgraphics.apache.org/fop/1.0/configuration.html[structure].
+From *Camel 2.12* onwards the file is loaded from the classpath by
+default. You can use `file:`, or `classpath:` as prefix to load the
+resource from file or classpath. In previous releases the file is always
+loaded from file system.
+
+fopFactory
+
+ 
+
+Allows to use a custom configured or implementation of
+`org.apache.fop.apps.FopFactory`.
+
+[[FOP-MessageOperations]]
+Message Operations
+^^^^^^^^^^^^^^^^^^
+
+[width="100%",cols="10%,10%,80%",options="header",]
+|=======================================================================
+|name |default value |description
+
+|CamelFop.Output.Format |  | Overrides the output format for that message
+
+|CamelFop.Encrypt.userPassword |  | PDF user password
+
+|CamelFop.Encrypt.ownerPassword |  | PDF owner passoword
+
+|CamelFop.Encrypt.allowPrint | true |Allows printing the PDF
+
+|CamelFop.Encrypt.allowCopyContent |true |Allows copying content of the PDF
+
+|CamelFop.Encrypt.allowEditContent |true |Allows editing content of the PDF
+
+|CamelFop.Encrypt.allowEditAnnotations |true |Allows editing annotation of the PDF
+
+|CamelFop.Render.producer |Apache FOP |Metadata element for the system/software that produces
the document
+
+|CamelFop.Render.creator |  | Metadata element for the user that created the document
+
+|CamelFop.Render.creationDate |  | Creation Date
+
+|CamelFop.Render.author |  | Author of the content of the document
+
+|CamelFop.Render.title |  | Title of the document
+
+|CamelFop.Render.subject |  | Subject of the document
+
+|CamelFop.Render.keywords |  | Set of keywords applicable to this document
+|=======================================================================
+
+[[FOP-Example]]
+Example
+^^^^^^^
+
+Below is an example route that renders PDFs from xml data and xslt
+template and saves the PDF files in target folder:
+
+[source,java]
+---------------------------------
+from("file:source/data/xml")
+    .to("xslt:xslt/template.xsl")
+    .to("fop:application/pdf")
+    .to("file:target/data");
+---------------------------------
+
+For more information, see these resources...
+
+[[FOP-SeeAlso]]
+See Also
+^^^^^^^^
+
+* link:configuring-camel.html[Configuring Camel]
+* link:component.html[Component]
+* link:endpoint.html[Endpoint]
+* link:getting-started.html[Getting Started]
+

http://git-wip-us.apache.org/repos/asf/camel/blob/21f5ea96/docs/user-manual/en/SUMMARY.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md
index 6054bc7..67f18fe 100644
--- a/docs/user-manual/en/SUMMARY.md
+++ b/docs/user-manual/en/SUMMARY.md
@@ -129,6 +129,7 @@
     * [Exec](exec.adoc)
     * [Facebook](facebook.adoc)
     * [Flatpack](flatpack.adoc)
+    * [FOP](fop.adoc)
     * [Ironmq](ironmq.adoc)
     * [JMS](jms.adoc)
     * [JMX](jmx.adoc)


Mime
View raw message