summaryrefslogtreecommitdiff
path: root/Administrator_Guide
diff options
context:
space:
mode:
authorJeroen van Meeuwen (Ergo Project) <jeroen.van.meeuwen@ergo-project.org>2011-01-05 23:42:56 (GMT)
committerJeroen van Meeuwen (Ergo Project) <jeroen.van.meeuwen@ergo-project.org>2011-01-05 23:42:56 (GMT)
commit4d849a6e64d30d8d1f29b8d82f87f692d617069b (patch)
treea827a49c142cd188f3677586d7f10941b24f9874 /Administrator_Guide
parent090f09897fa635c5b844fc7046fb1eaa6e181adb (diff)
downloadkolab-docs-4d849a6e64d30d8d1f29b8d82f87f692d617069b.tar.gz
Updates to the documentation
Diffstat (limited to 'Administrator_Guide')
-rw-r--r--Administrator_Guide/Makefile17
-rw-r--r--Administrator_Guide/en-US/Administrator_Guide.ent4
-rw-r--r--Administrator_Guide/en-US/Administrator_Guide.xml13
-rw-r--r--Administrator_Guide/en-US/Author_Group.xml19
-rw-r--r--Administrator_Guide/en-US/Book_Info.xml31
-rw-r--r--Administrator_Guide/en-US/Chapter.xml39
-rw-r--r--Administrator_Guide/en-US/Preface.xml12
-rw-r--r--Administrator_Guide/en-US/Revision_History.xml33
-rw-r--r--Administrator_Guide/en-US/chap-About_Kolab_Groupware.xml30
-rw-r--r--Administrator_Guide/en-US/images/icon.svg19
-rw-r--r--Administrator_Guide/publican.cfg7
11 files changed, 224 insertions, 0 deletions
diff --git a/Administrator_Guide/Makefile b/Administrator_Guide/Makefile
new file mode 100644
index 0000000..eeffdbb
--- /dev/null
+++ b/Administrator_Guide/Makefile
@@ -0,0 +1,17 @@
+PACKAGE = "Administrator_Guide"
+
+all: clean clean_ids
+ @publican build --langs=en-US --formats=html,html-single,pdf
+ @rsync -aHvz tmp/en-US/{html,html-single,pdf} hosted.kolabsys.com:./public_html/kolab-2.3-docs/$(PACKAGE)/
+
+clean:
+ @publican clean
+
+clean_ids:
+ @cp -a ../Common_Content/en-US/*.xml en-US/.
+ @publican clean_ids
+ @sed -i -r \
+ -e 's/\t/ /g' \
+ -e 's/((\s{4})+)\s*/\1/g' \
+ -e 's/\s*$$//g' \
+ `find en-US/ -type f -name "*.xml"`
diff --git a/Administrator_Guide/en-US/Administrator_Guide.ent b/Administrator_Guide/en-US/Administrator_Guide.ent
new file mode 100644
index 0000000..13bc64e
--- /dev/null
+++ b/Administrator_Guide/en-US/Administrator_Guide.ent
@@ -0,0 +1,4 @@
+<!ENTITY PRODUCT "Kolab">
+<!ENTITY BOOKID "Administrator_Guide">
+<!ENTITY YEAR "2010">
+<!ENTITY HOLDER "| You need to change the HOLDER entity in the en-US/Administrator_Guide.ent file |">
diff --git a/Administrator_Guide/en-US/Administrator_Guide.xml b/Administrator_Guide/en-US/Administrator_Guide.xml
new file mode 100644
index 0000000..2056103
--- /dev/null
+++ b/Administrator_Guide/en-US/Administrator_Guide.xml
@@ -0,0 +1,13 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Administrator_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<book>
+ <xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Chapter.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <index />
+</book>
+
diff --git a/Administrator_Guide/en-US/Author_Group.xml b/Administrator_Guide/en-US/Author_Group.xml
new file mode 100644
index 0000000..41e245a
--- /dev/null
+++ b/Administrator_Guide/en-US/Author_Group.xml
@@ -0,0 +1,19 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE authorgroup PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Administrator_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<authorgroup>
+ <author>
+ <firstname>Jeroen</firstname>
+ <surname>van Meeuwen</surname>
+ <lineage>RHCE</lineage> <affiliation>
+ <orgname>Kolab Systems</orgname>
+ <orgdiv>Engineering</orgdiv>
+
+ </affiliation>
+ <email>vanmeeuwen@kolabsys.com</email>
+
+ </author>
+</authorgroup>
+
diff --git a/Administrator_Guide/en-US/Book_Info.xml b/Administrator_Guide/en-US/Book_Info.xml
new file mode 100644
index 0000000..8caca5b
--- /dev/null
+++ b/Administrator_Guide/en-US/Book_Info.xml
@@ -0,0 +1,31 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Administrator_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<bookinfo id="book-Administrator_Guide-Administrator_Guide">
+ <title>Administrator Guide</title>
+ <subtitle>short description</subtitle>
+ <productname>Kolab</productname>
+ <productnumber>2.3</productnumber>
+ <edition>0</edition>
+ <pubsnumber>0</pubsnumber>
+ <abstract>
+ <para>
+ A short overview and summary of the book's subject and purpose, traditionally no more than one paragraph long. Note: the abstract will appear in the front matter of your book and will also be placed in the description field of the book's RPM spec file.
+ </para>
+
+ </abstract>
+ <corpauthor>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="Common_Content/images/title_logo.svg" format="SVG" />
+ </imageobject>
+
+ </inlinemediaobject>
+
+ </corpauthor>
+ <xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+</bookinfo>
+
diff --git a/Administrator_Guide/en-US/Chapter.xml b/Administrator_Guide/en-US/Chapter.xml
new file mode 100644
index 0000000..f9ce360
--- /dev/null
+++ b/Administrator_Guide/en-US/Chapter.xml
@@ -0,0 +1,39 @@
+<?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 "Administrator_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<chapter id="chap-Administrator_Guide-Test_Chapter">
+ <title>Test Chapter</title>
+ <para>
+ This is a test paragraph
+ </para>
+ <section id="sect-Administrator_Guide-Test_Chapter-Test_Section_1">
+ <title>Test Section 1</title>
+ <para>
+ This is a test paragraph in a section
+ </para>
+
+ </section>
+
+ <section id="sect-Administrator_Guide-Test_Chapter-Test_Section_2">
+ <title>Test Section 2</title>
+ <para>
+ This is a test paragraph in Section 2
+ <orderedlist>
+ <listitem>
+ <para>
+ listitem text
+ </para>
+
+ </listitem>
+
+ </orderedlist>
+
+ </para>
+
+ </section>
+
+
+</chapter>
+
diff --git a/Administrator_Guide/en-US/Preface.xml b/Administrator_Guide/en-US/Preface.xml
new file mode 100644
index 0000000..c9e647e
--- /dev/null
+++ b/Administrator_Guide/en-US/Preface.xml
@@ -0,0 +1,12 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE preface PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Administrator_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<preface id="pref-Administrator_Guide-Preface">
+ <title>Preface</title>
+ <xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="sect-Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="sect-About_Kolab_Groupware.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+</preface>
+
diff --git a/Administrator_Guide/en-US/Revision_History.xml b/Administrator_Guide/en-US/Revision_History.xml
new file mode 100644
index 0000000..a75c98d
--- /dev/null
+++ b/Administrator_Guide/en-US/Revision_History.xml
@@ -0,0 +1,33 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Administrator_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<appendix id="appe-Administrator_Guide-Revision_History">
+ <title>Revision History</title>
+ <simpara>
+ <revhistory>
+ <revision>
+ <revnumber>0-0</revnumber>
+ <date>Mon Dec 13 2010</date>
+ <author>
+ <firstname>Dude</firstname>
+ <surname>McPants</surname>
+ <email>Dude.McPants@example.com</email>
+
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>Initial creation of book by publican</member>
+
+ </simplelist>
+
+ </revdescription>
+
+ </revision>
+
+ </revhistory>
+
+ </simpara>
+</appendix>
+
diff --git a/Administrator_Guide/en-US/chap-About_Kolab_Groupware.xml b/Administrator_Guide/en-US/chap-About_Kolab_Groupware.xml
new file mode 100644
index 0000000..39c850a
--- /dev/null
+++ b/Administrator_Guide/en-US/chap-About_Kolab_Groupware.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 "Administrator_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<chapter id="chap-Administrator_Guide-About_Kolab_Groupware">
+ <title>About Kolab Groupware</title>
+ <para>
+ Kolab is a Groupware Solution for Emails, Appointments, Contacts and more. It supports mixed client environments (Outlook/KDE) because of an open storage format. Any email client speaking standard protocols can be served.
+ </para>
+ <section id="sect-Administrator_Guide-About_Kolab_Groupware-Free_Software_Components">
+ <title>Free Software Components</title>
+ <para>
+ TODO: Come on, be a little more verbose...
+ </para>
+ <section id="sect-Administrator_Guide-Free_Software_Components-This_documentation">
+ <title>This documentation</title>
+ <para>
+ Describe how this documentation can be modified to custom, internal documentation
+ </para>
+
+ </section>
+
+
+ </section>
+
+ <xi:include href="sect-Supported_Platforms_and_System_Requirements.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+</chapter>
+
diff --git a/Administrator_Guide/en-US/images/icon.svg b/Administrator_Guide/en-US/images/icon.svg
new file mode 100644
index 0000000..b2f16d0
--- /dev/null
+++ b/Administrator_Guide/en-US/images/icon.svg
@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg xmlns:svg="http://www.w3.org/2000/svg" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.0" width="32" height="32" id="svg3017">
+ <defs id="defs3019">
+ <linearGradient id="linearGradient2381">
+ <stop id="stop2383" style="stop-color:#ffffff;stop-opacity:1" offset="0"/>
+ <stop id="stop2385" style="stop-color:#ffffff;stop-opacity:0" offset="1"/>
+ </linearGradient>
+ <linearGradient x1="296.4996" y1="188.81061" x2="317.32471" y2="209.69398" id="linearGradient2371" xlink:href="#linearGradient2381" gradientUnits="userSpaceOnUse" gradientTransform="matrix(0.90776,0,0,0.90776,24.35648,49.24131)"/>
+ </defs>
+ <g transform="matrix(0.437808,-0.437808,0.437808,0.437808,-220.8237,43.55311)" id="g5089">
+ <path d="m 8.4382985,-6.28125 c -0.6073916,0 -4.3132985,5.94886271 -4.3132985,8.25 l 0,26.71875 c 0,0.846384 0.5818159,1.125 1.15625,1.125 l 25.5625,0 c 0.632342,0 1.125001,-0.492658 1.125,-1.125 l 0,-5.21875 0.28125,0 c 0.49684,0 0.906249,-0.409411 0.90625,-0.90625 l 0,-27.9375 c 0,-0.4968398 -0.40941,-0.90625 -0.90625,-0.90625 l -23.8117015,0 z" transform="translate(282.8327,227.1903)" id="path5091" style="fill:#5c5c4f;stroke:#000000;stroke-width:3.23021388;stroke-miterlimit:4;stroke-dasharray:none"/>
+ <rect width="27.85074" height="29.369793" rx="1.1414107" ry="1.1414107" x="286.96509" y="227.63805" id="rect5093" style="fill:#032c87"/>
+ <path d="m 288.43262,225.43675 25.2418,0 0,29.3698 -26.37615,0.0241 1.13435,-29.39394 z" id="rect5095" style="fill:#ffffff"/>
+ <path d="m 302.44536,251.73726 c 1.38691,7.85917 -0.69311,11.28365 -0.69311,11.28365 2.24384,-1.60762 3.96426,-3.47694 4.90522,-5.736 0.96708,2.19264 1.83294,4.42866 4.27443,5.98941 0,0 -1.59504,-7.2004 -1.71143,-11.53706 l -6.77511,0 z" id="path5097" style="fill:#a70000;fill-opacity:1;stroke-width:2"/>
+ <rect width="25.241802" height="29.736675" rx="0.89682275" ry="0.89682275" x="290.73544" y="220.92249" id="rect5099" style="fill:#809cc9"/>
+ <path d="m 576.47347,725.93939 6.37084,0.41502 0.4069,29.51809 c -1.89202,-1.31785 -6.85427,-3.7608 -8.26232,-1.68101 l 0,-26.76752 c 0,-0.82246 0.66212,-1.48458 1.48458,-1.48458 z" transform="matrix(0.499065,-0.866565,0,1,0,0)" id="rect5101" style="fill:#4573b3;fill-opacity:1"/>
+ <path d="m 293.2599,221.89363 20.73918,0 c 0.45101,0 0.8141,0.3631 0.8141,0.81411 0.21547,6.32836 -19.36824,21.7635 -22.36739,17.59717 l 0,-17.59717 c 0,-0.45101 0.3631,-0.81411 0.81411,-0.81411 z" id="path5103" style="opacity:0.65536726;fill:url(#linearGradient2371);fill-opacity:1"/>
+ </g>
+</svg>
diff --git a/Administrator_Guide/publican.cfg b/Administrator_Guide/publican.cfg
new file mode 100644
index 0000000..f1ce5b6
--- /dev/null
+++ b/Administrator_Guide/publican.cfg
@@ -0,0 +1,7 @@
+# Config::Simple 4.59
+# Mon Dec 13 13:37:59 2010
+
+xml_lang: en-US
+type: Book
+brand: common
+