Introduce reference doc

git-svn-id: https://svn.argeo.org/commons/trunk@4742 4cfe0d0a-d680-48aa-b62c-e0a02a3f76cc

diff --git a/doc/pom.xml b/doc/pom.xml
new file mode 100644 (file)
index 0000000..82d7f29
--- /dev/null
+++ b/doc/pom.xml
@@ -0,0 +1,50 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+       xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+       <modelVersion>4.0.0</modelVersion>
+       <parent>
+               <groupId>org.argeo.commons</groupId>
+               <version>0.3.4-SNAPSHOT</version>
+               <artifactId>argeo-commons</artifactId>
+               <relativePath>..</relativePath>
+       </parent>
+       <artifactId>doc</artifactId>
+       <name>Commons Doc</name>
+       <packaging>pom</packaging>
+       <build>
+               <plugins>
+                       <plugin>
+                               <groupId>com.agilejava.docbkx</groupId>
+                               <artifactId>docbkx-maven-plugin</artifactId>
+                               <version>2.0.8</version>
+                               <configuration>
+                                       <htmlStylesheet>css/style.css</htmlStylesheet>
+                                       <postProcess>
+                                               <!-- See https://fisheye.springframework.org/rdiff/spring-ldap?csid=439&u&N -->
+                                               <copy todir="target/docbkx/html">
+                                                       <fileset dir="src/docbkx">
+                                                               <include name="*/*.css" />
+                                                       </fileset>
+                                               </copy>
+                                       </postProcess>
+                               </configuration>
+                               <executions>
+                                       <execution>
+                                               <goals>
+                                                       <goal>generate-html</goal>
+                                                       <goal>generate-pdf</goal>
+                                               </goals>
+                                               <phase>compile</phase>
+                                       </execution>
+                               </executions>
+                               <dependencies>
+                                       <dependency>
+                                               <groupId>org.docbook</groupId>
+                                               <artifactId>docbook-xml</artifactId>
+                                               <version>4.4</version>
+                                               <scope>runtime</scope>
+                                       </dependency>
+                               </dependencies>
+                       </plugin>
+               </plugins>
+       </build>
+</project>

diff --git a/doc/src/docbkx/commons-gettingStarted.xml b/doc/src/docbkx/commons-gettingStarted.xml
new file mode 100644 (file)
index 0000000..2b680e1
--- /dev/null
+++ b/doc/src/docbkx/commons-gettingStarted.xml
@@ -0,0 +1,35 @@
+<?xml version="1.0"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+                 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
+
+<chapter label="1" id="gettingStarted">
+       <title>Getting started</title>
+
+       <section label="1.1" id="deveptEnvironment">
+               <title>Development environment</title>\r
+               <para>The following instructions are about setting up an Argeo\r
+                       development environment.</para>
+
+               <section label="1.1.1" id="softwareRequirements">
+                       <title>Software requirements</title>\r
+                       <para>\r
+                               The following elements are required to install the development\r
+                               environment:\r
+                               <itemizedlist spacing="compact">\r
+                                       <listitem>\r
+                                               <para>Java</para>\r
+                                       </listitem>\r
+                                       <listitem>\r
+                                               <para>Eclipse</para>\r
+                                       </listitem>\r
+                               </itemizedlist>\r
+                       </para>\r
+               </section>\r
+\r
+               <section label="1.1.2" id="clientInstallation">\r
+                       <title>Client installation</title>
+
+                       <para></para>\r
+               </section>\r
+       </section>
+</chapter>

diff --git a/doc/src/docbkx/css/style.css b/doc/src/docbkx/css/style.css
new file mode 100644 (file)
index 0000000..0f446b9
--- /dev/null
+++ b/doc/src/docbkx/css/style.css
@@ -0,0 +1,303 @@
+body {
+   text-align: justify;
+   margin-right: 2em;
+   margin-left: 2em;
+}
+
+a,
+a[accesskey^="h"],
+a[accesskey^="n"],
+a[accesskey^="u"],
+a[accesskey^="p"] {
+    font-family: Verdana, Arial, helvetica, sans-serif;
+    font-size: 12px;
+       color: #003399;
+}
+
+a:active {
+    color: #003399;
+}
+
+a:visited {
+    color: #888888;
+}
+
+p {
+       font-family: Verdana, Arial, sans-serif;
+}
+
+dt {
+       font-family: Verdana, Arial, sans-serif;
+       font-size: 12px;
+}
+
+p, dl, dt, dd, blockquote {
+    color: #000000;
+    margin-bottom: 3px;
+    margin-top: 3px;
+    padding-top: 0;
+}
+
+ol, ul, p {
+    margin-top: 6px;
+    margin-bottom: 6px;
+}
+
+p, blockquote {
+    font-size: 90%;
+}
+
+p.releaseinfo {
+    font-size: 100%;
+    font-weight: bold;
+    font-family: Verdana, Arial, helvetica, sans-serif;
+    padding-top: 10px;
+}
+
+p.pubdate {
+    font-size: 120%;
+    font-weight: bold; 
+    font-family: Verdana, Arial, helvetica, sans-serif;
+}
+
+td {
+    font-size: 80%;
+}
+
+td, th, span {
+    color: #000000;
+}
+
+td[width^="40%"] {
+    font-family: Verdana, Arial, helvetica, sans-serif;
+    font-size: 12px;
+       color: #003399;
+}
+
+table[summary^="Navigation header"] tbody tr th[colspan^="3"] {
+    font-family: Verdana, Arial, helvetica, sans-serif;
+}
+
+blockquote {
+    margin-right: 0;
+}
+
+h1, h2, h3, h4, h6 {
+    color: #000000;
+    font-weight: 500;
+    margin-top: 0;
+    padding-top: 14px;
+    font-family: Verdana, Arial, helvetica, sans-serif;
+    margin-bottom: 0;
+}
+
+h2.title {
+    font-weight: 800;
+    margin-bottom: 8px;
+}
+
+h2.subtitle {
+    font-weight: 800;
+    margin-bottom: 20px;
+}
+
+.firstname, .surname {
+       font-size: 12px;
+    font-family: Verdana, Arial, helvetica, sans-serif;
+}
+
+table {
+    border-collapse: collapse;
+    border-spacing: 0;
+    border: 1px black;
+    empty-cells: hide;
+    margin: 10px 0 30px 50px;
+    width: 90%;
+}
+
+div.table {
+       margin: 30px 0 10px 0;
+       border: 1px dashed gray;
+       padding: 10px;
+}
+
+div .table-contents table {
+       border: 1px solid black;
+}
+
+div.table > p.title {
+       padding-left: 10px;
+}
+
+table[summary^="Navigation footer"] {
+    border-collapse: collapse;
+    border-spacing: 0;
+    border: 1px black;
+    empty-cells: hide;    
+    margin: 0px;
+    width: 100%;
+}
+
+table[summary^="Note"],
+table[summary^="Warning"],
+table[summary^="Tip"] {
+    border-collapse: collapse;
+    border-spacing: 0;
+    border: 1px black;
+    empty-cells: hide;    
+    margin: 10px 0px 10px -20px;
+    width: 100%;
+}
+
+td {
+    padding: 4pt;
+    font-family: Verdana, Arial, helvetica, sans-serif;
+}
+
+div.warning TD {
+       text-align: justify;
+}
+
+h1 { 
+    font-size: 150%; 
+}
+
+h2 { 
+    font-size: 110%; 
+}
+
+h3 {
+    font-size: 100%; font-weight: bold; 
+}
+
+h4 { 
+    font-size: 90%; font-weight: bold;
+}
+
+h5 {
+    font-size: 90%; font-style: italic; 
+}
+
+h6 { 
+    font-size: 100%; font-style: italic; 
+}
+
+tt {
+    font-size: 110%;
+    font-family: "Courier New", Courier, monospace;
+    color: #000000;
+}
+
+.navheader, .navfooter {
+       border: none;
+}
+
+div.navfooter table {
+       border-style: dashed;
+       border-color: gray;
+       border-width: 1px 1px 1px 1px;
+       background-color: #cde48d;
+}
+
+pre {
+    font-size: 110%;
+    padding: 5px;
+    border-style: solid;
+    border-width: 1px;
+    border-color: #CCCCCC;
+    background-color: #f3f5e9;
+}
+
+ul, ol, li {
+    list-style: disc;
+}
+
+hr {
+    width: 100%;
+    height: 1px;
+    background-color: #CCCCCC;
+    border-width: 0;
+    padding: 0;
+}
+
+.variablelist { 
+    padding-top: 10px; 
+    padding-bottom: 10px; 
+    margin: 0;
+}
+
+.term { 
+    font-weight:bold;
+}
+
+.mediaobject {
+    padding-top: 30px; 
+    padding-bottom: 30px; 
+}
+
+.legalnotice {
+    font-family: Verdana, Arial, helvetica, sans-serif;
+    font-size: 12px;
+    font-style: italic;
+}
+
+.sidebar {
+    float: right;
+    margin: 10px 0 10px 30px;
+    padding: 10px 20px 20px 20px;
+    width: 33%;
+    border: 1px solid black;
+    background-color: #F4F4F4;
+    font-size: 14px;
+}
+
+.property {
+       font-family: "Courier New", Courier, monospace;
+}
+
+a code {
+       font-family: Verdana, Arial, monospace;
+       font-size: 12px;
+}
+
+td code {
+    font-size: 110%;
+}
+
+div.note * td,
+div.tip * td,
+div.warning * td,
+div.calloutlist * td {
+       text-align: justify;
+       font-size: 100%;
+}
+
+.programlisting {
+   clear: both;
+}
+
+.programlisting .interfacename,
+.programlisting .literal,
+.programlisting .classname {
+    font-size: 95%;
+}
+
+.title .interfacename,
+.title .literal,
+.title .classname {
+    font-size: 130%;
+}
+
+/* everything in a <lineannotation/> is displayed in a coloured, comment-like font */
+.programlisting * .lineannotation,
+.programlisting * .lineannotation * {
+       color: green;
+}
+
+.question * p {
+    font-size: 100%;
+}
+
+.answer * p {
+    font-size: 100%;
+}
\ No newline at end of file

diff --git a/pom.xml b/pom.xml
index 146bf7350a0eace41d1e85c4c990697c5357c9c5..0efa0af55bdb4c539f14a771cdbf53da9c2a7ae5 100644 (file)
--- a/pom.xml
+++ b/pom.xml
@@ -31,6 +31,7 @@
                <module>server</module>
                <module>eclipse</module>
                <module>security</module>
+               <module>doc</module>
                <module>sandbox</module>
        </modules>
        <url>${site.urlBase}/${developmentCycle}</url>