slachiewicz opened a new pull request, #70:
URL: https://github.com/apache/maven-doxia-site/pull/70

   Part of apache/maven-doxia#876 (DOXIA-762), which points at this page: the 
APT reference documents `+--` versus `---` as boxed versus unboxed verbatim, 
and that is not what the two mean.
   
   `+--` marks the block as source code. It emits `verbatim` with the `source` 
decoration, which the XHTML5 Sink renders as `<pre><code>`; `---` emits a plain 
`verbatim`, rendered as `<pre>`. Verified against 
`Xhtml5BaseSink.verbatim(SinkEventAttributes)` in Doxia 2.1.x, which switches 
on the decoration and only opens the `CODE` element for `source`. Skins use 
that distinction to decide what to syntax highlight, so the choice between the 
two is not cosmetic.
   
   The "box" wording predates Doxia 2, where DOXIA-685 renamed the attribute 
from `BOXED` to `SOURCE` precisely because boxing was never what it meant.
   
   So this replaces the sentence with what the two forms actually do, adds a 
line of guidance on which to use, and notes the rename for anyone coming from 
the old wording. The sample document further down repeated the same claim 
twice, so it is corrected there too.
   
   Leaves the Markdown half of DOXIA-762 alone, since that belongs in the 
Markdown reference rather than here.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to