Maven Doxia

Doxia Macro syntax for xdoc sucks

Details

  • Type: Bug Bug
  • Status: Closed Closed
  • Priority: Major Major
  • Resolution: Won't Fix
  • Affects Version/s: 1.0-alpha-8
  • Fix Version/s: None
  • Component/s: Core
  • Labels:
    None
  • Number of attachments :
    1

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

Activity

Hide
Henning Schmiedehausen added a comment -

This patch changes the id in the xdoc parser to macroId and the id in the snippet macro to snippetId.

Show
Henning Schmiedehausen added a comment - This patch changes the id in the xdoc parser to macroId and the id in the snippet macro to snippetId.
Hide
Jason van Zyl added a comment -

If this incorporate using the current notation that would be fine.

Show
Jason van Zyl added a comment - If this incorporate using the current notation that would be fine.

People

Vote (0)
Watch (1)

Dates

  • Created:
    Updated:
    Resolved: