Maven Doxia

Add comments to sink API

Details

  • Type: Improvement Improvement
  • Status: Closed Closed
  • Priority: Major Major
  • Resolution: Fixed
  • Affects Version/s: 1.0-alpha-8
  • Fix Version/s: 1.1
  • Component/s: Sink API
  • Labels:
    None
  • Number of attachments :
    0

Description

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

Issue Links

is related to

New Feature - A new feature of the product, which has yet to be developed. DOXIA-135 Handle SSI in xdoc

  • Major - Major loss of function.
  • Closed - The issue is considered finished, the resolution is correct. Issues which are not closed can be reopened.

Improvement - An improvement or enhancement to an existing feature or task. DOXIA-155 AbstractXmlParser should recognize CDATA, entities and comments

  • Major - Major loss of function.
  • Closed - The issue is considered finished, the resolution is correct. Issues which are not closed can be reopened.

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Vincent Siveton added a comment -

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

Show
Vincent Siveton added a comment - I updated the javadoc so do you think that the doc for sink api is enough?
Hide
Permalink
Lukas Theussl added a comment -

What I meant is to add a method like

void comment( String text )

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

 
~~ a comment

into an xml comment:

 
<!-- a comment -->
Show
Lukas Theussl added a comment - What I meant is to add a method like void comment( String text ) to the Sink interface that allows you to translate eg an apt comment ~~ a comment into an xml comment: <!-- a comment -->
Hide
Permalink
Dennis Lundberg added a comment -

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

Show
Dennis Lundberg added a comment - This sounds like a good addition to the API. At least some of the generated formats supports comments, the others can just do nothing.
Hide
Permalink
Lukas Theussl added a comment -

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

Show
Lukas Theussl added a comment - Done in r583267. Comments are implemented in Xdoc, Xhtml and Docbook parsers and sinks, and in AptSink. AptParser is still to do.

People

  • Assignee:
    Lukas Theussl
    Reporter:
    Lukas Theussl
Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved: