maven-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ltheu...@apache.org
Subject svn commit: r573544 - in /maven/sandbox/trunk/doxia: doxia-book/src/site/ doxia-book/src/site/apt/ doxia-maven-plugin/ doxia-maven-plugin/src/site/ doxia-maven-plugin/src/site/apt/
Date Fri, 07 Sep 2007 11:16:34 GMT
Author: ltheussl
Date: Fri Sep  7 04:16:33 2007
New Revision: 573544

URL: http://svn.apache.org/viewvc?rev=573544&view=rev
Log:
Adding rudimentary docs

Added:
    maven/sandbox/trunk/doxia/doxia-book/src/site/
    maven/sandbox/trunk/doxia/doxia-book/src/site/apt/
    maven/sandbox/trunk/doxia/doxia-book/src/site/apt/index.apt   (with props)
    maven/sandbox/trunk/doxia/doxia-book/src/site/apt/usage.apt   (with props)
    maven/sandbox/trunk/doxia/doxia-book/src/site/site.xml   (with props)
    maven/sandbox/trunk/doxia/doxia-maven-plugin/src/site/
    maven/sandbox/trunk/doxia/doxia-maven-plugin/src/site/apt/
    maven/sandbox/trunk/doxia/doxia-maven-plugin/src/site/apt/index.apt   (with props)
    maven/sandbox/trunk/doxia/doxia-maven-plugin/src/site/apt/usage.apt   (with props)
    maven/sandbox/trunk/doxia/doxia-maven-plugin/src/site/site.xml   (with props)
Modified:
    maven/sandbox/trunk/doxia/doxia-maven-plugin/pom.xml

