Apache
/
hbase
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

HBASE-2650 Consolidate user guide style documentation -- experiment with docbkx mvn plugin 

git-svn-id: https://svn.apache.org/repos/asf/hbase/trunk@979124 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Michael Stack 2010-07-25 21:34:46 +00:00
parent 95612cd281
commit 55e8b201e6
4 changed files with 157 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
pom.xml
View File

@ -287,6 +287,37 @@
</resources>
<plugins>
<plugin>
<groupId>com.agilejava.docbkx</groupId>
<artifactId>docbkx-maven-plugin</artifactId>
<version>2.0.10</version>
<executions>
<execution>
<goals>
<goal>generate-html</goal>
</goals>
<phase>pre-site</phase>
</execution>
</executions>
<dependencies>
<dependency>
<groupId>org.docbook</groupId>
<artifactId>docbook-xml</artifactId>
<version>4.4</version>
<scope>runtime</scope>
</dependency>
</dependencies>
<configuration>
<xincludeSupported>true</xincludeSupported>
<chunkedOutput>true</chunkedOutput>
<useIdAsFilename>true</useIdAsFilename>
<targetDirectory>
${basedir}/target/site/
</targetDirectory>
</configuration>
</plugin>
<plugin>
<artifactId>maven-assembly-plugin</artifactId>
<!-- THIS might not be doable

67
src/docbkx/book.xml Normal file
View File

@ -0,0 +1,67 @@
<?xml version="1.0" encoding="UTF-8"?>
<book version="5.0" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns:m="http://www.w3.org/1998/Math/MathML"
xmlns:html="http://www.w3.org/1999/xhtml"
xmlns:db="http://docbook.org/ns/docbook">
<info>
<title>HBase Book
<?eval ${project.version}?>
</title>
</info>
<chapter xml:id="getting_started">
<title >Getting Started</title>
<section>
<title>Requirements</title>
<para>First...</para>
</section>
</chapter>
<chapter xml:id="datamodel">
<title>Data Model</title>
<para></para>
</chapter>
<chapter xml:id="implementation">
<title>Implementation</title>
<para></para>
</chapter>
<chapter xml:id="mapreduce">
<title>MapReduce</title>
<para></para>
</chapter>
<chapter xml:id="schema">
<title>Schema Design</title>
<para></para>
</chapter>
<chapter xml:id="shell">
<title>Shell</title>
<para></para>
</chapter>
<chapter xml:id="thrift">
<title>Thrift</title>
<para></para>
</chapter>
<chapter xml:id="rest">
<title>REST</title>
<para></para>
</chapter>
</book>

57
src/docbkx/sample_article.xml Normal file
View File

@ -0,0 +1,57 @@
<?xml version="1.0" encoding="UTF-8"?>
<article version="5.0" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns:m="http://www.w3.org/1998/Math/MathML"
xmlns:html="http://www.w3.org/1999/xhtml"
xmlns:db="http://docbook.org/ns/docbook">
<info>
<title>Wah-wah
<?eval ${project.version}?>
</title>
</info>
<section xml:id="wahwah">
<title>Wah-Wah changed my life</title>
<para>I was born very young...</para>
<para>This is a sample docbook article.</para>
<para>
<?eval ${project.version}?>
</para>
<section xml:id="then">
<title>Then</title>
<para></para>
</section>
<section xml:id="and">
<title>And</title>
<para></para>
</section>
<section xml:id="later">
<title>Later</title>
<para></para>
</section>
</section>
<section xml:id="good_books">
<title>Good books</title>
<para></para>
</section>
<section xml:id="rainy_days">
<title>Rainy days</title>
<para>Today it was raining</para>
</section>
</article>

2
src/site/site.xml
View File

@ -37,6 +37,8 @@
<item name="HBase on Windows" href="cygwin.html" />
<item name="Cluster replication" href="replication.html" />
<item name="Pseudo-Distributed HBase" href="pseudo-distributed.html" />
<item name="HBase Book" href="book.html" />
<item name="Example Docbook Article" href="sample_article.html" />
</menu>
</body>
<skin>