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
The following commit(s) were added to refs/heads/main by this push:
new bd54e23298c CAMEL-21040: ensure more consistency in the document
sections
bd54e23298c is described below
commit bd54e23298cbb07ad5a91b9da9c3955dfd5fde96
Author: Otavio Rodolfo Piske <[email protected]>
AuthorDate: Fri Aug 9 15:50:54 2024 +0200
CAMEL-21040: ensure more consistency in the document sections
- Reorganized examples
---
.../src/main/docs/langchain4j-chat-component.adoc | 2 +-
.../src/main/docs/weather-component.adoc | 4 ++-
.../src/main/docs/whatsapp-component.adoc | 8 +++--
.../src/main/docs/wordpress-component.adoc | 12 ++++---
.../src/main/docs/xchange-component.adoc | 10 +++---
.../camel-xj/src/main/docs/xj-component.adoc | 40 +++++++++++-----------
.../src/main/docs/xmlSecurity-dataformat.adoc | 16 ++++-----
.../src/main/docs/xmlsecurity-sign-component.adoc | 8 ++---
.../main/docs/xmlsecurity-verify-component.adoc | 6 ++--
.../camel-xmpp/src/main/docs/xmpp-component.adoc | 3 +-
.../camel-xpath/src/main/docs/xpath-language.adoc | 20 +++++------
.../src/main/docs/xslt-saxon-component.adoc | 29 ++++++++--------
.../camel-xslt/src/main/docs/xslt-component.adoc | 4 +--
.../camel-zeebe/src/main/docs/zeebe-component.adoc | 22 ++++++------
.../src/main/docs/zipDeflater-dataformat.adoc | 2 +-
.../src/main/docs/zookeeper-master-component.adoc | 4 +--
.../src/main/docs/zookeeper-component.adoc | 4 +--
17 files changed, 104 insertions(+), 90 deletions(-)
diff --git
a/components/camel-ai/camel-langchain4j-chat/src/main/docs/langchain4j-chat-component.adoc
b/components/camel-ai/camel-langchain4j-chat/src/main/docs/langchain4j-chat-component.adoc
index 32a3f771154..561148e00dd 100644
---
a/components/camel-ai/camel-langchain4j-chat/src/main/docs/langchain4j-chat-component.adoc
+++
b/components/camel-ai/camel-langchain4j-chat/src/main/docs/langchain4j-chat-component.adoc
@@ -163,7 +163,7 @@ Camel langchain4j-chat component as a consumer can be used
to implement a LangCh
Right now tools are supported only via the OpenAiChatModel backed by OpenAI
APIs.
Tool Input parameter can be defined as an Endpoint multiValue option in the
form of `parameter.<name>=<type>`,
-or via the endpoint option camelToolParameter for a programmatic approach.
+or via the endpoint option `camelToolParameter` for a programmatic approach.
The parameters can be found as headers in the consumer route, in particular,
if you define `parameter.userId=5`,
in the consumer route `${header.userId}` can be used.
diff --git a/components/camel-weather/src/main/docs/weather-component.adoc
b/components/camel-weather/src/main/docs/weather-component.adoc
index 58823042ab1..e76c9915df5 100644
--- a/components/camel-weather/src/main/docs/weather-component.adoc
+++ b/components/camel-weather/src/main/docs/weather-component.adoc
@@ -61,7 +61,9 @@ include::partial$component-endpoint-options.adoc[]
include::partial$component-endpoint-headers.adoc[]
// component headers: END
-== Exchange data format
+== Usage
+
+=== Exchange data format
Camel will deliver the body as a json formatted `java.lang.String` (see
the `mode` option above).
diff --git a/components/camel-whatsapp/src/main/docs/whatsapp-component.adoc
b/components/camel-whatsapp/src/main/docs/whatsapp-component.adoc
index f505d9d2f21..ff625327810 100644
--- a/components/camel-whatsapp/src/main/docs/whatsapp-component.adoc
+++ b/components/camel-whatsapp/src/main/docs/whatsapp-component.adoc
@@ -64,7 +64,9 @@ include::partial$component-endpoint-headers.adoc[]
The WhatsApp component supports only producer endpoints.
-== Producer Example
+== Examples
+
+=== Producer Example
The following is a basic example of how to send a message to a WhatsApp chat
through the
Business Cloud API.
@@ -86,9 +88,9 @@ from("direct:start")
---------------------------------------------------------
For more information you can refer to
https://developers.facebook.com/docs/whatsapp/cloud-api/reference[Cloud API
Reference], Supported API are:
https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages[Messages]
and
https://developers.facebook.com/docs/whatsapp/cloud-api/reference/media[Media]
-== Webhook Mode
+=== Webhook Mode
-The Whatsapp component supports usage in the *webhook mode* using the
*camel-webhook* component.
+The WhatsApp component supports usage in the *webhook mode* using the
*camel-webhook* component.
To enable webhook mode, users need first to add a REST implementation to their
application.
Maven users, for example, can add *netty-http* to their `pom.xml` file:
diff --git a/components/camel-wordpress/src/main/docs/wordpress-component.adoc
b/components/camel-wordpress/src/main/docs/wordpress-component.adoc
index cf6ad79006a..e259cfa701e 100644
--- a/components/camel-wordpress/src/main/docs/wordpress-component.adoc
+++ b/components/camel-wordpress/src/main/docs/wordpress-component.adoc
@@ -43,7 +43,9 @@ Take the following `Consumer` as example:
wordpress:post?criteria.perPage=10&criteria.orderBy=author&criteria.categories=camel,dozer,json
----
-== Configuring WordPress component
+== Usage
+
+=== Configuring WordPress component
The `WordpressConfiguration` class can be used to set initial properties
configuration to the component instead of passing it as query parameter. The
following listing shows how to set the component to be used in your routes.
@@ -62,14 +64,16 @@ public void configure() {
}
----
-== Consumer Example
+== Examples
+
+=== Consumer Example
Consumer polls from the API from time to time domain objects from WordPress.
Following, an example using the `Post` operation:
- `wordpress:post` retrieves posts (defaults to 10 posts)
- `wordpress:post?id=1` search for a specific post
-== Producer Example
+=== Producer Example
Producer performs write operations on WordPress like adding a new user or
update a post.
To be able to write, you must have an authorized user credentials (see
Authentication).
@@ -78,7 +82,7 @@ To be able to write, you must have an authorized user
credentials (see Authentic
- `wordpress:post?id=1` updates a post based on data
`org.apache.camel.component.wordpress.api.model.Post` from the message body.
- `wordpress:post:delete?id=1` deletes a specific post
-== Authentication
+=== Authentication
Producers that perform write operations, e.g., creating a new post,
https://developer.wordpress.org/rest-api/using-the-rest-api/authentication/[must
have an authenticated user] to do so.
diff --git a/components/camel-xchange/src/main/docs/xchange-component.adoc
b/components/camel-xchange/src/main/docs/xchange-component.adoc
index 8d4cba894ca..3d105dff99b 100644
--- a/components/camel-xchange/src/main/docs/xchange-component.adoc
+++ b/components/camel-xchange/src/main/docs/xchange-component.adoc
@@ -57,16 +57,18 @@ include::partial$component-endpoint-options.adoc[]
include::partial$component-endpoint-headers.adoc[]
// component headers: END
-== Authentication
+== Usage
-This component communicates with supported crypto currency exchanges via REST
API. Some API requests use simple unauthenticated GET request.
-For most of the interesting stuff however, you'd need an account with the
exchange and have API access keys enabled.
+=== Authentication
+
+This component communicates with supported cryptocurrency exchanges via REST
API. Some API requests use simple unauthenticated GET request.
+For most of the interesting stuff, however, you'd need an account with the
exchange and have API access keys enabled.
These API access keys need to be guarded tightly, especially so when they also
allow for the withdraw functionality.
In which case, anyone who can get hold of your API keys can easily transfer
funds from your account to some other address i.e. steal your money.
Your API access keys can be strored in an exchange specific properties file in
your SSH directory.
-For Binance for example this would be: `~/.ssh/binance-secret.keys`
+For Binance, for example, this would be: `~/.ssh/binance-secret.keys`
----
##
diff --git a/components/camel-xj/src/main/docs/xj-component.adoc
b/components/camel-xj/src/main/docs/xj-component.adoc
index 86179469796..9e6a894dec1 100644
--- a/components/camel-xj/src/main/docs/xj-component.adoc
+++ b/components/camel-xj/src/main/docs/xj-component.adoc
@@ -68,13 +68,13 @@ include::partial$component-endpoint-options.adoc[]
include::partial$component-endpoint-headers.adoc[]
// component headers: END
-== Using XJ endpoints
+== Usage
=== Converting JSON to XML
The following route does an "identity" transform of the message because no
xslt stylesheet is given. In the context of
-xml to xml transformations, "Identity" transform means that the output
document is just a copy of the input document.
-In the case of XJ, it means it transforms the json document to an equivalent
xml representation.
+XML to XML transformations, "Identity" transform means that the output
document is just a copy of the input document.
+In the case of XJ, it means it transforms the JSON document to an equivalent
XML representation.
[source,java]
----
@@ -245,12 +245,12 @@ will result in
}
----
-You may have noted that the input xml and output json are very similar to the
examples above when converting from json to xml,
-although nothing special is done here. We only transformed an arbitrary XML
document to json.
+You may have noted that the input XML and output JSON are very similar to the
examples above when converting from json to xml,
+although nothing special is done here. We only transformed an arbitrary XML
document to JSON.
XJ uses the following rules by default:
-* The XML root element can be named somehow, it will always end in a json root
object declaration `{}`
-* The json key name is the name of the xml element
+* The XML root element can be named somehow, it will always end in a JSON root
object declaration `{}`
+* The JSON key name is the name of the XML element
* If there is a name clash as in `<roles>` above where two `<entry>` elements
exist a json array will be generated.
* XML elements with text-only-child-nodes will result in the usual
key/string-value pair. Mixed content elements
result in a key/child-object pair as seen in `<state>` above.
@@ -354,9 +354,9 @@ and get the following output:
}
----
-Note, this transformation resulted in exactly the same json document as we
used as input to the _json2xml_ conversion.
-What did the stylesheet do? We just gave some hints to XJ on how to write the
json document. The following XML
-document is that what is passed to XJ after xsl transformation:
+Note, this transformation resulted in exactly the same JSON document as we
used as input to the _json2xml_ conversion.
+What did the stylesheet do? We just gave some hints to XJ on how to write the
JSON document. The following XML
+document is that what is passed to XJ after XSL transformation:
[source,xml]
----
@@ -380,9 +380,9 @@ document is that what is passed to XJ after xsl
transformation:
----
In the stylesheet we just provided the minimal required type hints to get the
same result.
-The supported type hints are exactly the same as XJ writes to a XML document
when converting from json to xml.
+The supported type hints are exactly the same as XJ writes to an XML document
when converting from json to xml.
-In the end, that means that we can feed back in the result document from the
json to xml transformation sample above:
+In the end, that means that we can feed back in the result document from the
JSON to XML transformation sample above:
[source,xml]
----
@@ -430,7 +430,7 @@ and get the same output again:
As seen in the example above:
* xj:type lets you specify exactly the desired output type
-* xj:name lets you overrule the json key name.
+* xj:name lets you overrule the JSON key name.
This is required when you want to generate key names that contain chars that
aren't allowed in XML element names.
@@ -439,13 +439,13 @@ This is required when you want to generate key names that
contain chars that are
[width="100%",cols="2,4",options="header"]
|===
| @xj:type= | Description
-| object | Generate a json object
-| array | Generate a json array
-| string | Generate a json string
-| int | Generate a json number without fractional part
-| float | Generate a json number with fractional part
-| boolean | Generate a json boolean
-| null | Generate an empty value using the word null
+| `object` | Generate a JSON object
+| `array` | Generate a JSON array
+| `string` | Generate a JSON string
+| `int` | Generate a JSON number without fractional part
+| `float` | Generate a JSON number with fractional part
+| `boolean` | Generate a JSON boolean
+| `null` | Generate an empty value using the word null
|===
diff --git
a/components/camel-xmlsecurity/src/main/docs/xmlSecurity-dataformat.adoc
b/components/camel-xmlsecurity/src/main/docs/xmlSecurity-dataformat.adoc
index 4ddc0d73c9e..e2e744188ab 100644
--- a/components/camel-xmlsecurity/src/main/docs/xmlSecurity-dataformat.adoc
+++ b/components/camel-xmlsecurity/src/main/docs/xmlSecurity-dataformat.adoc
@@ -26,14 +26,14 @@ while being dispatched or received along a route.
*Since Camel 2.9* +
The XMLSecurity Data Format supports asymmetric key encryption. In this
-encryption model a symmetric key is generated and used to perform XML
+encryption model, a symmetric key is generated and used to perform XML
content encryption or decryption. This "content encryption key" is then
itself encrypted using an asymmetric encryption algorithm that leverages
the recipient's public key as the "key encryption key". Use of an
asymmetric key encryption algorithm ensures that only the holder of the
recipient's private key can access the generated symmetric encryption
key. Thus, only the private key holder can decode the message. The
-XMLSecurity Data Format handles all of the logic required to encrypt and
+XMLSecurity Data Format handles all the logic required to encrypt and
decrypt the message content and encryption key(s) using asymmetric key
encryption.
@@ -41,7 +41,7 @@ The XMLSecurity Data Format also has improved support for
namespaces
when processing the XPath queries that select content for encryption. A
namespace definition mapping can be included as part of the data format
configuration. This enables true namespace matching, even if the prefix
-values in the XPath query and the target xml document are not equivalent
+values in the XPath query and the target XML document are not equivalent
strings.
== XMLSecurity Options
@@ -54,19 +54,19 @@ include::partial$dataformat-options.adoc[]
=== Key Cipher Algorithm
The default Key Cipher Algorithm is now
-XMLCipher.RSA_OAEP instead of XMLCipher.RSA_v1dot5. Usage of
-XMLCipher.RSA_v1dot5 is discouraged due to various attacks. Requests
+`XMLCipher.RSA_OAEP` instead of `XMLCipher.RSA_v1dot5`. Usage of
+`XMLCipher.RSA_v1dot5` is discouraged due to various attacks. Requests
that use RSA v1.5 as the key cipher algorithm will be rejected unless it
has been explicitly configured as the key cipher algorithm.
== Marshal
-In order to encrypt the payload, the `marshal` processor needs to be
+To encrypt the payload, the `marshal` processor needs to be
applied on the route followed by the *`xmlSecurity()`* tag.
== Unmarshal
-In order to decrypt the payload, the `unmarshal` processor needs to be
+To decrypt the payload, the `unmarshal` processor needs to be
applied on the route followed by the *`xmlSecurity()`* tag.
== Examples
@@ -145,7 +145,7 @@ context.addRoutes(new RouteBuilder() {
[[XMLSecurityDataFormat-SpringXML]]
Spring XML
-A namespace prefix that is defined as part of the `camelContext`
+A namespace prefix defined as part of the `camelContext`
definition can be re-used in context within the data format `secureTag`
attribute of the `xmlSecurity` element.
diff --git
a/components/camel-xmlsecurity/src/main/docs/xmlsecurity-sign-component.adoc
b/components/camel-xmlsecurity/src/main/docs/xmlsecurity-sign-component.adoc
index bc05b89a25d..c1a9ec4c515 100644
--- a/components/camel-xmlsecurity/src/main/docs/xmlsecurity-sign-component.adoc
+++ b/components/camel-xmlsecurity/src/main/docs/xmlsecurity-sign-component.adoc
@@ -250,7 +250,7 @@ Signatures as Siblings of the Signed Elements".
=== Output Node Determination in Enveloping XML Signature Case
-After the validation the node is extracted from the XML signature
+After the validation, the node is extracted from the XML signature
document which is finally returned to the output-message body. In the
enveloping XML signature case, the default implementation
https://github.com/apache/camel/blob/main/components/camel-xmlsecurity/src/main/java/org/apache/camel/component/xmlsecurity/api/DefaultXmlSignature2Message.java[`DefaultXmlSignature2Message`]
@@ -259,7 +259,7 @@
https://github.com/apache/camel/blob/main/components/camel-xmlsecurity/src/main/
does this for the node search type `Default` in the following way (see
option `xmlSignature2Message`):
-* First an object reference is determined:
+* First, an object reference is determined:
** Only same document references are taken into account (URI must start
with `#`)
@@ -372,7 +372,7 @@ defined in the XML schema (see option `schemaResourceUri`).
You
specify a list of XPATH expressions pointing to attributes of type ID
(see option `xpathsToIdAttributes`). These attributes determine the
elements to be signed. The elements are signed by the same key given by
-the `keyAccessor` bean. Elements with higher (i.e. deeper) hierarchy level
+the `keyAccessor` bean. Elements with higher (i.e., deeper) hierarchy level
are signed first. In the example, the element `C` is signed before the
element `A`.
@@ -475,7 +475,7 @@ method `XAdESSignatureProperties.getSigningCertificate()`
or `XAdESSignatureProp
class `DefaultXAdESSignatureProperties` overwrites the
method `getSigningCertificate()` and allows you to specify the signing
certificate via a keystore and alias. The following example shows all
-parameters you can specify. If you do not need certain parameters you
+parameters you can specify. If you do not need certain parameters, you
can just omit them.
*XAdES-BES/EPES Example in Java DSL*
diff --git
a/components/camel-xmlsecurity/src/main/docs/xmlsecurity-verify-component.adoc
b/components/camel-xmlsecurity/src/main/docs/xmlsecurity-verify-component.adoc
index 89e8c14aea3..f9881c21c53 100644
---
a/components/camel-xmlsecurity/src/main/docs/xmlsecurity-verify-component.adoc
+++
b/components/camel-xmlsecurity/src/main/docs/xmlsecurity-verify-component.adoc
@@ -62,7 +62,7 @@ xmlsecurity-verify:name[?options]
----
* With the signer endpoint, you can generate a XML signature for the
-body of the in-message which can be either a XML document or a plain
+body of the in-message, which can be either a XML document or a plain
text. The enveloped, enveloping, or detached (as of 12.14) XML
signature(s) will be set to the body of the out-message.
* With the verifier endpoint, you can validate an enveloped or
@@ -242,7 +242,7 @@ In the example, the default signature algorithm
`\http://www.w3.org/2000/09/xmldsig#rsa-sha1` is used. You can set the
signature algorithm of your choice by the option `signatureAlgorithm`
(see below). The signer endpoint creates an _enveloping_ XML signature.
-If you want to create an _enveloped_ XML signature then you must specify
+If you want to create an _enveloped_ XML signature, then you must specify
the parent element of the Signature element; see option
`parentLocalName` for more details.
@@ -406,7 +406,7 @@ method `XAdESSignatureProperties.getSigningCertificate()`
or `XAdESSignatureProp
class `DefaultXAdESSignatureProperties` overwrites the
method `getSigningCertificate()` and allows you to specify the signing
certificate via a keystore and alias. The following example shows all
-parameters you can specify. If you do not need certain parameters you
+parameters you can specify. If you do not need certain parameters, you
can just omit them.
*XAdES-BES/EPES Example in Java DSL*
diff --git a/components/camel-xmpp/src/main/docs/xmpp-component.adoc
b/components/camel-xmpp/src/main/docs/xmpp-component.adoc
index 8770747b263..abe390ee83d 100644
--- a/components/camel-xmpp/src/main/docs/xmpp-component.adoc
+++ b/components/camel-xmpp/src/main/docs/xmpp-component.adoc
@@ -60,8 +60,9 @@ include::partial$component-endpoint-options.adoc[]
include::partial$component-endpoint-headers.adoc[]
// component headers: END
+== Usage
-== Headers and setting Subject or Language
+=== Headers and setting Subject or Language
Camel sets the message IN headers as properties on the XMPP message. You
can configure a `HeaderFilterStategy` if you need custom filtering of
diff --git a/components/camel-xpath/src/main/docs/xpath-language.adoc
b/components/camel-xpath/src/main/docs/xpath-language.adoc
index 9fe3011c1ba..09378d3c0b7 100644
--- a/components/camel-xpath/src/main/docs/xpath-language.adoc
+++ b/components/camel-xpath/src/main/docs/xpath-language.adoc
@@ -75,12 +75,12 @@ exchange:
[width="100%",cols="10%,10%,10%,70%",options="header",]
|===
|Function |Argument |Type |Description
-|in:body |none |Object |Will return the message body.
-|in:header |the header name |Object |Will return the message header.
-|out:body |none |Object |*deprecated* Will return the out message body.
-|out:header |the header name |Object |*deprecated* Will return the out message
header.
-|function:properties |key for property |String |To use a
xref:manual:ROOT:using-propertyplaceholder.adoc[Property Placeholder].
-|function:simple |simple expression |Object |To evaluate a
xref:simple-language.adoc[Simple] language.
+|`in:body` |none |Object |Will return the message body.
+|`in:header` |the header name |Object |Will return the message header.
+|`out:body` |none |Object |*deprecated* Will return the out message body.
+|`out:header` |the header name |Object |*deprecated* Will return the out
message header.
+|`function:properties` |key for property |String |To use a
xref:manual:ROOT:using-propertyplaceholder.adoc[Property Placeholder].
+|`function:simple` |simple expression |Object |To evaluate a
xref:simple-language.adoc[Simple] language.
|===
CAUTION: `function:properties` and `function:simple` is not supported
@@ -255,7 +255,7 @@ Namespaces ns = new Namespaces("c",
"http://acme.com/cheese";)
.add("b", "http://acme.com/beer";);
----
-When using namespaces in XML DSL then it is different, as you set up the
namespaces
+When using namespaces in XML DSL, then it is different, as you set up the
namespaces
in the XML root tag (or one of the `camelContext`, `routes`, `route` tags).
In the XML example below we use Spring XML where the namespace is declared in
the root tag `beans`,
@@ -470,7 +470,7 @@ Some points to take into account:
the output because it adds no value
* Default namespaces are listed under the `DEFAULT` keyword in the output
* Keep in mind that namespaces can be remapped under different scopes.
-Think of a top-level 'a' prefix which in inner elements can be assigned
+Think of a top-level `a` prefix which in inner elements can be assigned
a different namespace, or the default namespace changing in inner
scopes. For each discovered prefix, all associated URIs are listed.
@@ -513,7 +513,7 @@ e.g., to refer to a file on the classpath you can do:
.setHeader("myHeader").xpath("resource:classpath:myxpath.txt", String.class)
----
-== Transforming a XML message
+== Transforming an XML message
For basic XML transformation where you have a fixed structure, you can
represent with a combination of using
Camel simple and XPath language as:
@@ -561,7 +561,7 @@ from("direct:start")
Notice how we use `${xpath(exp}` syntax in the simple template to use xpath
that will be evaluated on the message body,
to extract the content to be used in the output (see previous for output).
-Since the simple language can output anything, you can also use this to output
in plain text or JSon, etc.
+Since the simple language can output anything, you can also use this to output
in plain text or JSON, etc.
[source,java]
----
diff --git
a/components/camel-xslt-saxon/src/main/docs/xslt-saxon-component.adoc
b/components/camel-xslt-saxon/src/main/docs/xslt-saxon-component.adoc
index 07067719d2b..e50aebb7eb1 100644
--- a/components/camel-xslt-saxon/src/main/docs/xslt-saxon-component.adoc
+++ b/components/camel-xslt-saxon/src/main/docs/xslt-saxon-component.adoc
@@ -38,9 +38,9 @@ You can append query options to the URI in the following
format:
[options="header"]
|=================================================================
|URI |Description
-|xslt-saxon:com/acme/mytransform.xsl|Refers to the file
com/acme/mytransform.xsl on the classpath
-|xslt-saxon:file:///foo/bar.xsl |Refers to the file /foo/bar.xsl
-|xslt-saxon:http://acme.com/cheese/foo.xsl|Refers to the remote http resource
+|`xslt-saxon:com/acme/mytransform.xsl`|Refers to the file
`com/acme/mytransform.xsl` on the classpath
+|`xslt-saxon:file:///foo/bar.xsl` |Refers to the file `/foo/bar.xsl`
+|`xslt-saxon:http://acme.com/cheese/foo.xsl`|Refers to the remote http resource
|=================================================================
@@ -58,8 +58,9 @@ include::partial$component-endpoint-options.adoc[]
// endpoint options: END
+== Usage
-== Using XSLT endpoints
+=== Using XSLT endpoints
The following format is an example of using an XSLT template to formulate a
response for a message for InOut
message exchanges (where there is a `JMSReplyTo` header)
@@ -81,7 +82,7 @@ from("activemq:My.Queue").
to("activemq:Another.Queue");
----
-== Getting Usable Parameters into the XSLT
+=== Getting Usable Parameters into the XSLT
By default, all headers are added as parameters which are then available in
the XSLT. +
@@ -105,7 +106,7 @@ available:
<xsl:template ...>
----
-== Spring XML versions
+=== Spring XML versions
To use the above examples in Spring XML, you would use something like the
following code:
@@ -120,7 +121,7 @@ To use the above examples in Spring XML, you would use
something like the follow
</camelContext>
----
-== Using xsl:include
+=== Using `xsl:include`
Camel provides its own implementation of `URIResolver`. This allows
Camel to load included files from the classpath.
@@ -140,7 +141,7 @@ the prefix, then Camel uses the prefix from the endpoint
configuration.
If no prefix is specified in the endpoint configuration, the default is
`classpath:`.
You can also refer backwards in the included paths.
-In the following example, the xsl file will be resolved under
`org/apache/camel/component`.
+In the following example, the XSL file will be resolved under
`org/apache/camel/component`.
[source,xml]
----
@@ -148,13 +149,13 @@ In the following example, the xsl file will be resolved
under `org/apache/camel/
----
-== Using xsl:include and default prefix
+=== Using `xsl:include` and default prefix
Camel will use the prefix from the endpoint configuration as the default
prefix.
You can explicitly specify `file:` or `classpath:` loading. The two loading
types can be mixed in an XSLT script, if necessary.
-== Using Saxon extension functions
+=== Using Saxon extension functions
Since Saxon 9.2, writing extension functions has been supplemented by a
new mechanism, referred to
@@ -193,12 +194,12 @@ With Spring XML:
----
-== Dynamic stylesheets
+=== Dynamic stylesheets
To provide a dynamic stylesheet at runtime, you can either:
- Define a dynamic URI. See
xref:manual:faq:how-to-use-a-dynamic-uri-in-to.adoc[How to use a dynamic URI in
-to()] for more information.
+`to()`] for more information.
- Use header with the stylesheet.
When using a header for dynamic stylesheet, then you can either refer to the
stylesheet as a `file` or `classpath`
@@ -223,7 +224,7 @@ TIP: You can set `contentCache=false` and refer to a
non-existing template, such
as this will tell Camel to not load `dummy.xsl` on startup but to load the
stylesheet on demand. And because you
provide the stylesheet via headers, then it is fully dynamic.
-== Accessing warnings, errors and fatalErrors from XSLT ErrorListener
+=== Accessing warnings, errors and fatalErrors from XSLT ErrorListener
Any warning/error or fatalError is stored on
the current Exchange as a property with the
@@ -233,7 +234,7 @@ errors happening during transformation.
For example, in the stylesheet below, we want to determinate whether a staff
has
an empty dob field. And to include a custom error message using
-xsl:message.
+`xsl:message`.
[source,xml]
----
diff --git a/components/camel-xslt/src/main/docs/xslt-component.adoc
b/components/camel-xslt/src/main/docs/xslt-component.adoc
index d1f2bb0f5ad..3dd67ee5295 100644
--- a/components/camel-xslt/src/main/docs/xslt-component.adoc
+++ b/components/camel-xslt/src/main/docs/xslt-component.adoc
@@ -143,7 +143,7 @@ the prefix, then Camel uses the prefix from the endpoint
configuration.
If no prefix is specified in the endpoint configuration, the default is
`classpath:`.
You can also refer backwards in the included paths.
-In the following example, the xsl file will be resolved under
`org/apache/camel/component`.
+In the following example, the XSL file will be resolved under
`org/apache/camel/component`.
[source,xml]
----
@@ -151,7 +151,7 @@ In the following example, the xsl file will be resolved
under `org/apache/camel/
----
-== Using xsl:include and default prefix
+== Using `xsl:include` and default prefix
Camel will use the prefix from the endpoint configuration as the default
prefix.
diff --git a/components/camel-zeebe/src/main/docs/zeebe-component.adoc
b/components/camel-zeebe/src/main/docs/zeebe-component.adoc
index 4fe9d1a836f..19cadd0a72b 100644
--- a/components/camel-zeebe/src/main/docs/zeebe-component.adoc
+++ b/components/camel-zeebe/src/main/docs/zeebe-component.adoc
@@ -48,27 +48,29 @@ include::partial$component-endpoint-options.adoc[]
// endpoint options: END
-== Producer Endpoints:
+== Usage
+
+=== Producer Endpoints
[width="100%",cols="10%,90%",options="header",]
|=======================================================================
|Endpoint |Description
-|startProcess |Creates and starts an instance of the specified process.
+|`startProcess` |Creates and starts an instance of the specified process.
-|cancelProcess |Cancels a running process instance.
+|`cancelProcess` |Cancels a running process instance.
-|publishMessage |Publishes a message.
+|`publishMessage` |Publishes a message.
-|completeJob |Completes a job for a service task.
+|`completeJob` |Completes a job for a service task.
-|failJob |Fails a job.
+|`failJob` |Fails a job.
-|updateJobRetries |Updates the number of retries for a job.
+|`updateJobRetries` |Updates the number of retries for a job.
-|throwError |Throw an error to indicate that a business error has occurred.
+|`throwError` |Throw an error to indicate that a business error has occurred.
-|deployResource |Deploy a process resource. Currently only supports process
definitions.
+|`deployResource` |Deploy a process resource. Currently only supports process
definitions.
|=======================================================================
@@ -291,7 +293,7 @@ The endpoints accept either Java request objects as shown
in the examples below
});
----------------------------------------------------------------------------------------------------------------------
-== Consumer Endpoints:
+=== Consumer Endpoints:
[width="100%",cols="10%,90%",options="header",]
|=======================================================================
diff --git
a/components/camel-zip-deflater/src/main/docs/zipDeflater-dataformat.adoc
b/components/camel-zip-deflater/src/main/docs/zipDeflater-dataformat.adoc
index 0057c9f40c9..5115b82fa03 100644
--- a/components/camel-zip-deflater/src/main/docs/zipDeflater-dataformat.adoc
+++ b/components/camel-zip-deflater/src/main/docs/zipDeflater-dataformat.adoc
@@ -56,7 +56,7 @@
from("direct:start").marshal().zipDeflater().to("activemq:queue:MY_QUEUE");
In this example, we unmarshal a zipped payload from an ActiveMQ queue
called MY_QUEUE to its original format, and forward it for processing to
the UnZippedMessageProcessor. Note that the compression Level employed
-during the marshaling should be identical to the one employed during
+during marshaling should be identical to the one employed during
unmarshalling to avoid errors.
[source,java]
diff --git
a/components/camel-zookeeper-master/src/main/docs/zookeeper-master-component.adoc
b/components/camel-zookeeper-master/src/main/docs/zookeeper-master-component.adoc
index 2002262ec0a..aefce0fff99 100644
---
a/components/camel-zookeeper-master/src/main/docs/zookeeper-master-component.adoc
+++
b/components/camel-zookeeper-master/src/main/docs/zookeeper-master-component.adoc
@@ -59,7 +59,7 @@ include::partial$component-endpoint-options.adoc[]
-== Example
+== Examples
You can protect a clustered Camel application to only consume files from one
active node.
@@ -93,7 +93,7 @@ However, you can also configure the url of the ZooKeeper
ensemble using environm
export ZOOKEEPER_URL = "myzookeeper:2181"
----
-== Master RoutePolicy
+=== Master RoutePolicy
You can also use a `RoutePolicy` to control routes in master/slave mode.
diff --git a/components/camel-zookeeper/src/main/docs/zookeeper-component.adoc
b/components/camel-zookeeper/src/main/docs/zookeeper-component.adoc
index a62196611d8..05e02563a9b 100644
--- a/components/camel-zookeeper/src/main/docs/zookeeper-component.adoc
+++ b/components/camel-zookeeper/src/main/docs/zookeeper-component.adoc
@@ -65,7 +65,7 @@ include::partial$component-endpoint-options.adoc[]
include::partial$component-endpoint-headers.adoc[]
// component headers: END
-== Use cases
+== Usage
=== Reading from a _znode_
@@ -156,7 +156,7 @@ or equivalently:
</route>
----
-ZooKeeper nodes can have different types; they can be 'Ephemeral' or
+ZooKeeper's nodes can have different types; they can be 'Ephemeral' or
'Persistent' and 'Sequenced' or 'Unsequenced'. For further information
of each type, you can check
http://zookeeper.apache.org/doc/trunk/zookeeperProgrammers.html#Ephemeral+Nodes[here].
