Introduce reference documentation with DocBook
authorMathieu Baudier <mbaudier@argeo.org>
Sat, 15 Apr 2017 16:11:46 +0000 (18:11 +0200)
committerMathieu Baudier <mbaudier@argeo.org>
Sat, 15 Apr 2017 16:11:46 +0000 (18:11 +0200)
doc/.gitignore [new file with mode: 0644]
doc/docbook/argeo-commons.dbk.xml [new file with mode: 0644]
doc/docbook/argeo.css [new file with mode: 0644]
doc/docbook/deploying.dbk.xml [new file with mode: 0644]
doc/docbook/overview.dbk.xml [new file with mode: 0644]
doc/pom.xml [new file with mode: 0644]

diff --git a/doc/.gitignore b/doc/.gitignore
new file mode 100644 (file)
index 0000000..ea8c4bf
--- /dev/null
@@ -0,0 +1 @@
+/target
diff --git a/doc/docbook/argeo-commons.dbk.xml b/doc/docbook/argeo-commons.dbk.xml
new file mode 100644 (file)
index 0000000..2ddbfa4
--- /dev/null
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V5.0/EN" "http://docbook.org/xml/5.0/dtd/docbook.dtd" [
+<!ENTITY mbaudier "Mathieu Baudier">
+]>
+<book xmlns="http://docbook.org/ns/docbook" version="5.0">
+       <xi:include href="overview.dbk.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+       <xi:include href="deploying.dbk.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+</book>
\ No newline at end of file
diff --git a/doc/docbook/argeo.css b/doc/docbook/argeo.css
new file mode 100644 (file)
index 0000000..c9c6195
--- /dev/null
@@ -0,0 +1,11 @@
+body {
+       font-family: sans-serif;
+}
+
+h1 {
+       font-size: 150%
+}
+
+h2 {
+       font-size: 130%
+}
\ No newline at end of file
diff --git a/doc/docbook/deploying.dbk.xml b/doc/docbook/deploying.dbk.xml
new file mode 100644 (file)
index 0000000..0e1fe0c
--- /dev/null
@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V5.0/EN" "http://docbook.org/xml/5.0/dtd/docbook.dtd">
+<chapter xml:id="deploying">
+       <title>Deploying</title>
+       <section>
+               <title>On CentOS or Red Hat Enterprise Linux</title>
+               <para></para>
+       </section>
+</chapter>
\ No newline at end of file
diff --git a/doc/docbook/overview.dbk.xml b/doc/docbook/overview.dbk.xml
new file mode 100644 (file)
index 0000000..72690ae
--- /dev/null
@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V5.0/EN" "http://docbook.org/xml/5.0/dtd/docbook.dtd">
+<chapter xml:id="overview">
+       <title>Overview</title>
+       <para>Argeo Commons is an integration framework.</para>
+       <section>
+               <title>Argeo Commons within the Argeo software stack</title>
+               <para></para>
+       </section>
+</chapter>
\ No newline at end of file
diff --git a/doc/pom.xml b/doc/pom.xml
new file mode 100644 (file)
index 0000000..acc9c08
--- /dev/null
@@ -0,0 +1,78 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<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>
+               <artifactId>argeo-commons</artifactId>
+               <version>2.1.69-SNAPSHOT</version>
+               <relativePath>..</relativePath>
+       </parent>
+       <artifactId>doc</artifactId>
+       <name>Commons Documentation</name>
+       <packaging>pom</packaging>
+       <build>
+               <plugins>
+                       <plugin>
+                               <groupId>com.agilejava.docbkx</groupId>
+                               <artifactId>docbkx-maven-plugin</artifactId>
+                               <version>2.0.15</version>
+                               <configuration>
+                                       <sourceDirectory>docbook</sourceDirectory>
+                                       <includes>argeo-commons.dbk.xml</includes>
+                                       <htmlStylesheet>argeo.css</htmlStylesheet>
+                                       <xincludeSupported>true</xincludeSupported>
+                                       <preProcess>
+                                               <copy todir="${project.build.directory}/docbkx/xhtml5" file="docbook/argeo.css" />
+                                       </preProcess>
+                               </configuration>
+                               <dependencies>
+                                       <dependency>
+                                               <groupId>net.sf.docbook</groupId>
+                                               <artifactId>docbook-xml</artifactId>
+                                               <version>5.0-all</version>
+                                               <classifier>resources</classifier>
+                                               <type>zip</type>
+                                               <scope>runtime</scope>
+                                       </dependency>
+                               </dependencies>
+                               <executions>
+                                       <execution>
+                                               <goals>
+                                                       <goal>generate-xhtml5</goal>
+                                               </goals>
+                                               <phase>package</phase>
+                                       </execution>
+                               </executions>
+                       </plugin>
+               </plugins>
+       </build>
+       <repositories>
+               <!-- <repository> -->
+               <!-- <id>jboss</id> -->
+               <!-- <url>http://repository.jboss.org/</url> -->
+               <!-- <releases> -->
+               <!-- <enabled>true</enabled> -->
+               <!-- </releases> -->
+               <!-- <snapshots> -->
+               <!-- <enabled>false</enabled> -->
+               <!-- </snapshots> -->
+               <!-- </repository> -->
+               <repository>
+                       <id>central</id>
+                       <url>http://repo1.maven.org/maven2</url>
+                       <releases>
+                               <enabled>true</enabled>
+                       </releases>
+                       <snapshots>
+                               <enabled>false</enabled>
+                       </snapshots>
+               </repository>
+       </repositories>
+       <pluginRepositories>
+               <!-- <pluginRepository> -->
+               <!-- <id>jboss</id> -->
+               <!-- <url>http://repository.jboss.org/</url> -->
+               <!-- </pluginRepository> -->
+       </pluginRepositories>
+</project>
\ No newline at end of file