[ 
https://issues.apache.org/jira/browse/DOXIA-762?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Konrad Windszus updated DOXIA-762:
----------------------------------
    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 {{```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.
 

  was:
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 {{```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.
 


> Clarify code highlighting for verbatim text in Markdown and APT
> ---------------------------------------------------------------
>
>                 Key: DOXIA-762
>                 URL: https://issues.apache.org/jira/browse/DOXIA-762
>             Project: Maven Doxia
>          Issue Type: Improvement
>          Components: Documentation
>            Reporter: Konrad Windszus
>            Priority: Major
>
> 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 
> {{```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.
>  



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

Reply via email to