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 a5b8a8c5caf410239bd0e96cbf4a0e1c0afcd4c5
Author: Otavio Rodolfo Piske <angusyo...@gmail.com>
AuthorDate: Fri Jan 6 11:16:59 2023 +0100
(chores) documentation: more cleanups to the component guides
---
.../modules/working-with-camel-core/pages/index.adoc | 3 +--
docs/user-manual/modules/ROOT/pages/component.adoc | 17 +++++++++++++----
2 files changed, 14 insertions(+), 6 deletions(-)
diff --git a/docs/main/modules/working-with-camel-core/pages/index.adoc
b/docs/main/modules/working-with-camel-core/pages/index.adoc
index 864fef197a6..961f7d0e1dd 100644
--- a/docs/main/modules/working-with-camel-core/pages/index.adoc
+++ b/docs/main/modules/working-with-camel-core/pages/index.adoc
@@ -42,8 +42,7 @@ If you have basic knowledge about _routes_, you can use the
following guides to
Components are a fundamental building block of Apache Camel and are used to
connect routes to a wide variety of external systems and services.
-* Components
-** xref:manual::component.adoc[Component]: the comprehensive guide about
components.
+* xref:manual::component.adoc[Component]: the comprehensive guide about
components.
== Other Guides
diff --git a/docs/user-manual/modules/ROOT/pages/component.adoc
b/docs/user-manual/modules/ROOT/pages/component.adoc
index 36fa599e49c..8df1da5c963 100644
--- a/docs/user-manual/modules/ROOT/pages/component.adoc
+++ b/docs/user-manual/modules/ROOT/pages/component.adoc
@@ -1,5 +1,6 @@
= Components
+// suppress inspection "GrazieInspection"
Components are a fundamental building block of Apache Camel and are used to
connect routes to a wide variety of external systems and services. Camel comes
with a large number of built-in components that provide connectivity to a wide
range of technologies and protocols, such as HTTP, JMS, file, and many others.
You can also create a custom components if the built-in components do not meet
your needs.
== Components: the basics
@@ -16,8 +17,10 @@ For the URI given in the above example, the `CamelContext`
object would map the
The parameter to `getEndpoint()` is a URI. The URI _scheme_ (that is,
the part before `:`) specifies the name of a component. Internally, the
`CamelContext` object maintains a mapping from the names of components to
`Component` objects.
-*Note*: our documentation contains an in-depth overview of the
xref:manual::component.adoc[Component] if you want to learn more about it,
including important details necessary to write your own.
-
+[NOTE]
+====
+Our documentation contains an in-depth overview of the
xref:manual::component.adoc[Component] if you want to learn more about it,
including important details necessary to write your own.
+====
== Configuring Component Options
@@ -53,7 +56,10 @@ In other words, with placeholders you can externalize the
configuration from you
In the getting started guide, we explained that Camel maintains a map of names
to components. This raises the question of how Camel populates this map with
named `Component` objects.
-*Note*: normally application developers don't need to worry about this.
However, this information is fundamental if you are writing a custom component.
+[NOTE]
+====
+Normally, application developers don't need to worry about this. However, this
information is fundamental if you are writing a custom component.
+====
There are two ways of populating the map.
@@ -100,7 +106,10 @@
myCamelContext.getEndpoint("pop3://john.sm...@mailserv.example.com?password=myPa
We originally referred to the parameter as a URI because the online Camel
documentation and the Camel source code both claim the parameter is a URI. In
reality, the parameter is restricted to being a URL. This is because when Camel
extracts the component name from the parameter, it looks for the first ":",
which is a simplistic algorithm.
-*Note*: to understand, why recall from the Getting Started that a URI can be a
URL or a URN.
+[NOTE]
+====
+Remember that in the xref:camel-core:getting-started:index.adoc[Getting
Started With Camel] we explained that a URI could be a URL or a URN.
+====
Now consider the following calls to `getEndpoint`:
