Note for report authors

#1073 moves SinkEventAttributeSet into doxia-sink-api and deprecates org.apache.maven.doxia.sink.impl.SinkEventAttributeSet. Report plugins should keep the deprecated class for now: maven-reporting-exec gives reports the org.apache.maven.doxia.sink package from the site plugin, so under maven-site-plugin 3.22 and older the new class is missing and the report is skipped with a LinkageError. Sinks, parsers and the site renderer, which do not run inside a report, can switch now.

💥 Breaking changes

• Deprecate doxia-module-fml (#1102) @slachiewicz
• Stop marking external links with the externalLink class (#1099) @slachiewicz
• Move SinkEventAttributeSet to doxia-sink-api (#1073) @slachiewicz

🚨 Removed

• Drop the JXR reports from the reporting profile (#1103) @slachiewicz

⚠️ Deprecated

• Deprecate doxia-module-fml (#1102) @slachiewicz
• Add HtmlTag so the sink writers can leave javax.swing behind (#1097) @slachiewicz
• Deprecate the parser hooks that will be retyped to SinkEventAttributes (#1094) @slachiewicz
• Deprecate LineBreaker and take commons-io off the compile classpath (#1096) @slachiewicz
• Make the deprecation of AbstractParser#getBasedir visible to callers (#1082) @slachiewicz

🚀 New features and improvements

• Add HtmlTag so the sink writers can leave javax.swing behind (#1097) @slachiewicz
• Let APT macro blocks end at the last brace on the line (#1069) @slachiewicz
• Move SinkEventAttributeSet to doxia-sink-api (#1073) @slachiewicz
• Stop over-escaping text in the Markdown sink (#1070) @slachiewicz

🐛 Bug Fixes

• Render unknown Sink events as raw HTML in MarkdownSink (#1088) @slachiewicz
• Close self-closing non-void HTML tags in Markdown parsing (#1087) @slachiewicz
• Make SinkEventAttributeSet.hashCode ignore resolveParent (#1075) (#1091) @tanvir-ux
• Restore some methods from Doxia 1.4 (#1057) @kwin

📝 Documentation updates

• Restore the common wording on the download page (#1078) @slachiewicz
• Restore the plain form of the ASF licence header (#1077) @slachiewicz
• Document how Markdown code blocks reach the Sink (#1076) @slachiewicz

👻 Maintenance

• Drop the JXR reports from the reporting profile (#1103) @slachiewicz
• Drop unused hamcrest-core test dependency (#1100) @slachiewicz
• Deprecate LineBreaker and take commons-io off the compile classpath (#1096) @slachiewicz
• Drop the HTML.Attribute dependency from the parsers and sinks (#1095) @slachiewicz
• Drop the xsddoc schema reference generation (#1083) @slachiewicz
• Make the deprecation of AbstractParser#getBasedir visible to callers (#1082) @slachiewicz
• Drop the surefire exclusion for a test that no longer exists (#1081) @slachiewicz
• Restore the plain form of the ASF licence header (#1077) @slachiewicz
• Drop backslash escapes that Markdown does not need (#1071) @slachiewicz
• Use japicmp-maven-plugin to enforce binary backwards compatibility among (#1056) @kwin

🔧 Build

• Verify with Maven 4 too (#1104) @slachiewicz
• Doxia Site merged into Maven Site (#1085) @hboutemy

📦 Dependency updates

• Bump com.github.siom79.japicmp:japicmp-maven-plugin from 0.26.2 to 0.26.3 (#1112) @dependabot[bot]
• Bump org.apache.maven:maven-parent from 49 to 50 (#1105) @dependabot[bot]
• Drop unused hamcrest-core test dependency (#1100) @slachiewicz
• Bump com.github.siom79.japicmp:japicmp-maven-plugin from 0.26.1 to 0.26.2 (#1098) @dependabot[bot]
• Bump org.jsoup:jsoup from 1.23.1 to 1.23.2 (#1090) @dependabot[bot]
• Bump org.codehaus.plexus:plexus-testing from 2.1.0 to 2.2.0 (#1089) @dependabot[bot]
• Bump org.jsoup:jsoup from 1.22.2 to 1.23.1 (#1068) @dependabot[bot]
• Bump apache/maven-gh-actions-shared/.github/workflows/release-drafter.yml from 4 to 5 (#1065) @dependabot[bot]
• Bump apache/maven-gh-actions-shared/.github/workflows/stale.yml from 4 to 5 (#1063) @dependabot[bot]
• Bump apache/maven-gh-actions-shared/.github/workflows/pr-automation.yml from 4 to 5 (#1064) @dependabot[bot]
• Bump apache/maven-gh-actions-shared/.github/workflows/maven-verify.yml from 4 to 5 (#1066) @dependabot[bot]
• Bump org.apache.maven:maven-parent from 48 to 49 (#1062) @dependabot[bot]
• Bump com.github.siom79.japicmp:japicmp-maven-plugin from 0.26.0 to 0.26.1 (#1061) @dependabot[bot]
• Bump com.github.siom79.japicmp:japicmp-maven-plugin from 0.25.7 to 0.26.0 (#1060) @dependabot[bot]
• Bump com.github.siom79.japicmp:japicmp-maven-plugin from 0.25.6 to 0.25.7 (#1059) @dependabot[bot]
• Bump org.apache.maven:maven-parent from 47 to 48 (#1058) @dependabot[bot]
• Bump commons-io:commons-io from 2.21.0 to 2.22.0 (#1055) @dependabot[bot]
• Bump org.jsoup:jsoup from 1.22.1 to 1.22.2 (#1053) @dependabot[bot]
• Bump org.apache.ant:ant-apache-regexp from 1.10.16 to 1.10.17 (#1051) @dependabot[bot]
• Bump org.apache.ant:ant-apache-regexp from 1.10.15 to 1.10.16 (#1049) @dependabot[bot]

🚀 New features and improvements

• Distinguish between linebreaks for formatting markup and linebreaks in (#1039) @kwin
• Return SinkEventAttributes instead of super class MutableAttributeSet (#1036) @kwin
• Optionally leave fragments of internal links untouched (#1032) @kwin
• Support strikethrough for Markdown sink (#1033) @kwin
• [DOXIA-770] - Only escape when necessary (#255) @kwin
• [DOXIA-760] - Clarify table justification semantics and introduce new (#248) @kwin
• [DOXIA-756] - Allow to customize macro execution (#244) @kwin
• [DOXIA-759] - Support anchors in MarkdownSink (#247) @kwin

🐛 Bug Fixes

• MarkdownSink: Fix verbatim inside table cell (#1045) @kwin
• Make sure to emit metadata prior everything else (#1042) @kwin
• Convert all globally available attributes to HTML5 compliant ones (#1038) @kwin
• Html5BaseSink: Convert non-compliant HTML5 attributes to compliant ones (#1035) @kwin
• Support "name" attribute in "a" element still in XHTML5 (#1031) @kwin
• Never emit Markdown inside HTML context (#1016) @kwin
• Use JSoup to convert HTML to XHTML after parsing with Flexmark (#1001) @kwin
• [DOXIA-764] - Strip leading newline after (#254) @kwin
• [DOXIA-763] - Distinguish between verbatim source and non-source in (#250) @kwin
• [DOXIA-758] - Consider emitComments flag in MarkdownSink (#246) @kwin
• [DOXIA-757] - Don't strip leading "#" from link names (#245) @kwin
• [DOXIA-753] - Do not end lists with a blank line (#241) @kwin
• [DOXIA-751] - Linked inline code must be emitted in right order (#240) @kwin
• [DOXIA-749] - Correctly indent and separate blocks inside list items (#238) @kwin
• [DOXIA-750] - Properly apply inlines inside HTML blocks (#239) @kwin
• [DOXIA-747] - Emit headings at beginning of line for Markdown (#235) @kwin

📝 Documentation updates

• Site: Convert APT to Markdown (#1046) @kwin
• Improve documentation of supported extensions (#1000) @kwin
• (doc) Fix missing references in JavaDocs (#259) @jevanlingen

👻 Maintenance

• Cleanup tests (#1022) @slachiewicz
• JUnit Jupiter best practices (#1013) @slachiewicz
• Remove commons-lang3 and commons-text dependencies (#1009) @slachiewicz
• feat: enable prevent branch protection rules (#997) @sebtiem
• Cleanup pom, remove redundant dependencies (#994) @slachiewicz
• Drop almost all usages of plexus-utils (#993) @slachiewicz
• Remove not used and outdated clirr-maven-plugin (#992) @slachiewicz
• Enable Github Issues (#267) @Bukama
• [DOXIA-772] - Deprecate Sink.sectionTitle() and sectionTitle_() (#256) @kwin
• [DOXIA-754] - Clarify method order for nested lists (#243) @kwin

📦 Dependency updates

• Bump org.jetbrains:annotations from 26.0.2-1 to 26.1.0 (#1037) @dependabot[bot]
• Bump org.codehaus.plexus:plexus-testing from 2.0.2 to 2.1.0 (#1024) @dependabot[bot]
• Update to parent 47 and site 2.0.0 (#1028) @Bukama
• Bump org.jsoup:jsoup from 1.21.2 to 1.22.1 (#1023) @dependabot[bot]
• Bump org.codehaus.plexus:plexus-testing from 2.0.1 to 2.0.2 (#1021) @dependabot[bot]
• Bump commons-io:commons-io from 2.20.0 to 2.21.0 (#1019) @dependabot[bot]
• Remove commons-lang3 and commons-text dependencies (#1009) @slachiewicz
• Bump org.codehaus.plexus:plexus-testing from 1.7.0 to 2.0.1 (#1007) @dependabot[bot]
• Bump org.codehaus.plexus:plexus-testing from 1.6.0 to 1.7.0 (#1004) @dependabot[bot]
• Bump org.apache.commons:commons-lang3 from 3.18.0 to 3.19.0 (#1002) @dependabot[bot]
• Bump org.jetbrains:annotations from 26.0.2 to 26.0.2-1 (#998) @dependabot[bot]
• Bump org.codehaus.plexus:plexus-testing from 1.5.0 to 1.6.0 (#995) @dependabot[bot]
• Upgrade parent pom to 45 (#270) @slachiewicz
• Drop almost all usages of plexus-utils (#993) @slachiewicz
• Bump org.apache.commons:commons-text from 1.13.1 to 1.14.0 (#990) @dependabot[bot]
• Bump commons-io:commons-io from 2.19.0 to 2.20.0 (#988) @dependabot[bot]
• Bump org.junit:junit-bom from 5.13.3 to 5.13.4 (#989) @dependabot[bot]
• Bump xmlunitVersion from 2.10.2 to 2.10.3 (#271) @dependabot[bot]
• Bump org.junit:junit-bom from 5.13.1 to 5.13.3 (#274) @dependabot[bot]
• Bump org.apache.commons:commons-lang3 from 3.17.0 to 3.18.0 (#275) @dependabot[bot]
• Bump org.junit:junit-bom from 5.13.0 to 5.13.1 (#269) @dependabot[bot]
• Bump org.codehaus.plexus:plexus-testing from 1.4.0 to 1.5.0 (#262) @dependabot[bot]
• Bump xmlunitVersion from 2.10.0 to 2.10.2 (#266) @dependabot[bot]
• Bump org.junit:junit-bom from 5.12.2 to 5.13.0 (#268) @dependabot[bot]
• Bump commons-io:commons-io from 2.17.0 to 2.19.0 (#265) @dependabot[bot]
• Bump org.apache.commons:commons-text from 1.12.0 to 1.13.1 (#263) @dependabot[bot]
• Bump org.junit:junit-bom from 5.12.1 to 5.12.2 (#264) @dependabot[bot]
• Bump org.junit:junit-bom from 5.11.4 to 5.12.1 (#260) @dependabot[bot]
• Bump org.jetbrains:annotations from 26.0.1 to 26.0.2 (#257) @[dependabot[bot]](https://github.com/apps/de...

What's Changed

• [DOXIA-630] Remove all deprecated modules by @michael-o in #79
• [DOXIA-632] Remove remaining deprecated code by @michael-o in #81
• [DOXIA-633] Drop and replace usage of HttpComponents in Core by @michael-o in #84
• Dependency cleanup by @michael-o in #85
• [DOXIA-638] Replace Plexus Container Default with Sisu Plexus Shim by @michael-o in #86
• [DOXIA-645] Clean up exceptions by @michael-o in #94
• [DOXIA-650] Make MarkdownParser to be a text parser with text markup by @michael-o in #100
• [DOXIA-652] Drop build-info.properties in favor of default pom.proper… by @michael-o in #102
• [DOXIA-651] Upgrade Flexmark to 0.50.50 by @michael-o in #101
• [DOXIA-662] Generate unique ids by @kwin in #106
• [DOXIA-663] Remove deprecated XHTML module by @michael-o in #107
• [DOXIA-664] Upgrade Flexmark to 0.62.2 by @michael-o in #108
• [DOXIA-666] Remove code duplication Xhtml5Sink by @michael-o in #110
• [DOXIA-665] Add anchors around FML parts by @michael-o in #111
• [DOXIA-599] Replace element's name attribute with id attribute by @michael-o in #112
• Bump junit-jupiter-engine from 5.8.2 to 5.9.0 by @dependabot[bot] in #109
• Bump hamcrest-core from 1.3 to 2.2 by @dependabot[bot] in #90
• [DOXIA-676] Remove all obsolete elements in HTML5 and add new ones by @michael-o in #124
• [DOXIA-671] Double quotes contained in markdown page are removed in H… by @michael-o in #123
• [DOXIA-670] Drop dead XdocSink#link(String, String) method by @michael-o in #116
• [DOXIA-668] Remove all obsolete attributes in HTML5 by @michael-o in #114
• [DOXIA-678] Add missing elements in Xhtml5BaseParser by @michael-o in #126
• [DOXIA-679] Introduce Sink#tableRows(void) method by @michael-o in #127
• [DOXIA-680] Don't wrap elements in anchors by @michael-o in #130
• [DOXIA-617] support yaml metadata by @hboutemy in #132
• [DOXIA-687] Introduce Sink#verbatim(void) method by @michael-o in #140
• [DOXIA-685] Replace SinkEventAttributes#BOXED and clearly separate between regular verbatim and verbatim source (code) by @michael-o in #135
• [DOXIA-691] emit multiple authors in separate tags by @kwin in #142
• [DOXIA-690] Improved support of metadata (both YAML front matter and by @kwin in #141
• [DOXIA-692] Fix escaping of special characters by @kwin in #143
• Add test for parsing font styles including escape characters by @kwin in #144
• [DOXIA-693] Fix prefix for ordered list item prefixes by @kwin in #145
• Migrate remaining component from Plexus to JSR 330 annotations by @kwin in #147
• Bump commons-text from 1.9 to 1.10.0 by @dependabot[bot] in #122
• Bugfix/newlines by @kwin in #146
• Bump apache/maven-gh-actions-shared from 2 to 3 by @dependabot[bot] in #150
• [DOXIA-700] Streamline, update and simplify Doxia ID generation by @michael-o in #155
• [MNG-6825] Replace Plexus IOUtil with IOUtils from commons-io by @timtebeek in #156
• [MNG-6825] Replace Plexus StringUtils and FileUtils by @timtebeek in #158
• TODO was done by @elharo in #159
• [DOXIA-698] Make Sink implement AutoCloseable by @elharo in #160
• [MNG-6829] Replace any StringUtils#isEmpty(String) and #isNotEmpty(String) by @timtebeek in #167
• Bump junitVersion from 5.9.2 to 5.10.0 by @dependabot[bot] in #173
• Bump annotations from 15.0 to 24.0.1 by @dependabot[bot] in #153
• [DOXIA-706] Support SinkEventAttributes in Sink.text(...) by @kwin in #175
• Add test for preserving (and not adding additional) URL encoding by @kwin in #176
• Bump org.apache.ant:ant-apache-regexp from 1.10.13 to 1.10.14 by @dependabot[bot] in #174
• [DOXIA-709] Cleanup overloaded Doxia 1.0 methods by @kwin in #182
• [DOXIA-711] Introduce SinkWrapper and according SinkWrapperFactory by @kwin in #184
• [DOXIA-699] Correctly generate sections for headings by @kwin in #162
• [DOXIA-715] Consider attributes for text(...) in AptSink and by @kwin in #186
• [DOXIA-714] Emit proper markdown for table alignment and figures by @kwin in #185
• [DOXIA-716] Update and unify XMLReader creation and configuration by @michael-o in #187
• [DOXIA-717] Update org.codehaus.plexus:plexus-testing to 1.3.0 by @slachiewicz in #190
• [DOXIA-721] Bump JUnit to 5.10.1 by @slachiewicz in #191
• [DOXIA-722] Optionally create anchors for index entries (used in TOC macro) by @kwin in #180
• Bump org.jetbrains:annotations from 24.0.1 to 24.1.0 by @dependabot[bot] in #179
• [DOXIA-695] Support heading level 6 by @kwin in #193
• [DOXIA-724] Fix order of sink wrappers in pipeline by @kwin in #195
• [DOXIA-726] Incorrect escaping of <,>,",' and & by @kwin in #196
• Bump org.apache.commons:commons-text from 1.10.0 to 1.11.0 by @dependabot[bot] in #181
• [DOXIA-727] Fix escaping inside code spans by @kwin in #197
• [DOXIA-723] Expose document location in Sink by @kwin in #194
• Clarify that it's OK to use spaces for things other than indentation by @elharo in #148
• Bump org.junit:junit-bom from 5.10.1 to 5.10.2 by @dependabot[bot] in #199
• [DOXIA-728] Support blockquotes in MarkdownSink by @kwin in #198
• Bump apache/maven-gh-actions-shared from 3 to 4 by @dependabot[bot] in #201
• [DOXIA-732] Don't fail for duplicate anchor names by @kwin in #203
• [DOXIA-731] Simplify HTML markup emitted from Sink.verbatim by @kwin in #202
• [DOXIA-734] Restore handling of XHTML 1.0 obsolete attributes by @kwin in #204
• [DOXIA-735] Bump commons-io:commons-io from 2.15.1 to 2.16.0 by @dependabot[bot] in #205
• DOXIA-723 correctly expose document location through BufferingSinkProxy by @kwin in #206
• Bump commons-io:commons-io from 2.16.0 to 2.16.1 by @dependabot[bot] in #207
• Fix reporting before release by @michael-o in #208
• Bump org.apache.commons:commons-text from 1.11.0 to 1.12.0 by @dependabot[bot] in #211
• Bump xmlunitVersion from 2.9.1 to 2.10.0 by @dependabot[bot] in #212
• [DOXIA-737] [REGRESSION] Making EmitAnchorsForIndexableEntries by def… by @michael-o in #214
• Bump org.junit:junit-bom from 5.10.2 to 5.10.3 by @dependabot[bot] in #216
• Bump org.codehaus.plexus:plexus-testing from 1.3.0 to 1.4.0 by @dependabot[bot] in #217
• Bump org.apache.maven:maven-parent from 42 to 43 by @dependabot[bot] in #218
• Bump org.hamcrest:hamcrest-core from 2.2 to 3.0 by @dependabot[bot] in #220
• Bump org.junit:junit-bom from 5.10.3 to 5.11.0 by @dependabot[bot] in #222
• Upgrade Plexus Utils and XML by @michael-o in #226
• Bump org.apache.ant:ant-apache-regexp from 1.10.14 to 1.10.15 by @dependabot[bot] in https://github.com/apa...

What's Changed

• [DOXIA-409] Upgrade to FOP 2.2 by @slachiewicz in #7
• [DOXIA-497] Fix rendering links and paragraphs inside tables by @slachiewicz in #13
• [DOXIA-584] Rewrite .md and .markdown links to .html by @jmones in #14
• DOXIA-576 Upgrade HttpComponents: httpclient to 4.5.8 and httpcore to 4.4.11 by @slachiewicz in #12
• [DOXIA-570] Escape links to xml based figureGraphics image elements by @slachiewicz in #9
• [SECURITY] Use HTTPS to resolve dependencies in Maven Build by @JLLeitschuh in #18
• [MNGSITE-393] remove old Maven 1 and 2 info by @elharo in #20
• Bump plexus-utils from 3.1.0 to 3.3.0 by @dependabot in #29
• Bump xalan from 2.7.1 to 2.7.2 by @dependabot in #30
• Bump plexus-component-annotations from 1.7.1 to 2.1.0 by @dependabot in #27
• Bump xmlunit-core from 2.6.3 to 2.7.0 by @dependabot in #26
• Bump xmlunit-matchers from 2.6.3 to 2.7.0 by @dependabot in #31
• Bump fop from 2.4 to 2.5 by @dependabot in #28
• Bump plexus-container-default from 1.7.1 to 2.1.0 by @dependabot in #25
• Bump httpclient from 4.5.8 to 4.5.12 by @dependabot in #23
• Bump httpcore from 4.4.11 to 4.4.13 by @dependabot in #22
• [DOXIA-612] update commons-lang to 3.8.1 by @elharo in #34
• [DOXIA-610] Drop dependency to outdated Log4j by @slachiewicz in #37
• Bump httpclient from 4.5.12 to 4.5.13 by @dependabot in #40
• Bump ant-apache-regexp from 1.7.1 to 1.10.9 by @dependabot in #39
• Bump httpcore from 4.4.13 to 4.4.14 by @dependabot in #46
• Fix Java 7 compatibility that was broken with DOXIA-616 by @bertysentry in #54
• [DOXIA-618] import tests from maven-site-plugin by @bertysentry in #52
• Bump fop from 2.5 to 2.6 by @dependabot in #55
• Bump junit from 4.13.1 to 4.13.2 by @dependabot in #57
• [DOXIA-609] Fixed crosslinks starting with a dot in markdown files by @plan3d in #59
• remove unused code by @elharo in #64
• replace deprecated class from commons-lang by @elharo in #65
• fill in some generic types by @elharo in #66
• Bump ant-apache-regexp from 1.10.10 to 1.10.11 by @dependabot in #68
• Shared GitHub Actions by @slawekjaranowski in #75

New Contributors

• @slachiewicz made their first contribution in #7
• @jmones made their first contribution in #14
• @JLLeitschuh made their first contribution in #18
• @elharo made their first contribution in #20
• @dependabot made their first contribution in #29
• @bertysentry made their first contribution in #54
• @plan3d made their first contribution in #59
• @slawekjaranowski made their first contribution in #75

Full Changelog: https://github.com/apache/maven-doxia/commits/doxia-1.11.1