Bommels05/maven-plugins
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Initial version of a plugin which can take HTML and turn it into the xdoc format ready for styling by the xdoc plugin.

Browse Source 
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
This commit is contained in:
jstrachan
2003-03-06 19:15:11 +00:00
parent ff28045b64
commit 4f0f367def
13 changed files with 840 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
html2xdoc/xdocs/.cvsignore Normal file
View File

@@ -0,0 +1 @@
stylesheets

34
html2xdoc/xdocs/goals.xml Normal file
View File

@@ -0,0 +1,34 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<document>
<properties>
<title>Html2XDoc Plugin Goals</title>
<author email="jstrachan@apache.org">James Strachan</author>
</properties>
<body>
<section name="Goals">
<table>
<tr><th>Goal</th><th>Description</th></tr>
<a name="html2xdoc" />
<tr>
<td>html2xdoc</td>
<td>
The default goal. This goal 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.
<br/>
This goal means that normal vanilla HTML can be used to create documentation
using a WYSIWYG editing tool like Mozilla or MS FrontPage.
<br/>
Most end user documentation
only requires basic formatting (bold, italic, bullets) along with headings and images and
links so using normal HTML for docuemntation with a WYSIWYG tool seems like a good idea.
</td>
</tr>
</table>
</section>
</body>
</document>

39
html2xdoc/xdocs/index.xml Normal file
View File

@@ -0,0 +1,39 @@
<?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>
&lt;preGoal name="xdoc:jelly-transform"&gt;
&lt;attainGoal name="html2xdoc"/&gt;
&lt;/preGoal&gt;
</source>
</section>
</body>
</document>

16
html2xdoc/xdocs/navigation.xml Normal file
View File

@@ -0,0 +1,16 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<project name="Maven Html2XDoc Plugin">
<title>Maven Html2XDoc Plugin</title>
<body>
<links>
<item name="Maven" href="http://jakarta.apache.org/turbine/maven/"/>
<item name="Jelly" href="http://jakarta.apache.org/commons/jelly/"/>
</links>
<menu name="Overview">
<item name="Goals" href="/goals.html" />
<item name="Properties" href="/properties.html" />
</menu>
</body>
</project>

34
html2xdoc/xdocs/properties.xml Normal file
View File

@@ -0,0 +1,34 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<document>
<properties>
<title>Html2XDoc Properties</title>
<author email="jstrachan@apache.org">James Strachan</author>
</properties>
<body>
<section name="Html2XDoc Settings">
<table>
<tr><th>Property</th><th>Optional?</th><th>Description</th></tr>
<tr>
<td>maven.html2xdoc.dir</td>
<td>Yes (default=xdoc)</td>
<td>
Specifies the directory containing HTML documents which will be
turned into xdoc XML documents in the
<code>target/generated-xdoc</code> directory
ready for use by the xdoc plugin.
</td>
</tr>
<tr>
<td>maven.html2xdoc.jsl</td>
<td>Yes</td>
<td>
Allows the JSL stylesheet to be specified to perform some custom
HTML to XDoc transformation.
</td>
</tr>
</table>
</section>
</body>
</document>