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

          Lukas Theussl made changes -
          Field Original Value New Value
          Component/s plugin [ 11254 ]
          Project maven-site-plugin [ 10331 ] Maven 2.x Site Plugin [ 11146 ]
          Workflow jira [ 60704 ] Maven New [ 60706 ]
          Key MPSITE-54 MSITE-178
          Dennis Lundberg made changes -
          Key MSITE-178 DOXIA-293
          Project Maven 2.x Site Plugin [ 11146 ] Maven Doxia [ 10780 ]
          Herve Boutemy made changes -
          Link This issue relates to DOXIA-397 [ DOXIA-397 ]
          Robert Scholte made changes -
          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).
          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).
          Robert Scholte made changes -
          Component/s Module - Apt [ 12814 ]

            People

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

              Dates

              • Created:
                Updated: