[jira] Commented: (MPXDOC-131) Allow velocity in user-documentation and expose pom

["Brett Porter (JIRA)" <ji...@codehaus.org>]

    [ http://jira.codehaus.org/browse/MPXDOC-131?page=comments#action_43927 ] 

Brett Porter commented on MPXDOC-131:
-------------------------------------

Ignacio, thanks for putting the effort into this, but for significant changes it does need to be discussed with the dev team first (thanks for approaching us now to do so).

I'm not in favour of this change as it is against the direction we are taking things. To introduce Jelly processing into the source files ties it to an XML format, but we support plain text, docbook, xdoc and more in Maven2 and may backport that to Maven1.

I'd like to discuss your use case on the list to see what alternatives there are.

> Allow velocity in user-documentation and expose pom
> ---------------------------------------------------
>
>          Key: MPXDOC-131
>          URL: http://jira.codehaus.org/browse/MPXDOC-131
>      Project: maven-xdoc-plugin
>         Type: Improvement
>     Reporter: Ignacio G. Mac Dowell
>     Assignee: Arnaud Heritier
>  Attachments: last.cumulative.patch, last.docs.patch, last.main.patch, last.test.patch, plugin.jelly.patch, plugin.properties.patch
>
>
> Currently, we can't directly use the pom or velocity in user-documentation. 
> JSL is applied to the user-docs as-is. I suggest having a property called maven.docs.src.templates (defaults to false) that when set to true treats user-docs as templates.
> Then, slightly modify the goal xdoc:jelly-transform.
> We need to var's:
> <j:set var="mergeUserDocs" value="${maven.docs.src.templates}"/>
> <j:set var="hasUserDocs" value="${maven.docs.src.available}"/>
> If both evaluate to true then velocity:merge the user docs before doing jsl. If they evaluate to false do as before.
> It would probably be nice to be able to use jelly as well as user-supplied docs.

-- 
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
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org