You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "Howard M. Lewis Ship (JIRA)" <ji...@codehaus.org> on 2006/08/22 20:31:48 UTC
[jira] Created: (MPSITE-54) APT format needs some "macros" for
common constructs such as links to JavaDoc
APT format needs some "macros" for common constructs such as links to JavaDoc
-----------------------------------------------------------------------------
Key: MPSITE-54
URL: http://jira.codehaus.org/browse/MPSITE-54
Project: maven-site-plugin
Issue Type: New Feature
Components: plugin
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.
{{{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).
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] (DOXIA-293) APT format needs some "macros" for common
constructs such as links to JavaDoc
Posted by "Robert Scholte (JIRA)" <ji...@codehaus.org>.
[ https://jira.codehaus.org/browse/DOXIA-293?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=287702#comment-287702 ]
Robert Scholte commented on DOXIA-293:
--------------------------------------
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.
> 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.
> {{{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).
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://jira.codehaus.org/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Moved: (DOXIA-293) APT format needs some "macros" for common
constructs such as links to JavaDoc
Posted by "Dennis Lundberg (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/DOXIA-293?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Dennis Lundberg moved MSITE-178 to DOXIA-293:
---------------------------------------------
Key: DOXIA-293 (was: MSITE-178)
Project: Maven Doxia (was: Maven 2.x Site Plugin)
> APT format needs some "macros" for common constructs such as links to JavaDoc
> -----------------------------------------------------------------------------
>
> Key: DOXIA-293
> URL: http://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.
> {{{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).
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Commented: (MSITE-178) APT format needs some "macros" for
common constructs such as links to JavaDoc
Posted by "Erik Putrycz (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MSITE-178?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_106319 ]
Erik Putrycz commented on MSITE-178:
------------------------------------
I totally second this idea. Has there been any progress done?
> APT format needs some "macros" for common constructs such as links to JavaDoc
> -----------------------------------------------------------------------------
>
> Key: MSITE-178
> URL: http://jira.codehaus.org/browse/MSITE-178
> Project: Maven 2.x Site Plugin
> 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.
> {{{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).
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Moved: (MSITE-178) APT format needs some "macros" for common
constructs such as links to JavaDoc
Posted by "Lukas Theussl (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MSITE-178?page=all ]
Lukas Theussl moved MPSITE-54 to MSITE-178:
-------------------------------------------
Component/s: (was: plugin)
Workflow: Maven New (was: jira)
Key: MSITE-178 (was: MPSITE-54)
Project: Maven 2.x Site Plugin (was: maven-site-plugin)
> APT format needs some "macros" for common constructs such as links to JavaDoc
> -----------------------------------------------------------------------------
>
> Key: MSITE-178
> URL: http://jira.codehaus.org/browse/MSITE-178
> Project: Maven 2.x Site Plugin
> 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.
> {{{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).
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira