incubator-hise-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Andreas Veithen <andreas.veit...@gmail.com>
Subject Re: svn commit: r903642 - in /incubator/hise/trunk/hise-docs: ./ generate pom.xml src/ src/main/ src/main/resources/ src/main/resources/developer-guide.xml src/main/resources/user-guide.xml
Date Wed, 27 Jan 2010 21:05:49 GMT
There is actually a Maven plugin called docbkx-maven-plugin that is
able to generate HTML (and PDF) from Docbook files (though I never
tested it with DB 5.0). This is probably a better long term solution
than using OS specific scripts. Here are some links to sample
configurations of that plugin:

* https://svn.apache.org/repos/asf/webservices/commons/trunk/modules/axiom/pom.xml
* https://svn.apache.org/repos/asf/httpcomponents/httpcore/trunk/pom.xml
* http://code.google.com/p/ddom/source/browse/trunk/pom.xml

Regards,

Andreas

On Wed, Jan 27, 2010 at 14:51,  <rr@apache.org> wrote:
> Author: rr
> Date: Wed Jan 27 13:51:51 2010
> New Revision: 903642
>
> URL: http://svn.apache.org/viewvc?rev=903642&view=rev
> Log:
> HISE-10: Initial HISE User Guide and Developer Guide
>
> Added:
>    incubator/hise/trunk/hise-docs/
>    incubator/hise/trunk/hise-docs/generate
>    incubator/hise/trunk/hise-docs/pom.xml
>    incubator/hise/trunk/hise-docs/src/
>    incubator/hise/trunk/hise-docs/src/main/
>    incubator/hise/trunk/hise-docs/src/main/resources/
>    incubator/hise/trunk/hise-docs/src/main/resources/developer-guide.xml   (with props)
>    incubator/hise/trunk/hise-docs/src/main/resources/user-guide.xml   (with props)
>
> Added: incubator/hise/trunk/hise-docs/generate
> URL: http://svn.apache.org/viewvc/incubator/hise/trunk/hise-docs/generate?rev=903642&view=auto
> ==============================================================================
> --- incubator/hise/trunk/hise-docs/generate (added)
> +++ incubator/hise/trunk/hise-docs/generate Wed Jan 27 13:51:51 2010
> @@ -0,0 +1,17 @@
> +#!/bin/bash
> +
> +if [ "${DOCBOOK_DIR}" = "" ];then
> +cat <<EOF
> +Please provide DOCBOOK_DIR (docbook-xsl-1.75.2), like
> +DOCBOOK_DIR=/some/dir/ ./generate
> +
> +EOF
> +exit 1
> +fi
> +
> +mvn clean compile -o
> +mkdir -p target/site
> +for i in target/classes/*.xml;do
> +j="`basename $i .xml`"
> +xsltproc       --output  target/site/${j}.xhtml      ${DOCBOOK_DIR}/xhtml/docbook.xsl
 $i
> +done
>
> Added: incubator/hise/trunk/hise-docs/pom.xml
> URL: http://svn.apache.org/viewvc/incubator/hise/trunk/hise-docs/pom.xml?rev=903642&view=auto
> ==============================================================================
> --- incubator/hise/trunk/hise-docs/pom.xml (added)
> +++ incubator/hise/trunk/hise-docs/pom.xml Wed Jan 27 13:51:51 2010
> @@ -0,0 +1,22 @@
> +<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/xsd/maven-4.0.0.xsd">
> +
> +  <modelVersion>4.0.0</modelVersion>
> +
> +  <parent>
> +    <artifactId>hise</artifactId>
> +    <groupId>org.apache.hise</groupId>
> +    <version>1.0.21-SNAPSHOT</version>
> +  </parent>
> +
> +  <artifactId>hise-docs</artifactId>
> +
> +  <packaging>jar</packaging>
> +  <build>
> +    <resources>
> +      <resource>
> +        <directory>src/main/resources</directory>
> +        <filtering>true</filtering>
> +      </resource>
> +    </resources>
> +  </build>
> +</project>
>
> Added: incubator/hise/trunk/hise-docs/src/main/resources/developer-guide.xml
> URL: http://svn.apache.org/viewvc/incubator/hise/trunk/hise-docs/src/main/resources/developer-guide.xml?rev=903642&view=auto
> ==============================================================================
> --- incubator/hise/trunk/hise-docs/src/main/resources/developer-guide.xml (added)
> +++ incubator/hise/trunk/hise-docs/src/main/resources/developer-guide.xml Wed Jan 27
13:51:51 2010
> @@ -0,0 +1,60 @@
> +<?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:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://docbook.org/ns/docbook file:/usr/share/schemas/docbook.xsd">
> +  <info>
> +    <title>Apache HISE Developer Guide</title>
> +    <releaseinfo>${project.version}</releaseinfo>
> +  </info>
> +  <index/>
> +  <chapter>
> +    <title>Compiling, Running &amp; Testing</title>
> +    <para>
> +      A quick introduction to compiling and running:
> +      <itemizedlist>
> +        <listitem>
> +          <para>
> +            install oracle XE and create hise user with hise password (easiest
way is via http://localhost:8980/apex/apex)
> +          </para>
> +        </listitem>
> +        <listitem>
> +          <para>
> +            mvn clean install
> +          </para>
> +        </listitem>
> +        <listitem>
> +          <para>
> +            enter hise-web, run mvn jetty:run, enter http://localhost:8080/ -
it will show published WS Services and operations
> +          </para>
> +        </listitem>
> +        <listitem>
> +          <para>
> +            run soapui 3.5-beta1 and run tests from project hise-web/soapui-tests/hise-soapui-project.xml
> +        </para>
> +        </listitem>
> +      </itemizedlist>
> +
> +      Each time you do mvn jetty:run, whole DB is erased.
> +    </para>
> +    <para>
> +      I prefer to use default configuration as Oracle instead of in memory
> +      DB, because it's better for monitoring and shows more errors.
> +      On Debian like systems, you can easily install oracle-xe package.
> +      But you can modify data source in /hise-test-example/src/main/resources/hise-ds.xml.
> +      There exists a configuration for H2 Database, which is commented out.
> +   </para>
> +   <para>
> +      HISE has two types of tests:
> +      <itemizedlist>
> +        <listitem>
> +          <para>
> +            unit tests - those test a single module, for example DAO
> +          </para>
> +        </listitem>
> +        <listitem>
> +          <para>
> +            integration tests - SoapUI test scenarios for a single use case
> +          </para>
> +        </listitem>
> +      </itemizedlist>
> +   </para>
> +  </chapter>
> +</book>
>
> Propchange: incubator/hise/trunk/hise-docs/src/main/resources/developer-guide.xml
> ------------------------------------------------------------------------------
>    svn:eol-style = native
>
> Added: incubator/hise/trunk/hise-docs/src/main/resources/user-guide.xml
> URL: http://svn.apache.org/viewvc/incubator/hise/trunk/hise-docs/src/main/resources/user-guide.xml?rev=903642&view=auto
> ==============================================================================
> --- incubator/hise/trunk/hise-docs/src/main/resources/user-guide.xml (added)
> +++ incubator/hise/trunk/hise-docs/src/main/resources/user-guide.xml Wed Jan 27 13:51:51
2010
> @@ -0,0 +1,25 @@
> +<?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:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://docbook.org/ns/docbook file:/usr/share/schemas/docbook.xsd">
> +  <info>
> +    <title>Apache HISE User Guide</title>
> +    <releaseinfo>${project.version}</releaseinfo>
> +  </info>
> +
> +  <index/>
> +
> +  <chapter>
> +    <title>Quick Introduction</title>
> +    <para>
> +    In order to have something running, you need to do following steps:
> +    <itemizedlist>
> +      <listitem><para>Download HISE distribution</para></listitem>
> +      <listitem><para>Then you need to unzip HISE WAR contents into your
application server directory (like Apache Tomcat). Name it hise.</para></listitem>
> +      <listitem><para>Copy example files from examples/claims-approval
into WEB-INF directory</para></listitem>
> +      <listitem><para>Start your application server</para></listitem>
> +      <listitem><para>Enter hise URL into your browser. For Tomcat, this
will be http://localhost:8080/hise.
> +      There will be a list of services exposed by HISE. It will contain approve operation
from example task.
> +      </para></listitem>
> +    </itemizedlist>
> +    </para>
> +  </chapter>
> +</book>
>
> Propchange: incubator/hise/trunk/hise-docs/src/main/resources/user-guide.xml
> ------------------------------------------------------------------------------
>    svn:eol-style = native
>
>
>

Mime
View raw message