[DOXIA-712] Add validation capability to Sink API

• Type: Improvement
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Component/s: Core
• Assignee: Unassigned
• Reporter: Konrad Windszus
• Created: 23/Dec/23 19:42
• Updated: 24/Dec/23 11:27

Description

The Sink API comes with several limitations with regards to valid order of events/method calls and valid parametrization. Those are documented in the javadoc of the Sink interface but are complex to follow. This includes

• certain start events need to be followed by an according end event
• sectionTitle(int,SinkEventAttributes) needs to be directly preceded by section(int,SinkEventAttributes) with the same first argument.
• certain rules for sequence of events for table, list (numbered, non-numbered and definition) and figure
• validation of certain common parameters like level or SinkEventAttributes for valid values

As we encourage the direct usage of the Sink API for report mojos there should be a way for mojo authors to quickly crosscheck whether they used the Sink API in a correct way.

Issue Links

• is blocked by: DOXIA-711 Introduce SinkWrapper with factory
• relates to: DOXIA-699 Xhtml5Parser may emit sectionX() without sectionX_() when using both <hX> and <section>