[DOXIA-89] Doxia Macro syntax for xdoc sucks

• Type: Bug
• Status: Closed
• Priority: Major
• Resolution: Won't Fix
• Affects Version/s: 1.0-alpha-8
• Component/s: Core
• Assignee: Lukas Theussl
• Reporter: Henning Schmiedehausen
• Created: 04/Jan/07 02:13
• Updated: 30/Aug/23 16:48
• Resolved: 12/Jul/07 05:51

Description

In the xdoc parser, Doxia uses <macro id="foo" /> to reference the 'foo' macro. This is an unfortunate choice because it allows each macro on each xdoc page only once (id must be unique).

I'd suggest that this gets changed to e.g. macroName.

Also, some macros (most prominently the snippet macro) might require an 'id' parameter, which not only clashes with the notation above but also leaves the problem that this id might clash with another id and can not be used twice on a page.

I'd suggest that in a possible Doxia manual, the usage of an 'id' parameter is strongly discouraged.

For the snippet macro, I'd suggest changing 'id' to 'snippetId'.

Issue Links

• depends upon: DOXIA-123 Create an xdoc DTD or XSD for maven 2
• is superceded by: DOXIA-130 Macro renaming