Author: vsiveton
Date: Tue Jul 25 13:41:58 2006
New Revision: 425517
URL: http://svn.apache.org/viewvc?rev=425517&view=rev
Log:
o Updated documentation for new rtf format
o Consistent layout: updated site.xml (maven-stylus-skin)
o Updated POM for reporting and book despriptor. Added a parent <relativePath/>
Modified:
maven/doxia/site/pom.xml
maven/doxia/site/src/site/apt/book/index.apt
maven/doxia/site/src/site/apt/index.apt
maven/doxia/site/src/site/site.xml
Modified: maven/doxia/site/pom.xml
URL:
http://svn.apache.org/viewvc/maven/doxia/site/pom.xml?rev=425517&r1=425516&r2=425517&view=diff
==============================================================================
--- maven/doxia/site/pom.xml (original)
+++ maven/doxia/site/pom.xml Tue Jul 25 13:41:58 2006
@@ -1,3 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+/*
+ * Copyright 2001-2006 The Apache Software Foundation.
+ *
+ * Licensed 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
xmlns="http://maven.apache.org/POM/4.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
@@ -7,6 +27,7 @@
<groupId>org.apache.maven</groupId>
<artifactId>maven-parent</artifactId>
<version>2</version>
+ <relativePath>../pom/maven/pom.xml</relativePath>
</parent>
<groupId>org.apache.maven.doxia</groupId>
<artifactId>site</artifactId>
@@ -35,6 +56,28 @@
<unsubscribe>[EMAIL PROTECTED]</unsubscribe>
<archive>http://mail-archives.apache.org/mod_mbox/maven-doxia-commits/</archive>
</mailingList>
+ <!-- duplication from parent pom - temporary until they inherit properly
-->
+ <mailingList>
+ <name>Maven Announcements List</name>
+ <post>[email protected]</post>
+ <subscribe>[EMAIL PROTECTED]</subscribe>
+ <unsubscribe>[EMAIL PROTECTED]</unsubscribe>
+
<archive>http://mail-archives.apache.org/mod_mbox/maven-announce/</archive>
+ </mailingList>
+ <mailingList>
+ <name>Maven Issues List</name>
+ <post>[email protected]</post>
+ <subscribe>[EMAIL PROTECTED]</subscribe>
+ <unsubscribe>[EMAIL PROTECTED]</unsubscribe>
+ <archive>http://mail-archives.apache.org/mod_mbox/maven-issues/</archive>
+ </mailingList>
+ <mailingList>
+ <name>Maven Notifications List</name>
+ <post>[email protected]</post>
+ <subscribe>[EMAIL PROTECTED]</subscribe>
+ <unsubscribe>[EMAIL PROTECTED]</unsubscribe>
+
<archive>http://mail-archives.apache.org/mod_mbox/maven-notifications/</archive>
+ </mailingList>
</mailingLists>
<scm>
<connection>scm:svn:http://svn.apache.org/repos/asf/maven/doxia/site</connection>
@@ -78,12 +121,40 @@
<format>
<id>xdoc</id>
</format>
+ <format>
+ <id>pdf</id>
+ </format>
+ <format>
+ <id>rtf</id>
+ </format>
</formats>
</book>
</books>
</configuration>
</plugin>
<!-- END SNIPPET: configuration -->
+ <plugin>
+ <groupId>org.codehaus.modello</groupId>
+ <artifactId>modello-maven-plugin</artifactId>
+ <configuration>
+ <model>src/main/modello/book.mdo</model>
+ <version>1.0.0</version>
+ </configuration>
+ <executions>
+ <execution>
+ <id>site-docs</id>
+ <phase>pre-site</phase>
+ <goals>
+ <goal>xdoc</goal>
+ <goal>xsd</goal>
+ </goals>
+ <configuration>
+
<model>../trunk/doxia-sandbox/doxia-book/src/main/modello/book.mdo</model>
+ <version>1.0.0</version>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
</plugins>
</build>
</project>
Modified: maven/doxia/site/src/site/apt/book/index.apt
URL:
http://svn.apache.org/viewvc/maven/doxia/site/src/site/apt/book/index.apt?rev=425517&r1=425516&r2=425517&view=diff
==============================================================================
--- maven/doxia/site/src/site/apt/book/index.apt (original)
+++ maven/doxia/site/src/site/apt/book/index.apt Tue Jul 25 13:41:58 2006
@@ -8,24 +8,32 @@
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 PDF and LaTeX.
+ friendly formats like XDoc, PDF, RTF and LaTeX.
- The Xdoc output which has been rendered into this site can be viewed
{{{../doxia-example-book/}here}}.
+ The Xdoc output which has been rendered into this site can be viewed
{{{../doxia-example-book/index.html}here}}.
* 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 {{{doxia-books/book/index.html}The Book Descriptor Reference}} for a
reference to the descriptor.
+ See {{{../book.html}The Book Descriptor Reference}} for a reference to the
descriptor.
-* Example Book Descriptor
+* Creating Book Descriptor
+
+ An XML file is used to describe the layout of the book.
+
+ A sample is given below:
%{snippet|id=example|file=src/books/example-book.xml}
-* Example Maven Doxia Plug-in Configuration
+* Configuring Maven Doxia Plug-in
This example illustrates how to configure the Doxia Maven plugin. It will
render the book in three different formats.
By default the output will be under <<<target/generated-site/<format>/<book
id> >>>.
+
+ Actually, the out-of-box format ids are: <<<xdoc>>>, <<<pdf>>>, <<<latex>>>,
<<<rtf>>>
+
+ A sample pom.xml is given below:
%{snippet|id=configuration|file=pom.xml}
Modified: maven/doxia/site/src/site/apt/index.apt
URL:
http://svn.apache.org/viewvc/maven/doxia/site/src/site/apt/index.apt?rev=425517&r1=425516&r2=425517&view=diff
==============================================================================
--- maven/doxia/site/src/site/apt/index.apt (original)
+++ maven/doxia/site/src/site/apt/index.apt Tue Jul 25 13:41:58 2006
@@ -20,4 +20,4 @@
to produce PDFs, LaTeX documents and Xdoc for direct integration in your
Maven site.
The Doxia Book code is still in the sandbox but it is fully functional
allthough limited.
- See {{{book/}Writing Books in Doxia}} for more information.
+ See {{{book/index.html}Writing Books in Doxia}} for more information.
Modified: maven/doxia/site/src/site/site.xml
URL:
http://svn.apache.org/viewvc/maven/doxia/site/src/site/site.xml?rev=425517&r1=425516&r2=425517&view=diff
==============================================================================
--- maven/doxia/site/src/site/site.xml (original)
+++ maven/doxia/site/src/site/site.xml Tue Jul 25 13:41:58 2006
@@ -1,4 +1,23 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<!--
+/*
+ * Copyright 2001-2006 The Apache Software Foundation.
+ *
+ * Licensed 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>
@@ -8,6 +27,11 @@
<bannerRight>
<src>http://maven.apache.org/images/maven-logo-2.gif</src>
</bannerRight>
+ <publishDate format="dd MMM yyyy" />
+ <skin>
+ <groupId>org.apache.maven.skins</groupId>
+ <artifactId>maven-stylus-skin</artifactId>
+ </skin>
<body>
<links>
<item name="Apache" href="http://www.apache.org/"/>
@@ -19,10 +43,22 @@
<item name="JXR" href="http://maven.apache.org/jxr"/>
<item name="Doxia" href="http://maven.apache.org/doxia"/>
</links>
+
+ <head>
+ <script src="http://www.google-analytics.com/urchin.js";
type="text/javascript">
+ </script>
+ <script type="text/javascript">
+ _uacct = "UA-140879-1";
+ urchinTracker();
+ </script>
+ </head>
+
<menu name="Doxia">
<item name="Overview" href="index.html"/>
<item name="APT Format" href="format.html"/>
<item name="Writing Books" href="book/index.html"/>
</menu>
+
+ ${reports}
</body>
</project>
