diff options
author | Sofia Balicka <sofia.balicka@gmail.com> | 2013-07-25 20:37:23 (GMT) |
---|---|---|
committer | Sofia Balicka <sofia.balicka@gmail.com> | 2013-07-25 20:37:23 (GMT) |
commit | 391bb835f6289c55d958f0e5543a7ccaf164f122 (patch) | |
tree | 151930c8a98c0f9b7a1329db6ec29910cd3efcd2 | |
parent | ed9e4a166d0caa5ac8a90e0ebcc455b123942ead (diff) | |
download | kolab-docs-libraries.tar.gz |
started with structre for libcalendaring and libkolablibraries
6 files changed, 75 insertions, 2 deletions
diff --git a/Development_Manual/en-US/libcalendaring-Where_to_get_it.xml b/Development_Manual/en-US/libcalendaring-Where_to_get_it.xml new file mode 100644 index 0000000..6be1689 --- /dev/null +++ b/Development_Manual/en-US/libcalendaring-Where_to_get_it.xml @@ -0,0 +1,11 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "Development_Manual.ent"> +%BOOK_ENTITIES; +]> +<chapter id="chap-Development_Manual-libcalendaring-Where_to_get_it"> + <title>Where to get it</title> + <para> + The libcalendaring library can be found under git.kolab.org/git/libcalendaring + </para> +</chapter> diff --git a/Development_Manual/en-US/libkolab-How_to_build_it.xml b/Development_Manual/en-US/libkolab-How_to_build_it.xml new file mode 100644 index 0000000..5833511 --- /dev/null +++ b/Development_Manual/en-US/libkolab-How_to_build_it.xml @@ -0,0 +1,16 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "Development_Manual.ent"> +%BOOK_ENTITIES; +]> +<chapter id="chap-Development_Manual-libkolab_How_to_build_it"> + <title>How to build libkolab</title> + <para>In order to build libkolab use the autogen.sh script</para> + <para>The options are:</para> + <itemizedlist> + <listitem><para>--build </para> <para> Builds the librarie</para></listitem> + <listitem><para>--prep </para> <para> Prepare for the build by setting the CMake options</para></listitem> + <listitem><para>--test </para> <para> Executes tests</para></listitem> + <listitem><para>--install </para> <para> Installs the library</para></listitem> + </itemizedlist> +</chapter> diff --git a/Development_Manual/en-US/libkolab-Overview.xml b/Development_Manual/en-US/libkolab-Overview.xml new file mode 100644 index 0000000..9f311e9 --- /dev/null +++ b/Development_Manual/en-US/libkolab-Overview.xml @@ -0,0 +1,35 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "Development_Manual.ent"> +%BOOK_ENTITIES; +]> +<chapter id="chap-Development_Manual-libkolab_Overview"> + <title>Overview</title> + <para> + Libkolab provides advanced calendaring functionality including: + </para> + <itemizedlist> + <listitem><para>recurrence handling</para></listitem> + <listitem><para>timezone handling</para></listitem> + <listitem><para>iTip/iMip parsing/generating</para></listitem> + <listitem><para>Freebusy generating</para></listitem> + </itemizedlist> + <para> + To implement most of the functionality, the kdepim libraries are used. The functionality of this library can be exposed via SWIG bindings to other languages. + </para> + + <section id="sect-Development_Manual-libkolab-Structure"> + <title>Structure</title> + <itemizedlist> + <listitem><para>kolabformatv2: Kolabformat v2 implementation from kdepim-runtime (moved here)</para></listitem> + <listitem><para>kolabformat: Kolab object reading/writing (mime message + kolab-format). Handles v2/v3 transparently.</para></listitem> + <listitem><para>Currently this interface uses the KDE Containers, eventually we'd want one that uses the Kolab Containers and can be wrapped in SWIG bindings.</para></listitem> + <listitem><para>conversion: Conversions from KDE to Kolab containers and vice verca.</para></listitem> + <listitem><para>mime: Mime message handling used by kolabformat</para></listitem> + <listitem><para>icalendar: Exposes iCalendar functionality: iCal reading/writing, iTip, iMip</para></listitem> + <listitem><para>calendaring: Some general calendaring functions</para></listitem> + <listitem><para>freebusy: Freebusy generating functions.</para></listitem> + </itemizedlist> + </section> +</chapter> + diff --git a/Development_Manual/en-US/libkolab-Where_to_get_it.xml b/Development_Manual/en-US/libkolab-Where_to_get_it.xml new file mode 100644 index 0000000..dfdefd7 --- /dev/null +++ b/Development_Manual/en-US/libkolab-Where_to_get_it.xml @@ -0,0 +1,11 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "Development_Manual.ent"> +%BOOK_ENTITIES; +]> +<chapter id="chap-Development_Manual-libkolab-Where_to_get_it"> + <title>Where to get it</title> + <para> + The libkola library can be found under git.kolab.org/git/libkolab + </para> +</chapter> diff --git a/Development_Manual/en-US/libkolabxml-CMake_options.xml b/Development_Manual/en-US/libkolabxml-CMake_options.xml index dbec1d9..9c08b93 100644 --- a/Development_Manual/en-US/libkolabxml-CMake_options.xml +++ b/Development_Manual/en-US/libkolabxml-CMake_options.xml @@ -41,7 +41,7 @@ <listitem><para>JAVA_INSTALL_DIR_DIR</para></listitem> <listitem><para>CSHARP_INSTALL_DIR _DIR</para></listitem> </itemizedlist> - <section id="sect-Development_Manual-libkolab-CMake_options_example"> + <section id="sect-Development_Manual-libkolabxml-CMake_options_example"> <title>CMake Options Example</title> <para> Find libraries in lib64, install to /usr/lib64, build python and phpbindings: diff --git a/Development_Manual/en-US/libkolabxml-Where_to_get_it.xml b/Development_Manual/en-US/libkolabxml-Where_to_get_it.xml index 07cb12d..edfcf16 100644 --- a/Development_Manual/en-US/libkolabxml-Where_to_get_it.xml +++ b/Development_Manual/en-US/libkolabxml-Where_to_get_it.xml @@ -3,7 +3,7 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Development_Manual.ent"> %BOOK_ENTITIES; ]> -<chapter id="chap-Development_Manual-libkolab-Where_to_get_it"> +<chapter id="chap-Development_Manual-libkolabxml-Where_to_get_it"> <title>Where to get it</title> <para> The libkolabxml library can be found under git.kolab.org/git/libkolabxml |