Description
If the idea with extensibility and interchangeable input/output formats should be more than a nice dream, the Sink API needs a thorough specification (e.g. by means of more javadoc at Sink) because that's were everything meets. It should define
- what rules parsers must obey when generating events and
- what events a sink needs to be prepared to handle
Currently, all of this is left to assumptions. Some example issues that need to be clarified:
- What characters may constitute an anchor reported by anchor()? Arbitrary, ASCII-only, ...?
- What format applies to the name parameter of link()? How are internal and external links to be distinguished (
DOXIA-208)? - What character chunks are reported by text()? Longest consecutive sequence, line-by-line, arbitrary, ... (
DOXIA-222)? - What exactly is a figure's source as reported by figureGraphics()? Relative/absolute path, relative to which directory? What about file extensions (
DOXIA-99)? - What order of events is "reasonable" (
DOXIA-132)? May parsers report table body and caption in a specific or arbitrary order? Must the document head always be reported before body or may it be postponed? - Is closing a sink twice acceptable or an error?
Attachments
Issue Links
- relates to
-
DOXIA-266 Section titles are not becoming anchors.
-
- Closed
-