You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "Lukas Theussl (JIRA)" <ji...@codehaus.org> on 2007/07/18 08:38:13 UTC

[jira] Created: (DOXIA-137) Add comments to sink API

Add comments to sink API
------------------------

                 Key: DOXIA-137
                 URL: http://jira.codehaus.org/browse/DOXIA-137
             Project: doxia
          Issue Type: Improvement
          Components: Sink API
    Affects Versions: 1.0-alpha-8
            Reporter: Lukas Theussl
             Fix For: 1.0-beta-1


Comments are often an important part of source documents, they should be preserved by doxia transformations.

-- 
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-137) Add comments to sink API

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

Lukas Theussl closed DOXIA-137.
-------------------------------

      Assignee: Lukas Theussl
    Resolution: Fixed

Done in r583267. Comments are implemented in Xdoc, Xhtml and Docbook parsers and sinks, and in AptSink. AptParser is still to do. 

> Add comments to sink API
> ------------------------
>
>                 Key: DOXIA-137
>                 URL: http://jira.codehaus.org/browse/DOXIA-137
>             Project: Maven Doxia
>          Issue Type: Improvement
>          Components: Sink API
>    Affects Versions: 1.0-alpha-8
>            Reporter: Lukas Theussl
>            Assignee: Lukas Theussl
>             Fix For: 1.0-beta-1
>
>
> Comments are often an important part of source documents, they should be preserved by doxia transformations.

-- 
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-137) Add comments to sink API

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

Lukas Theussl commented on DOXIA-137:
-------------------------------------

What I meant is to add a method like

{code}
void comment( String text )
{code}

to the Sink interface that allows you to translate eg an apt comment

 {noformat} 
~~ a comment
 {noformat} 

into an xml comment:

{noformat} 
<!-- a comment -->
 {noformat} 

> Add comments to sink API
> ------------------------
>
>                 Key: DOXIA-137
>                 URL: http://jira.codehaus.org/browse/DOXIA-137
>             Project: Maven Doxia
>          Issue Type: Improvement
>          Components: Sink API
>    Affects Versions: 1.0-alpha-8
>            Reporter: Lukas Theussl
>             Fix For: 1.0-beta-1
>
>
> Comments are often an important part of source documents, they should be preserved by doxia transformations.

-- 
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-137) Add comments to sink API

Posted by "Vincent Siveton (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/DOXIA-137?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_103326 ] 

Vincent Siveton commented on DOXIA-137:
---------------------------------------

I updated the javadoc so do you think that the doc for sink api is enough? 

> Add comments to sink API
> ------------------------
>
>                 Key: DOXIA-137
>                 URL: http://jira.codehaus.org/browse/DOXIA-137
>             Project: Maven Doxia
>          Issue Type: Improvement
>          Components: Sink API
>    Affects Versions: 1.0-alpha-8
>            Reporter: Lukas Theussl
>             Fix For: 1.0-beta-1
>
>
> Comments are often an important part of source documents, they should be preserved by doxia transformations.

-- 
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-137) Add comments to sink API

Posted by "Dennis Lundberg (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/DOXIA-137?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_103947 ] 

Dennis Lundberg commented on DOXIA-137:
---------------------------------------

This sounds like a good addition to the API. At least some of the generated formats supports comments, the others can just do nothing.

> Add comments to sink API
> ------------------------
>
>                 Key: DOXIA-137
>                 URL: http://jira.codehaus.org/browse/DOXIA-137
>             Project: Maven Doxia
>          Issue Type: Improvement
>          Components: Sink API
>    Affects Versions: 1.0-alpha-8
>            Reporter: Lukas Theussl
>             Fix For: 1.0-beta-1
>
>
> Comments are often an important part of source documents, they should be preserved by doxia transformations.

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