The following comment has been added to this issue:
Author: dion gillard
Created: Thu, 25 Sep 2003 11:47 PM
Body:
Few issues:
+ <define:tag name="jslToSite">
+ <!--
+ | transforms files in the given dir using the site stylesheet and navigation
and place them
+ | in maven.docs.dest (tipically target/docs)
typo, should be 'typically'
+ | @srcdir source directory
Is this mandatory? There should be a check for it.
+ -->
+
+ <j:set
+ var="maven.docs.outputencoding"
+
value="${pom.getPluginContext('maven-xdoc-plugin').getVariable('maven.docs.outputencoding')}"
/>
maven.docs.* are not plugin properties.
+ <j:set
+ var="outputDirectory"
+
value="${pom.getPluginContext('maven-xdoc-plugin').getVariable('maven.gen.docs')}" />
Ditto.
+ <j:set
+ var="context"
+ value="${pom.getPluginContext('maven-xdoc-plugin')}" />
Used for?
[snip]
+ <j:new
+ var="mapper"
+ className="org.apache.maven.util.CaseInsensitiveGlobPatternMapper" />
This should be conditionally instantiated from performJSL.
+ <j:set var="stylesheet" value="file:/${plugin.resources}/site.jsl" />
Same.
+ <j:useBean var="pathTool" class="org.apache.maven.util.DVSLPathTool" />
Same.
+ <j:set
+ var="includeProjectDocumentation"
+
value="${pom.getPluginContext('maven-xdoc-plugin').getVariable('includeProjectDocumentation')}"
/>
Shouldn't this have maven.xdoc.includeProjectDocumentation instead?
---------------------------------------------------------------------
View the issue:
http://jira.codehaus.org/secure/ViewIssue.jspa?key=MAVEN-853
Here is an overview of the issue:
---------------------------------------------------------------------
Key: MAVEN-853
Summary: Add a tag to the xdoc plugin to easily transform a file using the site
style and navigation
Type: Improvement
Status: Unassigned
Priority: Major
Time Spent: Unknown
Remaining: Unknown
Project: maven
Components:
plugin-xdoc
Versions:
1.0-rc1
Assignee:
Reporter: fabrizio giustina
Created: Thu, 25 Sep 2003 3:57 PM
Updated: Thu, 25 Sep 2003 3:57 PM
Description:
the xdoc plugin offers few tags to transform xml with a user defined stylesheet, but
there is no way to transform a file using the site style and navigation.
This is needed for plugins working on top of the generated docs, like linkcheck: they
need to run after the performJSL is complete and they need to run the transformation
again on the result.
Actually the linkchek plugin uses a specific goal, xdoc:performJSL, whick can not be
used by other plugins, since it access a variable in the linkcheck plugin
// from the xdoc plugin (UGLY!):
---
<!-- This is required as the linkchecker runs as a final pass over the generated
document tree -->
<goal name="xdoc:performJSL" description="Allows the LinkCheck plugin to xdoc a
single directory">
<j:set var="maven.xdoc.src"
value="${pom.getPluginContext('maven-linkcheck-plugin').getVariable('maven.xdoc.src')}"/>
---
The doc:jsl can't be used easily because you need to set lots of variable (using the
site wide stylesheet you have to recreate navigation, report lists, etc), which are
defined in the xdoc plugin context
the given patch add a new tag jslToSite to the xdoc plugin. This tag takes only a
parameter @srcdir, containing the input xml file, and sets the variable needed by
performJSL appropriately. This could be done directly in other plugins, but it's
better for other plugins not to be dependent from the internal implementation of the
xdoc task, so the appropriate position is in the xdoc plugin.
After applying the patch the xdoc:performJSL goal can also be removed and the
linkcheck plugin could be modified to use:
<doc:jslToSite srcdir="${maven.build.dir}/linkcheck/docs" />
instead of:
<j:set var="maven.xdoc.src" value="${maven.build.dir}/linkcheck/docs"/>
<attainGoal name="xdoc:performJSL"/>
---------------------------------------------------------------------
JIRA INFORMATION:
This message is automatically generated by JIRA.
If you think it was sent incorrectly contact one of the administrators:
http://jira.codehaus.org/secure/Administrators.jspa
If you want more information on JIRA, or have a bug to report see:
http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
