jira.codehaus.org

  • Log In Access more options
    • Online Help
    • Keyboard Shortcuts
    • About JIRA
    • JIRA Credits
    • What?s New
  • Dashboards Access more options (Alt+d)
  • Projects Access more options (Alt+p)
  • Issues Access more options (Alt+i)
  • Maven Doxia
  • DOXIA-293

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

  • Log In
  • Views
    • XML
    • Word
    • Printable

Details

  • Type: New Feature New Feature
  • Status: Open Open
  • Priority: Minor Minor
  • Resolution: Unresolved
  • Affects Version/s: None
  • Fix Version/s: None
  • Component/s: None
  • Labels:
    None

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

Activity

Ascending order - Click to sort in descending order
  • All
  • Comments
  • Work Log
  • History
  • Activity
Hide
Permalink
Erik Putrycz added a comment - 03/Sep/07 3:05 PM

I totally second this idea. Has there been any progress done?

Show
Erik Putrycz added a comment - 03/Sep/07 3:05 PM I totally second this idea. Has there been any progress done?
Hide
Permalink
Robert Scholte added a comment - 07/Jan/12 8:42 AM

The main problem is that Doxia can't determine the position of these files. I've seen apidocs/,. api/, javadocs/.
Only the maven-site-plugin can pass this information to Doxia.
So this has to be fixed in both projects.

Show
Robert Scholte added a comment - 07/Jan/12 8:42 AM The main problem is that Doxia can't determine the position of these files. I've seen apidocs/,. api/, javadocs/. Only the maven-site-plugin can pass this information to Doxia. So this has to be fixed in both projects.

People

  • Assignee:
    Unassigned
    Reporter:
    Howard M. Lewis Ship
Vote (4)
Watch (3)

Dates

  • Created:
    22/Aug/06 1:30 PM
    Updated:
    07/Jan/12 8:42 AM
  • Atlassian JIRA (v5.0.4#731-sha1:3aa7374)
  • Report a problem
  • Powered by a free Atlassian JIRA open source license for Codehaus. Try JIRA - bug tracking software for your team.