[DOXIA-293] APT format needs some "macros" for common constructs such as links to JavaDoc

• Type: New Feature
• Status: Closed
• Priority: Minor
• Resolution: Auto Closed
• Component/s: Module - Apt
• Assignee: Unassigned
• Reporter: Howard Lewis Ship
• Created: 22/Aug/06 13:30
• Updated: 16/Mar/18 22:40
• Resolved: 16/Mar/18 22:40

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.

{{{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).

Issue Links

• relates to: DOXIA-397 Cannot link to javadoc methods