Author: vsiveton
Date: Mon Mar 2 13:44:04 2009
New Revision: 749306
URL: http://svn.apache.org/viewvc?rev=749306&view=rev
Log:
o improved doc
Added:
maven/doxia/site/src/site/apt/developers/maven.apt (with props)
maven/doxia/site/src/site/apt/downloads.apt (with props)
maven/doxia/site/src/site/apt/whatsnew-1.1.apt (with props)
Modified:
maven/doxia/site/src/site/apt/index.apt
maven/doxia/site/src/site/apt/issues/index.apt
maven/doxia/site/src/site/fml/faq.fml
maven/doxia/site/src/site/site.xml
Added: maven/doxia/site/src/site/apt/developers/maven.apt
URL:
http://svn.apache.org/viewvc/maven/doxia/site/src/site/apt/developers/maven.apt?rev=749306&view=auto
==============================================================================
--- maven/doxia/site/src/site/apt/developers/maven.apt (added)
+++ maven/doxia/site/src/site/apt/developers/maven.apt Mon Mar 2 13:44:04 2009
@@ -0,0 +1,86 @@
+ -----
+ Integration With Maven
+ -----
+ Vincent Siveton
+ ------
+ 2009-03-02
+ ------
+
+~~ 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.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/doxia/references/apt-format.html
+
+Integration With Maven
+
+ This page presents how to use Doxia 1.1 with Maven 2.0.x and 2.1.x with a
Maven reporting plugin.
+ Its goal is to help the Maven reporting plugin developer to integrate it.
+
+* Maven 2.0.x
+
+ Doxia 1.0 API is embedded in Maven 2.0.x (see
{{{http://jira.codehaus.org/browse/MNG-3402}MNG-3402}}),
+ so your Maven reporting plugin needs to shade Doxia 1.1 API and Logging to be
backward compatible
+ with Maven 2.0.x.
+
++-----+
+<project>
+ ...
+ <build>
+ ...
+ <plugins>
+ <plugin>
+ <artifactId>maven-shade-plugin</artifactId>
+ <version>1.2</version>
+ <executions>
+ <execution>
+ <phase>package</phase>
+ <goals>
+ <goal>shade</goal>
+ </goals>
+ <configuration>
+ <finalName>${project.build.finalName}</finalName>
+ <createDependencyReducedPom>false</createDependencyReducedPom>
+
<keepDependenciesWithProvidedScope>true</keepDependenciesWithProvidedScope>
+ <transformers>
+ <transformer
implementation="org.apache.maven.plugins.shade.resource.ComponentsXmlResourceTransformer"
/>
+ </transformers>
+ <artifactSet>
+ <includes>
+ <include>org.apache.maven.doxia:doxia-sink-api</include>
+ <include>org.apache.maven.doxia:doxia-logging-api</include>
+ </includes>
+ </artifactSet>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ ...
+ </plugins>
+ </build>
+ ...
+</project>
++-----+
+
+* Maven 2.1.x
+
+ Doxia 1.1 API and Logging are embedded in Maven 2.1.x, your Maven reporting
plugin is directly compatible with 2.1.x.
+
+Common Bugs and Pitfalls
+
+ Please read the {{{../issues/index.html}Doxia Issues}} page.
+
Propchange: maven/doxia/site/src/site/apt/developers/maven.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/doxia/site/src/site/apt/developers/maven.apt
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Added: maven/doxia/site/src/site/apt/downloads.apt
URL:
http://svn.apache.org/viewvc/maven/doxia/site/src/site/apt/downloads.apt?rev=749306&view=auto
==============================================================================
--- maven/doxia/site/src/site/apt/downloads.apt (added)
+++ maven/doxia/site/src/site/apt/downloads.apt Mon Mar 2 13:44:04 2009
@@ -0,0 +1,38 @@
+ -----
+ Download
+ -----
+ Vincent Siveton
+ ------
+ 2009-03-02
+ ------
+
+~~ 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.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/doxia/references/apt-format.html
+
+Maven Doxia Releases
+
+ Releases of Maven Doxia are made available in both binary and source
distributions.
+ Individual JARs are also made available through Apache Maven repositories.
+
+ * {{{http://repo2.maven.org/maven2/org/apache/maven/doxia/}Doxia 1.1}}
+
+ * {{{http://repo2.maven.org/maven2/org/apache/maven/doxia/}Doxia 1.0}}
+
+ []
\ No newline at end of file
Propchange: maven/doxia/site/src/site/apt/downloads.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/doxia/site/src/site/apt/downloads.apt
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Modified: maven/doxia/site/src/site/apt/index.apt
URL:
http://svn.apache.org/viewvc/maven/doxia/site/src/site/apt/index.apt?rev=749306&r1=749305&r2=749306&view=diff
==============================================================================
--- maven/doxia/site/src/site/apt/index.apt (original)
+++ maven/doxia/site/src/site/apt/index.apt Mon Mar 2 13:44:04 2009
@@ -4,7 +4,7 @@
Jason van Zyl
Vincent Siveton
------
- July 2007
+ 2009-03-02
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -35,11 +35,21 @@
dynamic content generation systems like blogs, wikis and content management
systems.
Doxia supports markup languages with simple syntaxes. Lightweight markup
languages
- are used by people who might be expected to read the document source as well
as the rendered output.
+ are used by people who might be expected to read the document source as well
as the rendered
+ output.
- Doxia is used extensively by Maven and it powers the entire documentation
system of Maven.
+ Doxia is used extensively by {{{http://maven.apache.org}Maven}} and it powers
the entire
+ documentation system of Maven.
It gives Maven the ability to take any document that Doxia supports and
output it any format.
+ The current version of Doxia is 1.1.
+
+* Maven Doxia Enhancements
+
+ * {{{whatsnew-1.1.html}What's new in 1.1}}
+
+ []
+
* Brief History
~~ {{{http://www.xmlmind.com/aptconvert.html}Aptconvert}}
@@ -53,9 +63,7 @@
* Developed in Java
* Support of several markup formats: APT (Almost Plain Text), Confluence,
Simplified DocBook,
- FML (FAQ Markup Language), LaTeX, RTF, TWiki, XDoc (popular in Apache
land), XHTML
-
-~~ iText should be replaced by FOP
+ FML (FAQ Markup Language), FOP, iText, LaTeX, RTF, TWiki, XDoc (popular in
Apache land), XHTML
* Easy to learn the syntax of the supported markup formats
@@ -65,4 +73,19 @@
* Extensible framework
+ * Additional Tools like {{{doxia-tools/doxia-converter/index.html}Doxia
Converter}}
+
+ []
+
+* Doxia Reference Pages
+
+ References pages listing all supported markups for each format.
+
+ * {{{references/doxia-apt.html}Apt Format}}
+
+ * {{{references/fml-format.html}FML Format}}
+
+ * {{{references/xdoc-format.html}Xdoc Format}}
+
[]
+
Modified: maven/doxia/site/src/site/apt/issues/index.apt
URL:
http://svn.apache.org/viewvc/maven/doxia/site/src/site/apt/issues/index.apt?rev=749306&r1=749305&r2=749306&view=diff
==============================================================================
--- maven/doxia/site/src/site/apt/issues/index.apt (original)
+++ maven/doxia/site/src/site/apt/issues/index.apt Mon Mar 2 13:44:04 2009
@@ -3,7 +3,7 @@
-----
Lukas Theussl
------
- March 2008
+ 2009-03-02
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -69,3 +69,8 @@
-----
<img src="figure.png" alt="Figure caption"/>
-----
+
+* {Empty Generated Page}
+
+ After running <<<mvn site>>> using your Maven reporting plugin, you see that
the generated page is empty.
+ Be sure that the the code calls <<<sink.close()>>>.
Added: maven/doxia/site/src/site/apt/whatsnew-1.1.apt
URL:
http://svn.apache.org/viewvc/maven/doxia/site/src/site/apt/whatsnew-1.1.apt?rev=749306&view=auto
==============================================================================
--- maven/doxia/site/src/site/apt/whatsnew-1.1.apt (added)
+++ maven/doxia/site/src/site/apt/whatsnew-1.1.apt Mon Mar 2 13:44:04 2009
@@ -0,0 +1,51 @@
+ -----
+ What's new in 1.1?
+ -----
+ Vincent Siveton
+ ------
+ 2009-03-02
+ ------
+
+~~ 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.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/doxia/references/apt-format.html
+
+What's new in 1.1?
+
+ This document describes the changes made to Maven Doxia between versions 1.0
and 1.1.
+
+* Notable New Features
+
+ * <<Logging>>: added logging support with a new project called
{{{doxia/doxia-logging-api}doxia-logging-api}}.
+
+ * <<Sink API improvements>>: added a new <<<SinkEventAttributes>>> interface
to handle attributes.
+ The <<<Sink>>> interface has been updated to use this new interface.
+
+ * <<SinkFactory>>: all Sink implementations could be retrieve via a factory.
+
+ * <<XSDs>>: created {{{faq.html#doxia-xsd}XSDs}} like FML, XDOC.
+
+ * <<Tools>>: created some tools like a
{{{doxia-tools/doxia-converter/index.html}converter}} to use
+ Doxia outside of Maven.
+
+ []
+
+ If you are a Maven Plugin developer and you plan to switch to Doxia 1.1,
please read this
+ {{{developers/maven.html}Maven Integration}} page to understand how to
integrate correctly Doxia 1.1
+ with Maven.
Propchange: maven/doxia/site/src/site/apt/whatsnew-1.1.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/doxia/site/src/site/apt/whatsnew-1.1.apt
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Modified: maven/doxia/site/src/site/fml/faq.fml
URL:
http://svn.apache.org/viewvc/maven/doxia/site/src/site/fml/faq.fml?rev=749306&r1=749305&r2=749306&view=diff
==============================================================================
--- maven/doxia/site/src/site/fml/faq.fml (original)
+++ maven/doxia/site/src/site/fml/faq.fml Mon Mar 2 13:44:04 2009
@@ -167,5 +167,13 @@
</p>
</answer>
</faq>
+ <faq id="How_to_integrate_Doxia_1.1_with_Maven">
+ <question>How to integrate Doxia 1.1 with Maven?</question>
+ <answer>
+ <p>
+ See this <a href="developers/maven.html">page</a>.
+ </p>
+ </answer>
+ </faq>
</part>
</faqs>
\ No newline at end of file
Modified: maven/doxia/site/src/site/site.xml
URL:
http://svn.apache.org/viewvc/maven/doxia/site/src/site/site.xml?rev=749306&r1=749305&r2=749306&view=diff
==============================================================================
--- maven/doxia/site/src/site/site.xml (original)
+++ maven/doxia/site/src/site/site.xml Mon Mar 2 13:44:04 2009
@@ -36,6 +36,7 @@
<menu name="About Doxia">
<item name="What is Doxia?" href="index.html"/>
<item name="Overview" href="overview.html"/>
+ <item name="Downloads" href="downloads.html"/>
<item name="FAQ" href="faq.html"/>
</menu>
@@ -52,11 +53,11 @@
<item name="Writing Books" href="book/index.html"/>
<!-- MSITE-333: remove double-amp when fixed -->
<item name="Issues &amp; Gotchas" href="issues/index.html"/>
- <item name="Developer Centre" href="developers/index.html"/>
<item name="External Resources" href="resources.html"/>
</menu>
<menu name="Developer docs">
+ <item name="Developer Centre" href="developers/index.html"/>
<item name="Doxia 1.0.x" href="doxia-1.0.x/index.html"/>
<item name="Doxia Sitetools 1.0.x"
href="doxia-sitetools-1.0.x/index.html"/>
<item name="Doxia Tools" href="doxia-tools/index.html"/>
