[jira] [Updated] (MPLUGIN-513) Closing curly brace in code block rendered incorrectly

[Alexander Kriegisch (Jira)]

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

Alexander Kriegisch updated MPLUGIN-513:
----------------------------------------
    Description: 
In my plugin parameter javadoc, I use something like this:

{code:java}
   * <pre>{@code
   * <javaAgents>
   *   <agent>
   *     <groupId>dummy</groupId>
   *     <artifactId>dummy</artifactId>
   *     <agentPath>${project.basedir}/lib/agent.jar</agentClass>
   *   </agent>
   * </javaAgents>
   * }</pre>
{code}

This "<pre>" and "\{@code ...}" combination is used, if we want to avoid having 
to escape XML tags and preserve line breaks at the same time. This works fine 
when generating javadocs, but in a Maven plugin goal description, the result 
looks like this:

 !image-2024-03-18-17-00-11-575.png! 

It looks correct on the Maven site, if instead of "${project.basedir}" I write 
"${project.basedir&amp;#125;", but then javadoc generation fails with an error.

This ought to be fixed in Maven Site Plugin. It might be subtle and somewhat of 
an advanced edge case, but the rendered HTML for the plugin description should 
look correctly, just as it does for javadocs.

  was:
In my plugin parameter javadoc, I use something like this:

{code:java}
   * <pre>{@code
   * <javaAgents>
   *   <agent>
   *     <groupId>dummy</groupId>
   *     <artifactId>dummy</artifactId>
   *     <agentPath>${project.basedir}/lib/agent.jar</agentClass>
   *   </agent>
   * </javaAgents>
   * }</pre>
{code}

This "<pre>" and "\{@code ...}" combination is used, if we want to avoid having 
to escape XML tags and preserve line breaks at the same time. This works fine 
when generating javadocs, but in a Maven plugin goal description, the result 
looks like this:

 !image-2024-03-18-17-00-11-575.png! 

It looks correct on the Maven site, if instead of {{${project.basedir}}} I 
write "${project.basedir&amp;#125;", but then javadoc generation fails with an 
error.

This ought to be fixed in Maven Site Plugin. It might be subtle and somewhat of 
an advanced edge case, but the rendered HTML for the plugin description should 
look correctly, just as it does for javadocs.


> Closing curly brace in code block rendered incorrectly
> ------------------------------------------------------
>
>                 Key: MPLUGIN-513
>                 URL: https://issues.apache.org/jira/browse/MPLUGIN-513
>             Project: Maven Plugin Tools
>          Issue Type: Bug
>    Affects Versions: 3.11.0
>            Reporter: Alexander Kriegisch
>            Priority: Major
>         Attachments: image-2024-03-18-17-00-11-575.png
>
>
> In my plugin parameter javadoc, I use something like this:
> {code:java}
>    * <pre>{@code
>    * <javaAgents>
>    *   <agent>
>    *     <groupId>dummy</groupId>
>    *     <artifactId>dummy</artifactId>
>    *     <agentPath>${project.basedir}/lib/agent.jar</agentClass>
>    *   </agent>
>    * </javaAgents>
>    * }</pre>
> {code}
> This "<pre>" and "\{@code ...}" combination is used, if we want to avoid 
> having to escape XML tags and preserve line breaks at the same time. This 
> works fine when generating javadocs, but in a Maven plugin goal description, 
> the result looks like this:
>  !image-2024-03-18-17-00-11-575.png! 
> It looks correct on the Maven site, if instead of "${project.basedir}" I 
> write "${project.basedir&amp;#125;", but then javadoc generation fails with 
> an error.
> This ought to be fixed in Maven Site Plugin. It might be subtle and somewhat 
> of an advanced edge case, but the rendered HTML for the plugin description 
> should look correctly, just as it does for javadocs.



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