From: Mathieu Baudier Date: Sat, 8 Dec 2012 14:11:18 +0000 (+0000) Subject: Improve build and documentation X-Git-Tag: argeo-commons-2.1.30~718 X-Git-Url: http://git.argeo.org/?a=commitdiff_plain;h=9985c63e371f33b3dac54874dfaaea67b18ce3d1;p=lgpl%2Fargeo-commons.git Improve build and documentation git-svn-id: https://svn.argeo.org/commons/trunk@5921 4cfe0d0a-d680-48aa-b62c-e0a02a3f76cc --- diff --git a/doc/pom.xml b/doc/pom.xml index 3cc534411..5bf01e7f5 100644 --- a/doc/pom.xml +++ b/doc/pom.xml @@ -1,8 +1,9 @@ - + 4.0.0 org.argeo.commons - 0.3.5-SNAPSHOT + 1.1.8-SNAPSHOT argeo-commons .. @@ -14,7 +15,6 @@ com.agilejava.docbkx docbkx-maven-plugin - 2.0.8 css/style.css @@ -32,17 +32,9 @@ generate-html generate-pdf - compile + pre-site - - - org.docbook - docbook-xml - 4.4 - runtime - - diff --git a/doc/reference/commons-gettingStarted.xml b/doc/reference/commons-gettingStarted.xml new file mode 100644 index 000000000..2b680e1a3 --- /dev/null +++ b/doc/reference/commons-gettingStarted.xml @@ -0,0 +1,35 @@ + + + + + Getting started + +
+ Development environment + The following instructions are about setting up an Argeo + development environment. + +
+ Software requirements + + The following elements are required to install the development + environment: + + + Java + + + Eclipse + + + +
+ +
+ Client installation + + +
+
+ diff --git a/doc/reference/css/style.css b/doc/reference/css/style.css new file mode 100644 index 000000000..0f446b9f7 --- /dev/null +++ b/doc/reference/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 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/doc/site/site.xml b/doc/site/site.xml index f639492b4..af6484f0e 100644 --- a/doc/site/site.xml +++ b/doc/site/site.xml @@ -23,10 +23,11 @@ - - - - + + + + + diff --git a/doc/src/docbkx/commons-gettingStarted.xml b/doc/src/docbkx/commons-gettingStarted.xml deleted file mode 100644 index 2b680e1a3..000000000 --- a/doc/src/docbkx/commons-gettingStarted.xml +++ /dev/null @@ -1,35 +0,0 @@ - - - - - Getting started - -
- Development environment - The following instructions are about setting up an Argeo - development environment. - -
- Software requirements - - The following elements are required to install the development - environment: - - - Java - - - Eclipse - - - -
- -
- Client installation - - -
-
- diff --git a/doc/src/docbkx/css/style.css b/doc/src/docbkx/css/style.css deleted file mode 100644 index 0f446b9f7..000000000 --- a/doc/src/docbkx/css/style.css +++ /dev/null @@ -1,303 +0,0 @@ -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 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 490e685d2..41566da45 100644 --- a/pom.xml +++ b/pom.xml @@ -1,5 +1,6 @@ - + 4.0.0 org.argeo.commons argeo-commons @@ -8,10 +9,11 @@ Generic layers integrating free / open source technologies in order to quickly develop custom enterprise systems: security, JCR, user interface, monitoring pom - 1.1 - 2012-06-19 + 1.1 + 2012-06-19 1.3.1 1.1.8-SNAPSHOT + 6 /srv/rpmfactory/argeo-osgi-staging/6/x86_64 @@ -26,11 +28,10 @@ Argeo http://www.argeo.org - ${site.urlBase}/${developmentCycle} + http://projects.argeo.org/commons/ scm:svn:https://svn.argeo.org/commons/trunk - scm:svn:https://svn.argeo.org/commons/trunk - + scm:svn:https://svn.argeo.org/commons/trunk https://svn.argeo.org/commons/trunk 2007 @@ -233,6 +234,11 @@ limitations under the License. maven-license-plugin 1.9.0 + + com.agilejava.docbkx + docbkx-maven-plugin + 2.0.14 + maven-site-plugin @@ -326,7 +332,7 @@ limitations under the License. date - ${developmentCycle.startDate} + ${developmentCycle.argeo-commons.startDate} yyyy-MM-dd @@ -436,6 +442,34 @@ limitations under the License. + + com.agilejava.docbkx + docbkx-maven-plugin + + doc/reference + target/site/reference + css/style.css + + + + + + + + + + + + + + + generate-html + generate-pdf + + pre-site + + + @@ -483,13 +517,13 @@ limitations under the License. staging - dav:https://repo.argeo.org/data/files/java/org.argeo.commons-1.1.x + dav:https://repo.argeo.org/data/files/java/org.argeo.commons-${developmentCycle.argeo-commons}.x false site Argeo Commons Site - file:///srv/projects/www/commons/site/${project.version} + dav:https://repo.argeo.org/data/files/docs/org.argeo.commons-${developmentCycle.argeo-commons}.x @@ -499,13 +533,13 @@ limitations under the License. localrepo Internal Release Repository - dav:http://localrepo:7070/data/files/java/org.argeo.commons-1.1.x + dav:http://localhost:7070/data/files/java/org.argeo.commons-${developmentCycle.argeo-commons}.x - - localrepo.snapshots - Internal Snapshot Repository - dav:http://localrepo:7070/data/files/java/org.argeo.commons-1.1.x - + + site + Argeo Commons Site + dav:http://localhost:7070/data/files/docs/org.argeo.commons-${developmentCycle.argeo-commons}.x + @@ -515,11 +549,5 @@ limitations under the License. /srv/rpmfactory/argeo-osgi-staging/5/x86_64 - - doc - - doc - -