[
https://jira.codehaus.org/browse/DOXIA-293?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Robert Scholte updated DOXIA-293:
---------------------------------
Description:
Some form of macro processing for APT format files would be nice.
I often find myself writing very verbose links form APT to documentation, i.e.
{noformat}
{{{apidocs/org/package/MyClass.html}MyClass}}
{noformat}
(Not that I ever get to use something that terse, more like
org.apache.tapestry.internal.ioc.RegistryImpl, etc.).
I would love some alternate link forms, maybe something like:
{noformat}
{{{api:MyClass}}}
{noformat}
or
{noformat}
{{{api:org.package.MyClass}}}
{noformat}
and let Maven build the links for me.
I also do some copious cross-linking of my documentation, so something akin to
the Forrest site: prefix would be great (a way to reference another document by
a logical id rather than a relative path).
was:
Some form of macro processing for APT format files would be nice.
I often find myself writing very verbose links form APT to documentation, i.e.
{{{apidocs/org/package/MyClass.html}MyClass}}
(Not that I ever get to use something that terse, more like
org.apache.tapestry.internal.ioc.RegistryImpl, etc.).
I would love some alternate link forms, maybe something like:
{{{api:MyClass}}}
or
{{{api:org.package.MyClass}}}
and let Maven build the links for me.
I also do some copious cross-linking of my documentation, so something akin to
the Forrest site: prefix would be great (a way to reference another document by
a logical id rather than a relative path).
> APT format needs some "macros" for common constructs such as links to JavaDoc
> -----------------------------------------------------------------------------
>
> Key: DOXIA-293
> URL: https://jira.codehaus.org/browse/DOXIA-293
> Project: Maven Doxia
> Issue Type: New Feature
> Reporter: Howard M. Lewis Ship
> Priority: Minor
>
> Some form of macro processing for APT format files would be nice.
> I often find myself writing very verbose links form APT to documentation, i.e.
> {noformat}
> {{{apidocs/org/package/MyClass.html}MyClass}}
> {noformat}
> (Not that I ever get to use something that terse, more like
> org.apache.tapestry.internal.ioc.RegistryImpl, etc.).
> I would love some alternate link forms, maybe something like:
> {noformat}
> {{{api:MyClass}}}
> {noformat}
> or
> {noformat}
> {{{api:org.package.MyClass}}}
> {noformat}
> and let Maven build the links for me.
> I also do some copious cross-linking of my documentation, so something akin
> to the Forrest site: prefix would be great (a way to reference another
> document by a logical id rather than a relative path).
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
