4f0f367def
This allows developers to use good old HTML (and some WYSIWYG tool) to edit & maintain documentation and get it included in the same site documentation as all the xdoc stuff git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@113056 13f79535-47bb-0310-9956-ffa450edef68
40 lines
1.2 KiB
XML
40 lines
1.2 KiB
XML
<?xml version="1.0"?>
|
|
<document>
|
|
|
|
<properties>
|
|
<title>Maven Html2XDoc Plug-in</title>
|
|
<author email="jstrachan@apache.org">James Strachan</author>
|
|
</properties>
|
|
|
|
<body>
|
|
<section name="Maven Html2XDoc Plug-in">
|
|
<p>
|
|
This plugin generates xdoc documents from some basic
|
|
HTML documentation which can then be styled by the xdoc goal to use
|
|
a uniform CSS style and add the common navigation links etc.
|
|
</p>
|
|
<p>
|
|
This goal means that normal vanilla HTML can be used to create documentation
|
|
using a WYSIWYG editing tool like Mozilla or MS FrontPage.
|
|
</p>
|
|
<p>
|
|
Most end user documentation
|
|
only requires basic formatting (bold, italic, bullets) along with headings and images and
|
|
links so using normal HTML for documentation with a WYSIWYG tool is a good idea.
|
|
</p>
|
|
<p>
|
|
The properties that allow you to customize the execution
|
|
are documented <a href="properties.html">here</a>.
|
|
</p>
|
|
<p>
|
|
To enable HTML to xdoc conversion add the following to your maven.xml
|
|
</p>
|
|
<source>
|
|
<preGoal name="xdoc:jelly-transform">
|
|
<attainGoal name="html2xdoc"/>
|
|
</preGoal>
|
|
</source>
|
|
</section>
|
|
</body>
|
|
</document>
|