Added: maven/sandbox/trunk/doxia/doxia-book/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/doxia/doxia-book/src/site/apt/index.apt?rev=573544&view=auto
==============================================================================
--- maven/sandbox/trunk/doxia/doxia-book/src/site/apt/index.apt (added)
+++ maven/sandbox/trunk/doxia/doxia-book/src/site/apt/index.apt Fri Sep  7 04:16:33 2007
@@ -0,0 +1,20 @@
+ -----
+ Writing Books in Doxia
+ -----
+ Lukas Theussl
+ -----
+
+Introduction
+
+ Doxia allows you to write books like user manuals and guides in any format supported by
Doxia. Combined with the
+ Doxia Book Maven you are able to include the manuals directly in your generated site with
links to the off-line
+ friendly formats like XDoc, PDF, RTF and LaTeX.
+
+* How It Works
+
+ The only thing you need in addition to the content files itself is a simple book descriptor
which is used to specify
+ the ordering of the sections and the names for the chapters.
+
+ See {{{./book.html}The Book Descriptor Reference}} for a reference to the descriptor. A
sample is given on the
+ main Doxia {{{http://maven.apache.org/doxia/book/index.html}site}}.
+

Propchange: maven/sandbox/trunk/doxia/doxia-book/src/site/apt/index.apt
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: maven/sandbox/trunk/doxia/doxia-book/src/site/apt/index.apt
------------------------------------------------------------------------------
    svn:keywords = "Author Date Id Revision"

Added: maven/sandbox/trunk/doxia/doxia-book/src/site/apt/usage.apt
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/doxia/doxia-book/src/site/apt/usage.apt?rev=573544&view=auto
==============================================================================
--- maven/sandbox/trunk/doxia/doxia-book/src/site/apt/usage.apt (added)
+++ maven/sandbox/trunk/doxia/doxia-book/src/site/apt/usage.apt Fri Sep  7 04:16:33 2007
@@ -0,0 +1,31 @@
+ -----
+ Usage
+ -----
+ Lukas Theussl
+ -----
+
+Usage
+
+ Below is a simple example to illustrate how to use it.
+
++------------------------------------------------------
+        BookDoxia doxia = (BookDoxia) lookup( BookDoxia.ROLE );
+
+        // load the book descriptor
+        File book1 = new File( "book-1.xml" );
+
+        BookModel book = doxia.loadBook( book1 );
+
+        // files to include
+        List files = FileUtils.getFiles( new File( "src/resources/book/" ), "**/*.apt, **/*.xml",
"" );
+
+        // render books in different formats
+        doxia.renderBook( book, "pdf", files, new File( "target/itext/" ) );
+        doxia.renderBook( book, "xhtml", files, new File( "target/xhtml/" ) );
+        doxia.renderBook( book, "xdoc", files, new File( "target/xdoc/" ) );
+        doxia.renderBook( book, "latex", files, new File( "target/latex/" ) );
+        doxia.renderBook( book, "doc-book", files, new File( "target/doc-book/" ) );
+        doxia.renderBook( book, "rtf", files, new File( "target/rtf/" ) );
++------------------------------------------------------
+
+ See the {{{./apidocs/index.html}Javadocs}} for more details.

Propchange: maven/sandbox/trunk/doxia/doxia-book/src/site/apt/usage.apt
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: maven/sandbox/trunk/doxia/doxia-book/src/site/apt/usage.apt
------------------------------------------------------------------------------
    svn:keywords = "Author Date Id Revision"

Added: maven/sandbox/trunk/doxia/doxia-book/src/site/site.xml
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/doxia/doxia-book/src/site/site.xml?rev=573544&view=auto
==============================================================================
--- maven/sandbox/trunk/doxia/doxia-book/src/site/site.xml (added)
+++ maven/sandbox/trunk/doxia/doxia-book/src/site/site.xml Fri Sep  7 04:16:33 2007
@@ -0,0 +1,67 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+ -->
+
+<project name="Doxia">
+
+  <bannerLeft>
+    <name>Doxia</name>
+    <src>images/apache-maven-project-2.png</src>
+  </bannerLeft>
+
+  <bannerRight>
+    <src>images/maven-logo-2.gif</src>
+  </bannerRight>
+
+  <publishDate format="dd MMM yyyy" position="right" />
+
+  <skin>
+    <groupId>org.apache.maven.skins</groupId>
+    <artifactId>maven-stylus-skin</artifactId>
+    <version>1.0.1</version>
+  </skin>
+
+  <body>
+
+    <links>
+      <item name="Apache" href="http://www.apache.org/"/>
+      <item name="Maven 1.x" href="http://maven.apache.org/maven-1.x"/>
+      <item name="Maven 2.x" href="http://maven.apache.org/"/>
+      <item name="Continuum" href="http://maven.apache.org/continuum"/>
+      <item name="SCM" href="http://maven.apache.org/scm"/>
+      <item name="Wagon" href="http://maven.apache.org/wagon"/>
+      <item name="JXR" href="http://maven.apache.org/jxr"/>
+      <item name="Doxia" href="http://maven.apache.org/doxia"/>
+    </links>
+
+    <menu name="About Doxia :: Book Components">
+      <item name="Introduction" href="index.html"/>
+      <item name="Usage" href="usage.html"/>
+      <item name="Book descriptor" href="book.html"/>
+      <!--<item name="FAQ" href="faq.html"/>-->
+    </menu>
+
+    <menu ref="reports"/>
+
+  </body>
+
+</project>

Propchange: maven/sandbox/trunk/doxia/doxia-book/src/site/site.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: maven/sandbox/trunk/doxia/doxia-book/src/site/site.xml
------------------------------------------------------------------------------
    svn:keywords = "Author Date Id Revision"

Modified: maven/sandbox/trunk/doxia/doxia-maven-plugin/pom.xml
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/doxia/doxia-maven-plugin/pom.xml?rev=573544&r1=573543&r2=573544&view=diff
==============================================================================
--- maven/sandbox/trunk/doxia/doxia-maven-plugin/pom.xml (original)
+++ maven/sandbox/trunk/doxia/doxia-maven-plugin/pom.xml Fri Sep  7 04:16:33 2007
@@ -59,4 +59,12 @@
       <artifactId>plexus-utils</artifactId>
     </dependency>
   </dependencies>
+  <reporting>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-plugin-plugin</artifactId>
+      </plugin>
+    </plugins>
+  </reporting>
 </project>

Added: maven/sandbox/trunk/doxia/doxia-maven-plugin/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/doxia/doxia-maven-plugin/src/site/apt/index.apt?rev=573544&view=auto
==============================================================================
--- maven/sandbox/trunk/doxia/doxia-maven-plugin/src/site/apt/index.apt (added)
+++ maven/sandbox/trunk/doxia/doxia-maven-plugin/src/site/apt/index.apt Fri Sep  7 04:16:33
2007
@@ -0,0 +1,20 @@
+ -----
+ Doxia Maven Plugin
+ -----
+ Lukas Theussl
+ -----
+
+Introduction
+
+ Doxia allows you to write books like user manuals and guides in any format supported by
Doxia. Combined with the
+ Doxia Book Maven you are able to include the manuals directly in your generated site with
links to the off-line
+ friendly formats like XDoc, PDF, RTF and LaTeX.
+
+* How It Works
+
+ First you need a simple book descriptor which is used to specify the layout of your book,
ie
+ the ordering of the sections and the names for the chapters.
+ See {{{http://maven.apache.org/doxia/book/index.html}The Book Descriptor Reference}}
+ for a reference to the descriptor.
+
+ An example for configuring the Doxia Maven Plugin is found on the {{{./usage.html}usage}}
page.
\ No newline at end of file

Propchange: maven/sandbox/trunk/doxia/doxia-maven-plugin/src/site/apt/index.apt
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: maven/sandbox/trunk/doxia/doxia-maven-plugin/src/site/apt/index.apt
------------------------------------------------------------------------------
    svn:keywords = "Author Date Id Revision"

Added: maven/sandbox/trunk/doxia/doxia-maven-plugin/src/site/apt/usage.apt
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/doxia/doxia-maven-plugin/src/site/apt/usage.apt?rev=573544&view=auto
==============================================================================
--- maven/sandbox/trunk/doxia/doxia-maven-plugin/src/site/apt/usage.apt (added)
+++ maven/sandbox/trunk/doxia/doxia-maven-plugin/src/site/apt/usage.apt Fri Sep  7 04:16:33
2007
@@ -0,0 +1,49 @@
+ -----
+ Usage
+ -----
+ Lukas Theussl
+ -----
+
+Usage
+
+ Below is a sample pom.xml illustrate how to use it.
+
++------------------------------------------------------
+      <plugin>
+        <groupId>org.apache.maven.doxia</groupId>
+        <artifactId>doxia-maven-plugin</artifactId>
+        <version>1.0-SNAPSHOT</version>
+        <executions>
+          <execution>
+            <phase>pre-site</phase>
+            <goals>
+              <goal>render-books</goal>
+            </goals>
+          </execution>
+        </executions>
+        <configuration>
+          <books>
+            <book>
+              <directory>src/books/example-book</directory>
+              <descriptor>src/books/example-book.xml</descriptor>
+              <formats>
+                <format>
+                  <id>latex</id>
+                </format>
+                <format>
+                  <id>xdoc</id>
+                </format>
+                <format>
+                  <id>pdf</id>
+                </format>
+                <format>
+                  <id>rtf</id>
+                </format>
+              </formats>
+            </book>
+          </books>
+        </configuration>
+      </plugin>
++------------------------------------------------------
+
+ See also the sample given on the main Doxia {{{http://maven.apache.org/doxia/book/index.html}site}}.

Propchange: maven/sandbox/trunk/doxia/doxia-maven-plugin/src/site/apt/usage.apt
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: maven/sandbox/trunk/doxia/doxia-maven-plugin/src/site/apt/usage.apt
------------------------------------------------------------------------------
    svn:keywords = "Author Date Id Revision"

Added: maven/sandbox/trunk/doxia/doxia-maven-plugin/src/site/site.xml
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/doxia/doxia-maven-plugin/src/site/site.xml?rev=573544&view=auto
==============================================================================
--- maven/sandbox/trunk/doxia/doxia-maven-plugin/src/site/site.xml (added)
+++ maven/sandbox/trunk/doxia/doxia-maven-plugin/src/site/site.xml Fri Sep  7 04:16:33 2007
@@ -0,0 +1,66 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+ -->
+
+<project name="Doxia">
+
+  <bannerLeft>
+    <name>Doxia</name>
+    <src>images/apache-maven-project-2.png</src>
+  </bannerLeft>
+
+  <bannerRight>
+    <src>images/maven-logo-2.gif</src>
+  </bannerRight>
+
+  <publishDate format="dd MMM yyyy" position="right" />
+
+  <skin>
+    <groupId>org.apache.maven.skins</groupId>
+    <artifactId>maven-stylus-skin</artifactId>
+    <version>1.0.1</version>
+  </skin>
+
+  <body>
+
+    <links>
+      <item name="Apache" href="http://www.apache.org/"/>
+      <item name="Maven 1.x" href="http://maven.apache.org/maven-1.x"/>
+      <item name="Maven 2.x" href="http://maven.apache.org/"/>
+      <item name="Continuum" href="http://maven.apache.org/continuum/"/>
+      <item name="SCM" href="http://maven.apache.org/scm/"/>
+      <item name="Wagon" href="http://maven.apache.org/wagon/"/>
+      <item name="JXR" href="http://maven.apache.org/jxr/"/>
+      <item name="Doxia" href="http://maven.apache.org/doxia/"/>
+    </links>
+
+    <menu name="About Doxia :: Maven Plugin">
+      <item name="Introduction" href="index.html"/>
+      <item name="Usage" href="usage.html"/>
+      <!--<item name="FAQ" href="faq.html"/>-->
+    </menu>
+
+    <menu ref="reports"/>
+
+  </body>
+
+</project>

Propchange: maven/sandbox/trunk/doxia/doxia-maven-plugin/src/site/site.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: maven/sandbox/trunk/doxia/doxia-maven-plugin/src/site/site.xml
------------------------------------------------------------------------------
    svn:keywords = "Author Date Id Revision"



Mime
View raw message