camel-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From acosent...@apache.org
Subject [2/2] camel git commit: Added camel-ical dataformat docs to gitbook
Date Tue, 19 Apr 2016 11:23:26 GMT
Added camel-ical dataformat 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/5663d45d
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/5663d45d
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/5663d45d

Branch: refs/heads/master
Commit: 5663d45da34e3f50877338bc3a34376bdf411be2
Parents: 1a5dc84
Author: Andrea Cosentino <ancosen@gmail.com>
Authored: Tue Apr 19 13:22:49 2016 +0200
Committer: Andrea Cosentino <ancosen@gmail.com>
Committed: Tue Apr 19 13:22:49 2016 +0200

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


http://git-wip-us.apache.org/repos/asf/camel/blob/5663d45d/components/camel-ical/src/main/docs/ical.adoc
----------------------------------------------------------------------
diff --git a/components/camel-ical/src/main/docs/ical.adoc b/components/camel-ical/src/main/docs/ical.adoc
new file mode 100644
index 0000000..121a18c
--- /dev/null
+++ b/components/camel-ical/src/main/docs/ical.adoc
@@ -0,0 +1,68 @@
+[[ICal-ICalDataFormat]]
+ICal DataFormat
+~~~~~~~~~~~~~~~
+
+*Available as of Camel 2.11.1*
+
+The *ICal* dataformat is used for working with
+http://en.wikipedia.org/wiki/ICalendar[iCalendar] messages.
+
+A typical iCalendar message looks like:
+
+[source,java]
+----------------------------------------------------------------------
+BEGIN:VCALENDAR
+VERSION:2.0
+PRODID:-//Events Calendar//iCal4j 1.0//EN
+CALSCALE:GREGORIAN
+BEGIN:VEVENT
+DTSTAMP:20130324T180000Z
+DTSTART:20130401T170000
+DTEND:20130401T210000
+SUMMARY:Progress Meeting
+TZID:America/New_York
+UID:00000000
+ATTENDEE;ROLE=REQ-PARTICIPANT;CN=Developer 1:mailto:dev1@mycompany.com
+ATTENDEE;ROLE=OPT-PARTICIPANT;CN=Developer 2:mailto:dev2@mycompany.com
+END:VEVENT
+END:VCALENDAR
+----------------------------------------------------------------------
+
+[[ICal-BasicUsage]]
+Basic Usage
+^^^^^^^^^^^
+
+To unmarshal and marshal the message shown above, your route will look
+like the following:
+
+[source,java]
+-----------------------------
+from("direct:ical-unmarshal")
+  .unmarshal("ical")
+  .to("mock:unmarshaled")
+  .marshal("ical")
+  .to("mock:marshaled");
+-----------------------------
+
+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-ical</artifactId>
+    <version>x.x.x</version>
+    <!-- use the same version as your Camel core version -->
+</dependency>
+------------------------------------------------------------
+
+[[ICal-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/5663d45d/docs/user-manual/en/SUMMARY.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md
index 25c2d95..8ac0293 100644
--- a/docs/user-manual/en/SUMMARY.md
+++ b/docs/user-manual/en/SUMMARY.md
@@ -183,6 +183,7 @@
 * Data Formats
     * [Flatpack](flatpack-dataformat.adoc)
     * [XML JSON](xmljson.adoc)
+    * [Ical](ical.adoc)
 
 * User Guide
     * [Karaf](karaf.adoc)


Mime
View raw message