You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by or...@apache.org on 2024/02/20 14:42:35 UTC
(camel) branch main updated (c5d92678027 -> 78c47e13a72)
This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a change to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
from c5d92678027 CAMEL-20410: documentation fixes for camel-file
new b1c0b2af0b4 CAMEL-20410: documentation fixes for camel-flink
new 975512d4376 CAMEL-20410: documentation fixes for camel-fop
new 78c47e13a72 CAMEL-20410: documentation fixes for camel-freemarker
The 3 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.../camel-flink/src/main/docs/flink-component.adoc | 6 +++---
components/camel-fop/src/main/docs/fop-component.adoc | 8 ++++----
.../src/main/docs/freemarker-component.adoc | 16 ++++++++--------
3 files changed, 15 insertions(+), 15 deletions(-)
(camel) 03/03: CAMEL-20410: documentation fixes for camel-freemarker
Posted by or...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 78c47e13a72ba0dbcd5a603e4a6a60adf76f17ff
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Tue Feb 20 15:13:16 2024 +0100
CAMEL-20410: documentation fixes for camel-freemarker
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
---
.../src/main/docs/freemarker-component.adoc | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)
diff --git a/components/camel-freemarker/src/main/docs/freemarker-component.adoc b/components/camel-freemarker/src/main/docs/freemarker-component.adoc
index 675b5ed4c78..625b2f3c285 100644
--- a/components/camel-freemarker/src/main/docs/freemarker-component.adoc
+++ b/components/camel-freemarker/src/main/docs/freemarker-component.adoc
@@ -38,7 +38,7 @@ freemarker:templateName[?options]
---------------------------------
Where *templateName* is the classpath-local URI of the template to
-invoke; or the complete URL of the remote template (eg:
+invoke; or the complete URL of the remote template (e.g.:
`\file://folder/myfile.ftl`).
@@ -62,7 +62,7 @@ Headers set during the FreeMarker evaluation are returned to the message
and added as headers. This provides a mechanism for the FreeMarker
component to return values to the Message.
-An example: Set the header value of `fruit` in the FreeMarker template:
+For example, set the header value of `fruit` in the FreeMarker template:
--------------------------------------
${request.setHeader('fruit', 'Apple')}
@@ -96,7 +96,7 @@ a `Map`). The `Exchange` is transferred as:
|`response` |The Out message (only for InOut message exchange pattern).
|=======================================================================
-You can setup your custom FreeMarker context in the
+You can set up your custom FreeMarker context in the
message header with the key "*CamelFreemarkerDataModel*" just like this
[source,java]
@@ -119,7 +119,7 @@ reloading is thus enabled. This scenario can be used in development.
Camel provides two headers by which you can define a different resource
location for a template or the template content itself. If any of these
-headers is set then Camel uses this over the endpoint configured
+headers is set, then Camel uses this over the endpoint configured
resource. This allows you to provide a dynamic template at runtime.
// component headers: START
@@ -128,7 +128,7 @@ include::partial$component-endpoint-headers.adoc[]
== Samples
-For example you could use something like:
+For example, you could use something like:
[source,java]
-------------------------------------------
@@ -140,7 +140,7 @@ To use a FreeMarker template to formulate a response for a message for
InOut message exchanges (where there is a `JMSReplyTo` header).
If you want to use InOnly and consume the message and send it to another
-destination you could use:
+destination, you could use:
[source,java]
-------------------------------------------
@@ -149,7 +149,7 @@ from("activemq:My.Queue").
to("activemq:Another.Queue");
-------------------------------------------
-And to disable the content cache, e.g. for development usage where the
+And to disable the content cache, e.g., for development usage where the
`.ftl` template should be hot reloaded:
[source,java]
@@ -180,7 +180,7 @@ from("direct:in").
== The Email Sample
-In this sample we want to use FreeMarker templating for an order
+In this sample, we want to use FreeMarker templating for an order
confirmation email. The email template is laid out in FreeMarker as:
----------------------------------------------
(camel) 02/03: CAMEL-20410: documentation fixes for camel-fop
Posted by or...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 975512d4376939701f6156e25cd156e264595c5f
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Tue Feb 20 15:11:19 2024 +0100
CAMEL-20410: documentation fixes for camel-fop
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
---
components/camel-fop/src/main/docs/fop-component.adoc | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/components/camel-fop/src/main/docs/fop-component.adoc b/components/camel-fop/src/main/docs/fop-component.adoc
index ba6811d5f53..167f5184770 100644
--- a/components/camel-fop/src/main/docs/fop-component.adoc
+++ b/components/camel-fop/src/main/docs/fop-component.adoc
@@ -38,7 +38,7 @@ fop://outputFormat?[options]
== Output Formats
-The primary output format is PDF but other output
+The primary output format is PDF, but other output
http://xmlgraphics.apache.org/fop/0.95/output.html[formats] are also
supported:
@@ -92,8 +92,8 @@ The location of a configuration file with the following
http://xmlgraphics.apache.org/fop/1.0/configuration.html[structure].
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.
+resource from file or classpath. In previous releases, the file is always
+loaded from the file system.
== Message Operations
@@ -133,7 +133,7 @@ loaded from file system.
== Example
Below is an example route that renders PDFs from xml data and xslt
-template and saves the PDF files in target folder:
+template and saves the PDF files in the target folder:
[source,java]
---------------------------------
(camel) 01/03: CAMEL-20410: documentation fixes for camel-flink
Posted by or...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
commit b1c0b2af0b48a2540b0a1215bec71628d8e8baec
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Tue Feb 20 15:10:34 2024 +0100
CAMEL-20410: documentation fixes for camel-flink
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
---
components/camel-flink/src/main/docs/flink-component.adoc | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/components/camel-flink/src/main/docs/flink-component.adoc b/components/camel-flink/src/main/docs/flink-component.adoc
index a5b1771ef89..b64e3de9203 100644
--- a/components/camel-flink/src/main/docs/flink-component.adoc
+++ b/components/camel-flink/src/main/docs/flink-component.adoc
@@ -16,9 +16,9 @@
This documentation page covers the https://flink.apache.org[Apache Flink]
component for the Apache Camel. The *camel-flink* component provides a
-bridge between Camel components and Flink tasks. +
-This Camel Flink component provides a way to route message from various
-transports, dynamically choosing a flink task to execute, use incoming
+bridge between Camel components and Flink tasks.
+This component provides a way to route a message from various
+transports, dynamically choosing a flink task to execute, use an incoming
message as input data for the task and finally deliver the results back to
the Camel pipeline.