69a739d291
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@368517 13f79535-47bb-0310-9956-ffa450edef68
61 lines
2.0 KiB
XML
61 lines
2.0 KiB
XML
<?xml version="1.0"?>
|
|
<!--
|
|
/*
|
|
* Copyright 2001-2004 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.
|
|
*/
|
|
-->
|
|
|
|
<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 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, either set the
|
|
<code>maven.html2xdoc.enabled</code>
|
|
<a href="properties.html">property</a>,
|
|
or add the following to your <code>maven.xml</code>:
|
|
</p>
|
|
<source>
|
|
<preGoal name="xdoc:init">
|
|
<attainGoal name="html2xdoc"/>
|
|
</preGoal>
|
|
</source>
|
|
</section>
|
|
</body>
|
|
</document>
|