Maven Doxia
  1. Maven Doxia
  2. DOXIA-293

APT format needs some "macros" for common constructs such as links to JavaDoc

    Details

    • Type: New Feature New Feature
    • Status: Open Open
    • Priority: Minor Minor
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: Module - Apt
    • Labels:
      None
    • Number of attachments :
      0

      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

          Activity

          No work has yet been logged on this issue.

            People

            • Assignee:
              Unassigned
              Reporter:
              Howard M. Lewis Ship
            • Votes:
              6 Vote for this issue
              Watchers:
              5 Start watching this issue

              Dates

              • Created:
                Updated: