Repository: camel Updated Branches: refs/heads/master 473714e7d -> 027352f86
Added camel-pdf 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/a21e37b8 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/a21e37b8 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/a21e37b8 Branch: refs/heads/master Commit: a21e37b80bbd1774e1f95d54cc7d51256a71e542 Parents: 473714e Author: Andrea Cosentino <anco...@gmail.com> Authored: Tue May 17 11:04:27 2016 +0200 Committer: Andrea Cosentino <anco...@gmail.com> Committed: Tue May 17 11:04:27 2016 +0200 ---------------------------------------------------------------------- components/camel-pdf/src/main/docs/pdf.adoc | 103 +++++++++++++++++++++++ docs/user-manual/en/SUMMARY.md | 1 + 2 files changed, 104 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/a21e37b8/components/camel-pdf/src/main/docs/pdf.adoc ---------------------------------------------------------------------- diff --git a/components/camel-pdf/src/main/docs/pdf.adoc b/components/camel-pdf/src/main/docs/pdf.adoc new file mode 100644 index 0000000..7d6dd66 --- /dev/null +++ b/components/camel-pdf/src/main/docs/pdf.adoc @@ -0,0 +1,103 @@ +[[PDF-PDF]] +PDF +~~~ + +**Available as of Camel 2.16.0** + +The *PDF*: components provides the ability to create, modify or extract +content from PDF documents. This component uses +https://pdfbox.apache.org/[Apache PDFBox] as underlying library to work +with PDF documents. + +In order to use the PDF component, Maven users will need to add the +following dependency to their `pom.xml`: + +*pom.xml* + +[source,xml] +------------------------------------------------------------ +<dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-pdf</artifactId> + <version>x.x.x</version> + <!-- use the same version as your Camel core version --> +</dependency> +------------------------------------------------------------ + +[[PDF-URIformat]] +URI format +^^^^^^^^^^ + +The PDF component only supports producer endpoints. + +[source,java] +----------------------- +pdf:operation[?options] +----------------------- + +[[PDF-Options]] +Options +^^^^^^^ + +// component options: START +The PDF component has no options. +// component options: END + + + +// endpoint options: START +The PDF component supports 11 endpoint options which are listed below: + +{% raw %} +[width="100%",cols="2s,1,1m,1m,5",options="header"] +|======================================================================= +| Name | Group | Default | Java Type | Description +| operation | producer | | PdfOperation | *Required* Operation type +| font | producer | Helvetica | PDFont | Font +| fontSize | producer | 14 | float | Font size in pixels +| marginBottom | producer | 20 | int | Margin bottom in pixels +| marginLeft | producer | 20 | int | Margin left in pixels +| marginRight | producer | 40 | int | Margin right in pixels +| marginTop | producer | 20 | int | Margin top in pixels +| pageSize | producer | PAGE_SIZE_A4 | PDRectangle | Page size +| textProcessingFactory | producer | lineTermination | TextProcessingFactory | Text processing to use. autoFormatting: Text is getting sliced by words then max amount of words that fits in the line will be written into pdf document. With this strategy all words that doesn't fit in the line will be moved to the new line. lineTermination: Builds set of classes for line-termination writing strategy. Text getting sliced by line termination symbol and then it will be written regardless it fits in the line or not. +| 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). +|======================================================================= +{% endraw %} +// endpoint options: END + + +[[PDF-Headers]] +Headers +^^^^^^^ +[width="100%",cols="10%,90%",options="header",] +|======================================================================= +|Header |Description + +|`pdf-document` |*Mandatory* header for `append` operation and ignored in all other +operations. Expected type is +https://pdfbox.apache.org/docs/1.8.9/javadocs/org/apache/pdfbox/pdmodel/PDDocument.html[PDDocument]. +Stores PDF document which will be used for append operation. + +|`protection-policy` |Expected type +ishttps://pdfbox.apache.org/docs/1.8.9/javadocs/org/apache/pdfbox/pdmodel/encryption/ProtectionPolicy.html[ProtectionPolicy]. +If specified then PDF document will be encrypted with it. + +|`decryption-material` |Expected type +ishttps://pdfbox.apache.org/docs/1.8.9/javadocs/org/apache/pdfbox/pdmodel/encryption/DecryptionMaterial.html[DecryptionMaterial]. +*Mandatory* header if PDF document is encrypted. +|======================================================================= + +[[PDF-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/a21e37b8/docs/user-manual/en/SUMMARY.md ---------------------------------------------------------------------- diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md index 6670d3a..91b1b29 100644 --- a/docs/user-manual/en/SUMMARY.md +++ b/docs/user-manual/en/SUMMARY.md @@ -214,6 +214,7 @@ * [Optaplanner](optaplanner.adoc) * [Paho](paho.adoc) * [Paxlogging](paxlogging.adoc) + * [PDF](pdf.adoc) * [Properties](properties.adoc) * [Quickfix](quickfix.adoc) * [Scp](scp.adoc)
