[DOXIA-762] Clarify code highlighting for verbatim text in Markdown and APT

• Type: Improvement
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Component/s: Documentation
• Assignee: Unassigned
• Reporter: Konrad Windszus
• Created: 5 days ago 10:03
• Updated: 5 days ago 18:01

Description

Currently it is undocumented how to emit Sink.verbatim(SinkEventAttributes) blocks with/without the SinkEventAttributeSet.SOURCE argument.

• For APT it is verbatim with source if using delimiter +-, verbatim without if using delimiter --. However in https://maven.apache.org/doxia/references/apt-format.html#verbatim-text only boxed and unboxed verbatim is described.
• For MD it is verbatim with source if fenced code with info string, e.g. ```java and verbatim without source if fenced code without info string (```). That is currently not mentioned at all in https://maven.apache.org/doxia/modules/index.html#Markdown nor in https://maven.apache.org/doxia/doxia/doxia-modules/doxia-module-markdown/index.html.

Issue Links

• is related to: DOXIA-763 MarkdownSink: Distinguish between verbatim with source attribute and without
• relates to: DOXIA-685 Replace SinkEventAttributes#BOXED with #SOURCE to clearly separate between regular verbatim and verbatim source (code)