You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "Henning Schmiedehausen (JIRA)" <ji...@codehaus.org> on 2007/01/04 09:14:09 UTC

[jira] Created: (DOXIA-89) Doxia Macro syntax for xdoc sucks

Doxia Macro syntax for xdoc sucks
---------------------------------

                 Key: DOXIA-89
                 URL: http://jira.codehaus.org/browse/DOXIA-89
             Project: doxia
          Issue Type: Bug
          Components: Core
    Affects Versions: 1.0-alpha-8
            Reporter: Henning Schmiedehausen


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

-- 
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: (DOXIA-89) Doxia Macro syntax for xdoc sucks

Posted by "Jason van Zyl (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/DOXIA-89?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_97286 ] 

Jason van Zyl commented on DOXIA-89:
------------------------------------

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

> Doxia Macro syntax for xdoc sucks
> ---------------------------------
>
>                 Key: DOXIA-89
>                 URL: http://jira.codehaus.org/browse/DOXIA-89
>             Project: doxia
>          Issue Type: Bug
>          Components: Core
>    Affects Versions: 1.0-alpha-8
>            Reporter: Henning Schmiedehausen
>         Attachments: doxia-core.patch
>
>
> 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'.

-- 
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] Closed: (DOXIA-89) Doxia Macro syntax for xdoc sucks

Posted by "Lukas Theussl (JIRA)" <ji...@codehaus.org>.
     [ http://jira.codehaus.org/browse/DOXIA-89?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Lukas Theussl closed DOXIA-89.
------------------------------

      Assignee: Lukas Theussl
    Resolution: Won't Fix

> Doxia Macro syntax for xdoc sucks
> ---------------------------------
>
>                 Key: DOXIA-89
>                 URL: http://jira.codehaus.org/browse/DOXIA-89
>             Project: doxia
>          Issue Type: Bug
>          Components: Core
>    Affects Versions: 1.0-alpha-8
>            Reporter: Henning Schmiedehausen
>            Assignee: Lukas Theussl
>         Attachments: doxia-core.patch
>
>
> 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'.

-- 
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] Updated: (DOXIA-89) Doxia Macro syntax for xdoc sucks

Posted by "Henning Schmiedehausen (JIRA)" <ji...@codehaus.org>.
     [ http://jira.codehaus.org/browse/DOXIA-89?page=all ]

Henning Schmiedehausen updated DOXIA-89:
----------------------------------------

    Attachment: doxia-core.patch

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

> Doxia Macro syntax for xdoc sucks
> ---------------------------------
>
>                 Key: DOXIA-89
>                 URL: http://jira.codehaus.org/browse/DOXIA-89
>             Project: doxia
>          Issue Type: Bug
>          Components: Core
>    Affects Versions: 1.0-alpha-8
>            Reporter: Henning Schmiedehausen
>         Attachments: doxia-core.patch
>
>
> 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'.

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