summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSofia Balicka <sofia.balicka@gmail.com>2013-07-25 13:42:08 (GMT)
committerSofia Balicka <sofia.balicka@gmail.com>2013-07-25 13:42:08 (GMT)
commited9e4a166d0caa5ac8a90e0ebcc455b123942ead (patch)
tree6b1c2be4c75edea16f5444966f02c58bb3dad633
parent3c4a6b40336fb0d79d91264d7324bef4a088428d (diff)
downloadkolab-docs-ed9e4a166d0caa5ac8a90e0ebcc455b123942ead.tar.gz
libkolabxml documentation
-rw-r--r--Development_Manual/en-US/libkolabxml-CMake_options.xml51
-rw-r--r--Development_Manual/en-US/libkolabxml-How_to_build_it.xml18
-rw-r--r--Development_Manual/en-US/libkolabxml-Overview.xml12
-rw-r--r--Development_Manual/en-US/libkolabxml-Requirements.xml30
-rw-r--r--Development_Manual/en-US/libkolabxml-Where_to_get_it.xml11
5 files changed, 122 insertions, 0 deletions
diff --git a/Development_Manual/en-US/libkolabxml-CMake_options.xml b/Development_Manual/en-US/libkolabxml-CMake_options.xml
new file mode 100644
index 0000000..dbec1d9
--- /dev/null
+++ b/Development_Manual/en-US/libkolabxml-CMake_options.xml
@@ -0,0 +1,51 @@
+<?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-CMake_options">
+ <title>CMake options</title>
+ <para>
+ Options can either be supplied on the commandline or edited in the cmake cache.
+ </para>
+ <para>
+ Library installation path:
+ </para>
+ <programlisting>>LIB_INSTALL_DIR=/usr/lib</programlisting>
+
+ <para>
+ Set the installation prefix:
+ </para>
+ <programlisting>CMAKE_INSTALL_PREFIX=/usr</programlisting>
+
+ <para>
+ Installation location for header files:
+ </para>
+ <programlisting>INCLUDE_INSTALL_DIR=/usr/include</programlisting>
+ <para>
+ Building of bindings can be controlled using cmake configuration options:
+ </para>
+ <itemizedlist>
+ <listitem><para>PYTHON_BINDINGS</para></listitem>
+ <listitem><para>PHP_BINDINGS</para></listitem>
+ <listitem><para>JAVA_BINDINGS</para></listitem>
+ <listitem><para>CSHARP_BINDINGS</para></listitem>
+ </itemizedlist>
+
+ <para>
+ The path to install the bindings:
+ </para>
+ <itemizedlist>
+ <listitem><para>PYTHON_INSTALL_DIR</para></listitem>
+ <listitem><para>PHP_INSTALL_DIR</para></listitem>
+ <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">
+ <title>CMake Options Example</title>
+ <para>
+ Find libraries in lib64, install to /usr/lib64, build python and phpbindings:
+ </para>
+ <programlisting>$cmake -DCMAKE_INSTALL_PREFIX=/usr -DLIB_INSTALL_DIR=/usr/lib64 -DPYTHON_BINDINGS=TRUE -DPYTHON_INSTALL_DIR=/usr/lib64/python$x.$y/site-packages/ -DPHP_BINDINGS=TRUE ..</programlisting>
+ </section>
+</chapter>
diff --git a/Development_Manual/en-US/libkolabxml-How_to_build_it.xml b/Development_Manual/en-US/libkolabxml-How_to_build_it.xml
new file mode 100644
index 0000000..525f626
--- /dev/null
+++ b/Development_Manual/en-US/libkolabxml-How_to_build_it.xml
@@ -0,0 +1,18 @@
+<?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 it</title>
+ <para>
+ libkolabxml can be build with the following commands:
+ </para>
+ <screen>$
+ <userinput>mkdir build</userinput>
+ <userinput>cd build</userinput>
+ <userinput>cmake ..</userinput>
+ <userinput>make</userinput>
+ </screen>
+</chapter>
+
diff --git a/Development_Manual/en-US/libkolabxml-Overview.xml b/Development_Manual/en-US/libkolabxml-Overview.xml
new file mode 100644
index 0000000..964d73e
--- /dev/null
+++ b/Development_Manual/en-US/libkolabxml-Overview.xml
@@ -0,0 +1,12 @@
+<?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-libkolabxml-Overview">
+ <title>Overview</title>
+ <para>
+ Libkolabxml is the reference implementation of the Kolab XML Format as defined in http://wiki.kolab.org/User:Mollekopf/Drafts/KEP:17.
+ It provides serialization/deserialization from/to in-memory representations for all Kolab Objects, including input validation.
+ </para>
+</chapter>
diff --git a/Development_Manual/en-US/libkolabxml-Requirements.xml b/Development_Manual/en-US/libkolabxml-Requirements.xml
new file mode 100644
index 0000000..fce1d73
--- /dev/null
+++ b/Development_Manual/en-US/libkolabxml-Requirements.xml
@@ -0,0 +1,30 @@
+<?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-libkolabxml-Requirements">
+ <title>Requirements</title>
+ <para>
+ Minimum requirements are:
+ </para>
+ <itemizedlist>
+ <listitem><para>cmake 2.6</para></listitem>
+ <listitem><para>boost >= 1.41</para></listitem>
+ <listitem><para>xerces-c >= 3.0</para></listitem>
+ <listitem><para>cxx >= 3.0 (http://www.codesynthesis.com/products/xsd/)</para></listitem>
+ <listitem><para>libcurl</para></listitem>
+ </itemizedlist>
+ <para>
+ For further features:
+ </para>
+ <itemizedlist>
+ <listitem><para>-SWIG >= 2.0</para></listitem>
+ </itemizedlist>
+ <para>
+ For building test (controlled by -DBUILD_TESTS=TRUE):
+ </para>
+ <itemizedlist>
+ <listitem><para>-Qt >= 4.7</para></listitem>
+ </itemizedlist>
+</chapter>
diff --git a/Development_Manual/en-US/libkolabxml-Where_to_get_it.xml b/Development_Manual/en-US/libkolabxml-Where_to_get_it.xml
new file mode 100644
index 0000000..07cb12d
--- /dev/null
+++ b/Development_Manual/en-US/libkolabxml-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 libkolabxml library can be found under git.kolab.org/git/libkolabxml
+ </para>
+</chapter>