You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "slachiewicz (via GitHub)" <gi...@apache.org> on 2026/08/05 22:14:40 UTC
[I] Migrate Maven site documentation from APT to Markdown [maven-doxia-converter]
slachiewicz opened a new issue, #139:
URL: https://github.com/apache/maven-doxia-converter/issues/139
Site documentation across the Maven repositories is still largely written in APT, a format only Doxia understands and which few contributors can read or edit comfortably. Markdown is already supported by `maven-site-plugin` out of the box, several repositories have been partly migrated already, and `doxia-converter` can do most of the mechanical work.
This issue tracks converting the remaining APT site documents to Markdown across the Maven repositories, the fixes to `doxia-converter` and Doxia that the conversion turned up, and the repair of pages that were migrated earlier and are rendering incorrectly today.
## Scope
Counting only real site documents (under `src/site/`, excluding `src/it` and `src/test` fixtures, which are inputs to the APT parser's own tests and must stay APT):
| | files |
|---|---|
| APT site documents at the start | 729 |
| converted so far | 151 |
| remaining, in scope | 458 across 29 repositories |
| remaining, out of scope | 120 |
Out of scope: the archived SVN sandbox, `codehaus-plexus.github.io` (a different community), and the Maven 3 maintenance branches, which are probably not worth churning.
Two facts make the mechanical part cheaper than it looks:
* `maven-site-plugin` already declares `doxia-module-markdown`, so no POM change is needed to add a Markdown page.
* The site renderer strips `.vm` generically, so `foo.apt.vm` becomes `foo.md.vm` and Velocity keeps working. Of 442 `.apt.vm` files only two use Velocity control directives; the rest only interpolate properties.
## Traps found so far
Each of these was found by building the site before and after and comparing the generated HTML, not by reading the source.
**Velocity eats Markdown headings.** `##` starts a Markdown ATX heading and also a Velocity line comment, so in any `*.md.vm` file every heading below level one is deleted before Doxia sees the document. No error, no warning, the line is simply gone. This already affects published pages that were migrated earlier (see below), and 222 of the remaining `.apt.vm` files have subsections.
**A literal reference comes back to life.** APT writes `$\{foo\}` to show `${foo}` as text. The parser unescapes it, so the converted `*.md.vm` holds a live reference and Velocity resolves it. `maven-shared-reporting-exec` rendered `[org.apache.maven.model.ReportPlugin@c754401]` where the page meant to document `${project.reporting.plugins}`. Nine files were affected.
**Macro parameters truncated.** `%{snippet|file=${project.build.directory}/x.txt}` lost everything after the first closing brace, so several snippets on a page collapsed onto the same wrong target.
**Link destinations with spaces.** APT allows a space in an anchor, Markdown does not: `{{{#Identity Mapper}Identity Mapper}}` converted to a link that resolves nowhere. Worth noting the APT rendering was already wrong here — it emitted `href="#Identity Mapper"` pointing at `id="Identity_Mapper"` — so the conversion fixes a pre-existing broken link.
**Over-escaping.** Converted text was full of `\(`, `\)`, `1\.6`, `"` and `'`, which are not special in Markdown and make the source unpleasant to edit.
## Changes to the tooling
*doxia-converter*
- [ ] Keep Velocity constructs intact when converting a `*.vm` source. References, directive lines and block comments are hidden from the parser and put back afterwards, which also fixes `${project.name}` used as a section title coming out as `# $<a id="project.name"></a>project.name`.
- [ ] Warn when conversion turns literal text into a live Velocity reference.
- [ ] Keep a masked reference looking like a URL, so a destination opening with one is not mangled into an anchor.
*doxia*
- [ ] Let APT macro blocks end at the last brace on the line.
- [ ] Stop over-escaping text in the Markdown sink.
- [ ] Encode link destinations that contain a space.
*doxia-sitetools*
- [ ] Keep Markdown headings from being read as Velocity comments. Lines that would be swallowed are wrapped in `#[[ ... ]]#` before evaluation; a document that needs no shielding still goes through the existing code path unchanged.
## Pages migrated earlier that render incorrectly today
Every subsection heading on these pages is missing from the published site:
- [ ] `maven-build-cache-extension` — `index.md.vm`
- [ ] `maven-checkstyle-plugin` — `history.md.vm`
- [ ] `maven-scripting-plugin` — `jsr223-script-engines.md.vm`
- [ ] `maven-release-plugin` — `migrate.md.vm`, `usage.md.vm`, `usage/prepare-release.md.vm`
- [ ] `maven-scm-plugin` — `examples/scm-advance-features.md.vm`
These are worth fixing in the pages as well as in the renderer, since a repository only picks up the renderer fix once Doxia is released and the plugin bumps its site plugin.
## Conversion progress
Every entry below was verified by building the site before and after and comparing the visible text and link targets of every generated page. The remaining differences are `<b>`/`<i>` becoming `<strong>`/`<em>` and quotes in prose picking up the Markdown module's typographic substitution.
**Done — one page each**
- [ ] maven-shared-utils, maven-shared-jar, maven-script-interpreter, maven-reporting-impl, maven-reporting-exec, maven-mapping, maven-jarsigner, maven-dependency-tree, maven-dependency-analyzer
- [ ] maven-compiler-plugin (`usage`), maven-dist-tool, maven-indexer (`indexer-cli`), maven-apache-parent (`docs`)
- [ ] plexus-compiler, plexus-interpolation
**Done — whole repository**
- [ ] maven-wrapper, maven-apache-resources, maven-parent, plexus-io, modello
- [ ] maven-clean-plugin, maven-install-plugin, maven-verifier-plugin
- [ ] maven-acr-plugin, maven-ejb-plugin, maven-jar-plugin, maven-jmod-plugin, maven-rar-plugin, maven-shade-plugin, maven-source-plugin, maven-war-plugin
- [ ] maven-jxr, maven-doap-plugin, maven-jdeps-plugin, maven-project-info-reports-plugin
- [ ] maven-artifact-plugin, maven-help-plugin, maven-jarsigner-plugin, maven-jdeprscan-plugin, maven-remote-resources-plugin, maven-scm-publish-plugin, maven-stage-plugin, maven-toolchains-plugin
- [ ] maven-file-management, maven-filtering, maven-shared-resources
**Remaining, largest first**
- [ ] maven-enforcer 47, maven core 38, maven-surefire 35, maven-ear-plugin 25, maven-archetype 22, maven-archetypes 21, maven-javadoc-plugin 19, maven-invoker-plugin 17, maven-assembly-plugin 16, maven-dependency-plugin 15, maven-pmd-plugin 14, maven-changes-plugin 13, maven-wagon 12, maven-plugin-tools 11, maven-resources-plugin 11, maven-compiler-plugin 11, maven-checkstyle-plugin 10, maven-changelog-plugin 10, maven-antrun-plugin 9, and the remainder with fewer than 9 each
## How each page is converted
1. `git mv` the file so the rename is a separate reviewable step.
2. Convert with `doxia-converter` to get a draft.
3. Drop the YAML front matter it adds and fold the licence header into one block comment.
4. If the page only used Velocity for `${project.name}`, spell the title out and drop the `.vm`, which also avoids the heading problem entirely.
5. If it keeps a reference, use setext underlines for level two headings and `#[[ ... ]]#` for anything deeper. A setext underline needs a blank line before its title or the title is swallowed by the preceding block.
6. Escape references that APT rendered literally.
7. Build the site and compare every generated page against the pre-migration output.
--
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: issues-unsubscribe@maven.apache.org.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Migrate Maven site documentation from APT to Markdown [maven-doxia-converter]
Posted by "slachiewicz (via GitHub)" <gi...@apache.org>.
slachiewicz closed issue #139: Migrate Maven site documentation from APT to Markdown
URL: https://github.com/apache/maven-doxia-converter/issues/139
--
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: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Migrate Maven site documentation from APT to Markdown [maven-doxia-converter]
Posted by "slachiewicz (via GitHub)" <gi...@apache.org>.
slachiewicz commented on issue #139:
URL: https://github.com/apache/maven-doxia-converter/issues/139#issuecomment-5198963000
## Pull requests
### Tooling and repairs
These change behaviour rather than content, so they are worth reviewing first.
- Stop over-escaping text in the Markdown sink — [apache/maven-doxia#1070](https://github.com/apache/maven-doxia/pull/1070)
- Let APT macro blocks end at the last brace on the line — [apache/maven-doxia#1069](https://github.com/apache/maven-doxia/pull/1069)
- Keep Velocity constructs intact when converting a *.vm source — [apache/maven-doxia-converter#140](https://github.com/apache/maven-doxia-converter/pull/140)
- Keep Markdown headings from being read as Velocity comments — [apache/maven-doxia-sitetools#664](https://github.com/apache/maven-doxia-sitetools/pull/664)
- Repair the SCM overview table — [apache/maven-scm#1388](https://github.com/apache/maven-scm/pull/1388)
### Site documentation ports
One pull request per repository, each a single commit, each verified by building the site before and after the change and comparing every generated page. All target `master` unless noted and carry the `maintenance` label.
- [apache/maven#12682](https://github.com/apache/maven/pull/12682)
- [apache/maven-acr-plugin#145](https://github.com/apache/maven-acr-plugin/pull/145)
- [apache/maven-antrun-plugin#381](https://github.com/apache/maven-antrun-plugin/pull/381)
- [apache/maven-apache-resources#122](https://github.com/apache/maven-apache-resources/pull/122)
- [apache/maven-archetype#1006](https://github.com/apache/maven-archetype/pull/1006)
- [apache/maven-artifact-plugin#226](https://github.com/apache/maven-artifact-plugin/pull/226)
- [apache/maven-assembly-plugin#1351](https://github.com/apache/maven-assembly-plugin/pull/1351)
- [apache/maven-changelog-plugin#240](https://github.com/apache/maven-changelog-plugin/pull/240)
- [apache/maven-changes-plugin#652](https://github.com/apache/maven-changes-plugin/pull/652)
- [apache/maven-checkstyle-plugin#678](https://github.com/apache/maven-checkstyle-plugin/pull/678)
- [apache/maven-clean-plugin#332](https://github.com/apache/maven-clean-plugin/pull/332)
- [apache/maven-dependency-plugin#1674](https://github.com/apache/maven-dependency-plugin/pull/1674)
- [apache/maven-doap-plugin#165](https://github.com/apache/maven-doap-plugin/pull/165)
- [apache/maven-ear-plugin#543](https://github.com/apache/maven-ear-plugin/pull/543)
- [apache/maven-ejb-plugin#227](https://github.com/apache/maven-ejb-plugin/pull/227)
- [apache/maven-enforcer#1005](https://github.com/apache/maven-enforcer/pull/1005)
- [apache/maven-file-management#112](https://github.com/apache/maven-file-management/pull/112)
- [apache/maven-filtering#368](https://github.com/apache/maven-filtering/pull/368)
- [apache/maven-help-plugin#409](https://github.com/apache/maven-help-plugin/pull/409)
- [apache/maven-install-plugin#431](https://github.com/apache/maven-install-plugin/pull/431)
- [apache/maven-invoker-plugin#743](https://github.com/apache/maven-invoker-plugin/pull/743)
- [apache/maven-jar-plugin#577](https://github.com/apache/maven-jar-plugin/pull/577)
- [apache/maven-jarsigner-plugin#158](https://github.com/apache/maven-jarsigner-plugin/pull/158)
- [apache/maven-javadoc-plugin#1351](https://github.com/apache/maven-javadoc-plugin/pull/1351)
- [apache/maven-jdeprscan-plugin#85](https://github.com/apache/maven-jdeprscan-plugin/pull/85)
- [apache/maven-jdeps-plugin#97](https://github.com/apache/maven-jdeps-plugin/pull/97)
- [apache/maven-jmod-plugin#113](https://github.com/apache/maven-jmod-plugin/pull/113)
- [apache/maven-jxr#363](https://github.com/apache/maven-jxr/pull/363)
- [apache/maven-parent#591](https://github.com/apache/maven-parent/pull/591)
- [apache/maven-plugin-tools#1147](https://github.com/apache/maven-plugin-tools/pull/1147)
- [apache/maven-pmd-plugin#719](https://github.com/apache/maven-pmd-plugin/pull/719)
- [apache/maven-project-info-reports-plugin#646](https://github.com/apache/maven-project-info-reports-plugin/pull/646)
- [apache/maven-rar-plugin#166](https://github.com/apache/maven-rar-plugin/pull/166)
- [apache/maven-remote-resources-plugin#289](https://github.com/apache/maven-remote-resources-plugin/pull/289)
- [apache/maven-resources-plugin#503](https://github.com/apache/maven-resources-plugin/pull/503)
- [apache/maven-scm-publish-plugin#158](https://github.com/apache/maven-scm-publish-plugin/pull/158)
- [apache/maven-shade-plugin#838](https://github.com/apache/maven-shade-plugin/pull/838)
- [apache/maven-shared-resources#84](https://github.com/apache/maven-shared-resources/pull/84)
- [apache/maven-source-plugin#321](https://github.com/apache/maven-source-plugin/pull/321)
- [apache/maven-stage-plugin#73](https://github.com/apache/maven-stage-plugin/pull/73)
- [apache/maven-toolchains-plugin#193](https://github.com/apache/maven-toolchains-plugin/pull/193)
- [apache/maven-verifier-plugin#65](https://github.com/apache/maven-verifier-plugin/pull/65)
- [apache/maven-wagon#895](https://github.com/apache/maven-wagon/pull/895)
- [apache/maven-war-plugin#645](https://github.com/apache/maven-war-plugin/pull/645)
- [apache/maven-wrapper#438](https://github.com/apache/maven-wrapper/pull/438)
- [codehaus-plexus/modello#572](https://github.com/codehaus-plexus/modello/pull/572)
- [codehaus-plexus/plexus-io#179](https://github.com/codehaus-plexus/plexus-io/pull/179)
Across these, 757 files under `src/site` and nothing outside it.
Still to come: the second pull request for each of the five repositories whose port was made on a `-3.x` maintenance line, so the conversion reaches `master` as well (maven-clean-plugin, maven-install-plugin, maven-jar-plugin, maven-resources-plugin, maven-filtering); and a licence header cleanup across nine repositories where an earlier conversion left the header as one HTML comment per line.
--
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: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Migrate Maven site documentation from APT to Markdown [maven-doxia-converter]
Posted by "slachiewicz (via GitHub)" <gi...@apache.org>.
slachiewicz commented on issue #139:
URL: https://github.com/apache/maven-doxia-converter/issues/139#issuecomment-5207941450
## Pages that still carry Velocity
After the conversion, 248 pages remain `*.md.vm`. Velocity is only needed for what each one interpolates, so this is what would have to be resolved before any of them could become a plain `.md`.
| why the page stays a template | pages |
|---|---|
| only `${project.version}`, inside a `<version>` element of an example POM | 137 |
| `${project.version}`, but also used outside `<version>` | 5 |
| a dependency or plugin version property | 68 |
| a build directory reference | 24 |
| project name or description | 11 |
| Velocity directives (`#if`, `#foreach`, `#set`) | 3 |
The first row is the interesting one: those 137 pages exist as templates purely to keep a version current in an example POM. Dropping that `<version>` element would let every one of them become a plain `.md`. That is a documentation decision rather than a mechanical one, since it changes whether the examples pin a version, so it is recorded here rather than done.
<details>
<summary>The 137 pages whose only Velocity is a version in an example POM</summary>
| page | needs |
|---|---|
| [modello / `modello-maven-plugin/examples/multi-model.md.vm`](https://github.com/codehaus-plexus/modello/blob/master/modello-maven-plugin/src/site/markdown/examples/multi-model.md.vm) | 1 of 1 inside `<version>` |
| [modello / `modello-maven-plugin/usage.md.vm`](https://github.com/codehaus-plexus/modello/blob/master/modello-maven-plugin/src/site/markdown/usage.md.vm) | 1 of 1 inside `<version>` |
| [maven-clean-plugin / `examples/ignoring-errors.md.vm`](https://github.com/apache/maven-clean-plugin/blob/master/src/site/markdown/examples/ignoring-errors.md.vm) | 1 of 1 inside `<version>` |
| [maven-clean-plugin / `examples/skipping-clean.md.vm`](https://github.com/apache/maven-clean-plugin/blob/master/src/site/markdown/examples/skipping-clean.md.vm) | 1 of 1 inside `<version>` |
| [maven-clean-plugin / `usage.md.vm`](https://github.com/apache/maven-clean-plugin/blob/master/src/site/markdown/usage.md.vm) | 1 of 1 inside `<version>` |
| [maven-resources-plugin / `examples/binaries-filtering.md.vm`](https://github.com/apache/maven-resources-plugin/blob/master/src/site/markdown/examples/binaries-filtering.md.vm) | 1 of 1 inside `<version>` |
| [maven-resources-plugin / `examples/custom-resource-filters.md.vm`](https://github.com/apache/maven-resources-plugin/blob/master/src/site/markdown/examples/custom-resource-filters.md.vm) | 2 of 2 inside `<version>` |
| [maven-resources-plugin / `examples/filtering-properties-files.md.vm`](https://github.com/apache/maven-resources-plugin/blob/master/src/site/markdown/examples/filtering-properties-files.md.vm) | 1 of 1 inside `<version>` |
| [maven-verifier-plugin / `usage.md.vm`](https://github.com/apache/maven-verifier-plugin/blob/master/src/site/markdown/usage.md.vm) | 1 of 1 inside `<version>` |
| [maven-acr-plugin / `examples/filter-deployment-descriptor.md.vm`](https://github.com/apache/maven-acr-plugin/blob/master/src/site/markdown/examples/filter-deployment-descriptor.md.vm) | 1 of 1 inside `<version>` |
| [maven-acr-plugin / `usage.md.vm`](https://github.com/apache/maven-acr-plugin/blob/master/src/site/markdown/usage.md.vm) | 1 of 1 inside `<version>` |
| [maven-ear-plugin / `examples/customize-file-name-mapping.md.vm`](https://github.com/apache/maven-ear-plugin/blob/master/src/site/markdown/examples/customize-file-name-mapping.md.vm) | 2 of 2 inside `<version>` |
| [maven-ear-plugin / `examples/customizing-a-module-filename.md.vm`](https://github.com/apache/maven-ear-plugin/blob/master/src/site/markdown/examples/customizing-a-module-filename.md.vm) | 1 of 1 inside `<version>` |
| [maven-ear-plugin / `examples/customizing-context-root.md.vm`](https://github.com/apache/maven-ear-plugin/blob/master/src/site/markdown/examples/customizing-context-root.md.vm) | 1 of 1 inside `<version>` |
| [maven-ear-plugin / `examples/customizing-module-location.md.vm`](https://github.com/apache/maven-ear-plugin/blob/master/src/site/markdown/examples/customizing-module-location.md.vm) | 2 of 2 inside `<version>` |
| [maven-ear-plugin / `examples/customizing-module-uri.md.vm`](https://github.com/apache/maven-ear-plugin/blob/master/src/site/markdown/examples/customizing-module-uri.md.vm) | 1 of 1 inside `<version>` |
| [maven-ear-plugin / `examples/excluding-a-module.md.vm`](https://github.com/apache/maven-ear-plugin/blob/master/src/site/markdown/examples/excluding-a-module.md.vm) | 1 of 1 inside `<version>` |
| [maven-ear-plugin / `examples/excluding-files-from-ear.md.vm`](https://github.com/apache/maven-ear-plugin/blob/master/src/site/markdown/examples/excluding-files-from-ear.md.vm) | 2 of 2 inside `<version>` |
| [maven-ear-plugin / `examples/filtering-sources.md.vm`](https://github.com/apache/maven-ear-plugin/blob/master/src/site/markdown/examples/filtering-sources.md.vm) | 2 of 2 inside `<version>` |
| [maven-ear-plugin / `examples/generating-jboss-app.md.vm`](https://github.com/apache/maven-ear-plugin/blob/master/src/site/markdown/examples/generating-jboss-app.md.vm) | 1 of 1 inside `<version>` |
| [maven-ear-plugin / `examples/generating-modules-id.md.vm`](https://github.com/apache/maven-ear-plugin/blob/master/src/site/markdown/examples/generating-modules-id.md.vm) | 2 of 2 inside `<version>` |
| [maven-ear-plugin / `examples/including-a-third-party-library-in-application-xml.md.vm`](https://github.com/apache/maven-ear-plugin/blob/master/src/site/markdown/examples/including-a-third-party-library-in-application-xml.md.vm) | 1 of 1 inside `<version>` |
| [maven-ear-plugin / `examples/skinny-modules.md.vm`](https://github.com/apache/maven-ear-plugin/blob/master/src/site/markdown/examples/skinny-modules.md.vm) | 2 of 2 inside `<version>` |
| [maven-ear-plugin / `examples/skinny-wars.md.vm`](https://github.com/apache/maven-ear-plugin/blob/master/src/site/markdown/examples/skinny-wars.md.vm) | 1 of 1 inside `<version>` |
| [maven-ear-plugin / `examples/specifying-ejb-ref-entries-for-the-generated-application-xml.md.vm`](https://github.com/apache/maven-ear-plugin/blob/master/src/site/markdown/examples/specifying-ejb-ref-entries-for-the-generated-application-xml.md.vm) | 1 of 1 inside `<version>` |
| [maven-ear-plugin / `examples/specifying-env-entries-for-the-generated-application-xml.md.vm`](https://github.com/apache/maven-ear-plugin/blob/master/src/site/markdown/examples/specifying-env-entries-for-the-generated-application-xml.md.vm) | 1 of 1 inside `<version>` |
| [maven-ear-plugin / `examples/specifying-resource-ref-entries-for-the-generated-application-xml.md.vm`](https://github.com/apache/maven-ear-plugin/blob/master/src/site/markdown/examples/specifying-resource-ref-entries-for-the-generated-application-xml.md.vm) | 1 of 1 inside `<version>` |
| [maven-ear-plugin / `examples/specifying-security-roles-for-the-generated-application-xml.md.vm`](https://github.com/apache/maven-ear-plugin/blob/master/src/site/markdown/examples/specifying-security-roles-for-the-generated-application-xml.md.vm) | 1 of 1 inside `<version>` |
| [maven-ear-plugin / `examples/unpacking-a-module.md.vm`](https://github.com/apache/maven-ear-plugin/blob/master/src/site/markdown/examples/unpacking-a-module.md.vm) | 2 of 2 inside `<version>` |
| [maven-ear-plugin / `modules.md.vm`](https://github.com/apache/maven-ear-plugin/blob/master/src/site/markdown/modules.md.vm) | 2 of 2 inside `<version>` |
| [maven-ejb-plugin / `examples/filter-deployment-descriptor.md.vm`](https://github.com/apache/maven-ejb-plugin/blob/master/src/site/markdown/examples/filter-deployment-descriptor.md.vm) | 1 of 1 inside `<version>` |
| [maven-ejb-plugin / `examples/generating-ejb-client.md.vm`](https://github.com/apache/maven-ejb-plugin/blob/master/src/site/markdown/examples/generating-ejb-client.md.vm) | 2 of 2 inside `<version>` |
| [maven-jar-plugin / `examples/attached-jar.md.vm`](https://github.com/apache/maven-jar-plugin/blob/master/src/site/markdown/examples/attached-jar.md.vm) | 1 of 1 inside `<version>` |
| [maven-jar-plugin / `examples/create-test-jar.md.vm`](https://github.com/apache/maven-jar-plugin/blob/master/src/site/markdown/examples/create-test-jar.md.vm) | 1 of 1 inside `<version>` |
| [maven-jar-plugin / `examples/include-exclude.md.vm`](https://github.com/apache/maven-jar-plugin/blob/master/src/site/markdown/examples/include-exclude.md.vm) | 1 of 1 inside `<version>` |
| [maven-rar-plugin / `examples/exclude-project-jar.md.vm`](https://github.com/apache/maven-rar-plugin/blob/master/src/site/markdown/examples/exclude-project-jar.md.vm) | 1 of 1 inside `<version>` |
| [maven-rar-plugin / `examples/include-extra-files.md.vm`](https://github.com/apache/maven-rar-plugin/blob/master/src/site/markdown/examples/include-extra-files.md.vm) | 1 of 1 inside `<version>` |
| [maven-rar-plugin / `examples/ra-custom-location.md.vm`](https://github.com/apache/maven-rar-plugin/blob/master/src/site/markdown/examples/ra-custom-location.md.vm) | 1 of 1 inside `<version>` |
| [maven-rar-plugin / `usage.md.vm`](https://github.com/apache/maven-rar-plugin/blob/master/src/site/markdown/usage.md.vm) | 1 of 1 inside `<version>` |
| [maven-shade-plugin / `examples/attached-artifact.md.vm`](https://github.com/apache/maven-shade-plugin/blob/master/src/site/markdown/examples/attached-artifact.md.vm) | 1 of 1 inside `<version>` |
| [maven-shade-plugin / `examples/class-relocation.md.vm`](https://github.com/apache/maven-shade-plugin/blob/master/src/site/markdown/examples/class-relocation.md.vm) | 1 of 1 inside `<version>` |
| [maven-shade-plugin / `examples/executable-jar.md.vm`](https://github.com/apache/maven-shade-plugin/blob/master/src/site/markdown/examples/executable-jar.md.vm) | 2 of 2 inside `<version>` |
| [maven-shade-plugin / `examples/includes-excludes.md.vm`](https://github.com/apache/maven-shade-plugin/blob/master/src/site/markdown/examples/includes-excludes.md.vm) | 4 of 4 inside `<version>` |
| [maven-shade-plugin / `examples/use-shader-other-impl.md.vm`](https://github.com/apache/maven-shade-plugin/blob/master/src/site/markdown/examples/use-shader-other-impl.md.vm) | 1 of 1 inside `<version>` |
| [maven-war-plugin / `examples/including-excluding-files-from-war.md.vm`](https://github.com/apache/maven-war-plugin/blob/master/src/site/markdown/examples/including-excluding-files-from-war.md.vm) | 2 of 2 inside `<version>` |
| [maven-war-plugin / `overlays.md.vm`](https://github.com/apache/maven-war-plugin/blob/master/src/site/markdown/overlays.md.vm) | 7 of 7 inside `<version>` |
| [maven-jxr / `maven-jxr-plugin/examples/aggregate.md.vm`](https://github.com/apache/maven-jxr/blob/master/maven-jxr-plugin/src/site/markdown/examples/aggregate.md.vm) | 1 of 1 inside `<version>` |
| [maven-jxr / `maven-jxr-plugin/examples/include-exclude.md.vm`](https://github.com/apache/maven-jxr/blob/master/maven-jxr-plugin/src/site/markdown/examples/include-exclude.md.vm) | 2 of 2 inside `<version>` |
| [maven-jxr / `maven-jxr-plugin/examples/linkjavadoc.md.vm`](https://github.com/apache/maven-jxr/blob/master/maven-jxr-plugin/src/site/markdown/examples/linkjavadoc.md.vm) | 1 of 1 inside `<version>` |
| [maven-jxr / `maven-jxr-plugin/examples/nofork.md.vm`](https://github.com/apache/maven-jxr/blob/master/maven-jxr-plugin/src/site/markdown/examples/nofork.md.vm) | 1 of 1 inside `<version>` |
| [maven-jxr / `maven-jxr-plugin/usage.md.vm`](https://github.com/apache/maven-jxr/blob/master/maven-jxr-plugin/src/site/markdown/usage.md.vm) | 1 of 1 inside `<version>` |
| [maven-changelog-plugin / `examples/changing-heading-date-format.md.vm`](https://github.com/apache/maven-changelog-plugin/blob/master/src/site/markdown/examples/changing-heading-date-format.md.vm) | 1 of 1 inside `<version>` |
| [maven-changelog-plugin / `examples/configuration-date-type.md.vm`](https://github.com/apache/maven-changelog-plugin/blob/master/src/site/markdown/examples/configuration-date-type.md.vm) | 1 of 1 inside `<version>` |
| [maven-changelog-plugin / `examples/configuration-range-type.md.vm`](https://github.com/apache/maven-changelog-plugin/blob/master/src/site/markdown/examples/configuration-range-type.md.vm) | 1 of 1 inside `<version>` |
| [maven-changelog-plugin / `examples/configuration-tag-type.md.vm`](https://github.com/apache/maven-changelog-plugin/blob/master/src/site/markdown/examples/configuration-tag-type.md.vm) | 1 of 1 inside `<version>` |
| [maven-changelog-plugin / `examples/modifying-scm-links.md.vm`](https://github.com/apache/maven-changelog-plugin/blob/master/src/site/markdown/examples/modifying-scm-links.md.vm) | 1 of 1 inside `<version>` |
| [maven-changelog-plugin / `examples/selecting-reports.md.vm`](https://github.com/apache/maven-changelog-plugin/blob/master/src/site/markdown/examples/selecting-reports.md.vm) | 1 of 1 inside `<version>` |
| [maven-changelog-plugin / `examples/using-perforce.md.vm`](https://github.com/apache/maven-changelog-plugin/blob/master/src/site/markdown/examples/using-perforce.md.vm) | 1 of 1 inside `<version>` |
| [maven-changelog-plugin / `usage.md.vm`](https://github.com/apache/maven-changelog-plugin/blob/master/src/site/markdown/usage.md.vm) | 1 of 1 inside `<version>` |
| [maven-changes-plugin / `examples/changes-file-validation.md.vm`](https://github.com/apache/maven-changes-plugin/blob/master/src/site/markdown/examples/changes-file-validation.md.vm) | 1 of 1 inside `<version>` |
| [maven-changes-plugin / `examples/check-changes-file.md.vm`](https://github.com/apache/maven-changes-plugin/blob/master/src/site/markdown/examples/check-changes-file.md.vm) | 1 of 1 inside `<version>` |
| [maven-changes-plugin / `examples/configuring-github-report.md.vm`](https://github.com/apache/maven-changes-plugin/blob/master/src/site/markdown/examples/configuring-github-report.md.vm) | 4 of 4 inside `<version>` |
| [maven-changes-plugin / `examples/customizing-jira-report.md.vm`](https://github.com/apache/maven-changes-plugin/blob/master/src/site/markdown/examples/customizing-jira-report.md.vm) | 5 of 5 inside `<version>` |
| [maven-changes-plugin / `examples/smtp-authentication.md.vm`](https://github.com/apache/maven-changes-plugin/blob/master/src/site/markdown/examples/smtp-authentication.md.vm) | 1 of 1 inside `<version>` |
| [maven-changes-plugin / `examples/specifying-mail-sender.md.vm`](https://github.com/apache/maven-changes-plugin/blob/master/src/site/markdown/examples/specifying-mail-sender.md.vm) | 2 of 2 inside `<version>` |
| [maven-changes-plugin / `usage.md.vm`](https://github.com/apache/maven-changes-plugin/blob/master/src/site/markdown/usage.md.vm) | 6 of 6 inside `<version>` |
| [maven-checkstyle-plugin / `examples/custom-checker-config.md.vm`](https://github.com/apache/maven-checkstyle-plugin/blob/master/src/site/markdown/examples/custom-checker-config.md.vm) | 1 of 1 inside `<version>` |
| [maven-checkstyle-plugin / `examples/custom-developed-checkstyle.md.vm`](https://github.com/apache/maven-checkstyle-plugin/blob/master/src/site/markdown/examples/custom-developed-checkstyle.md.vm) | 3 of 3 inside `<version>` |
| [maven-checkstyle-plugin / `examples/inline-checker-config.md.vm`](https://github.com/apache/maven-checkstyle-plugin/blob/master/src/site/markdown/examples/inline-checker-config.md.vm) | 2 of 2 inside `<version>` |
| [maven-checkstyle-plugin / `examples/multi-module-config.md.vm`](https://github.com/apache/maven-checkstyle-plugin/blob/master/src/site/markdown/examples/multi-module-config.md.vm) | 2 of 2 inside `<version>` |
| [maven-checkstyle-plugin / `examples/suppressions-filter.md.vm`](https://github.com/apache/maven-checkstyle-plugin/blob/master/src/site/markdown/examples/suppressions-filter.md.vm) | 1 of 1 inside `<version>` |
| [maven-checkstyle-plugin / `usage.md.vm`](https://github.com/apache/maven-checkstyle-plugin/blob/master/src/site/markdown/usage.md.vm) | 2 of 2 inside `<version>` |
| [maven-javadoc-plugin / `examples/additional-dependencies.md.vm`](https://github.com/apache/maven-javadoc-plugin/blob/master/src/site/markdown/examples/additional-dependencies.md.vm) | 1 of 1 inside `<version>` |
| [maven-javadoc-plugin / `examples/aggregate-nofork.md.vm`](https://github.com/apache/maven-javadoc-plugin/blob/master/src/site/markdown/examples/aggregate-nofork.md.vm) | 1 of 1 inside `<version>` |
| [maven-javadoc-plugin / `examples/aggregate.md.vm`](https://github.com/apache/maven-javadoc-plugin/blob/master/src/site/markdown/examples/aggregate.md.vm) | 3 of 3 inside `<version>` |
| [maven-javadoc-plugin / `examples/group-configuration.md.vm`](https://github.com/apache/maven-javadoc-plugin/blob/master/src/site/markdown/examples/group-configuration.md.vm) | 1 of 1 inside `<version>` |
| [maven-javadoc-plugin / `examples/javadoc-nofork.md.vm`](https://github.com/apache/maven-javadoc-plugin/blob/master/src/site/markdown/examples/javadoc-nofork.md.vm) | 1 of 1 inside `<version>` |
| [maven-javadoc-plugin / `examples/selective-javadocs-report.md.vm`](https://github.com/apache/maven-javadoc-plugin/blob/master/src/site/markdown/examples/selective-javadocs-report.md.vm) | 2 of 2 inside `<version>` |
| [maven-javadoc-plugin / `examples/tag-configuration.md.vm`](https://github.com/apache/maven-javadoc-plugin/blob/master/src/site/markdown/examples/tag-configuration.md.vm) | 1 of 1 inside `<version>` |
| [maven-javadoc-plugin / `examples/taglet-configuration.md.vm`](https://github.com/apache/maven-javadoc-plugin/blob/master/src/site/markdown/examples/taglet-configuration.md.vm) | 4 of 4 inside `<version>` |
| [maven-pmd-plugin / `examples/aggregate.md.vm`](https://github.com/apache/maven-pmd-plugin/blob/master/src/site/markdown/examples/aggregate.md.vm) | 4 of 4 inside `<version>` |
| [maven-pmd-plugin / `examples/removeReport.md.vm`](https://github.com/apache/maven-pmd-plugin/blob/master/src/site/markdown/examples/removeReport.md.vm) | 1 of 1 inside `<version>` |
| [maven-pmd-plugin / `examples/targetJdk.md.vm`](https://github.com/apache/maven-pmd-plugin/blob/master/src/site/markdown/examples/targetJdk.md.vm) | 1 of 1 inside `<version>` |
| [maven-pmd-plugin / `examples/violation-exclusions.md.vm`](https://github.com/apache/maven-pmd-plugin/blob/master/src/site/markdown/examples/violation-exclusions.md.vm) | 2 of 2 inside `<version>` |
| [maven-pmd-plugin / `examples/violationChecking.md.vm`](https://github.com/apache/maven-pmd-plugin/blob/master/src/site/markdown/examples/violationChecking.md.vm) | 1 of 1 inside `<version>` |
| [maven-pmd-plugin / `usage.md.vm`](https://github.com/apache/maven-pmd-plugin/blob/master/src/site/markdown/usage.md.vm) | 3 of 3 inside `<version>` |
| [maven-project-info-reports-plugin / `examples/scm-report.md.vm`](https://github.com/apache/maven-project-info-reports-plugin/blob/master/src/site/markdown/examples/scm-report.md.vm) | 1 of 1 inside `<version>` |
| [maven-project-info-reports-plugin / `examples/selective-reports.md.vm`](https://github.com/apache/maven-project-info-reports-plugin/blob/master/src/site/markdown/examples/selective-reports.md.vm) | 1 of 1 inside `<version>` |
| [maven-archetype / `archetype-packaging/index.md.vm`](https://github.com/apache/maven-archetype/blob/master/archetype-packaging/src/site/markdown/index.md.vm) | 1 of 1 inside `<version>` |
| [maven-enforcer / `enforcer-rules/alwaysFail.md.vm`](https://github.com/apache/maven-enforcer/blob/master/enforcer-rules/src/site/markdown/alwaysFail.md.vm) | 1 of 1 inside `<version>` |
| [maven-enforcer / `enforcer-rules/alwaysPass.md.vm`](https://github.com/apache/maven-enforcer/blob/master/enforcer-rules/src/site/markdown/alwaysPass.md.vm) | 1 of 1 inside `<version>` |
| [maven-enforcer / `enforcer-rules/banDependencyManagementScope.md.vm`](https://github.com/apache/maven-enforcer/blob/master/enforcer-rules/src/site/markdown/banDependencyManagementScope.md.vm) | 1 of 1 inside `<version>` |
| [maven-enforcer / `enforcer-rules/banDistributionManagement.md.vm`](https://github.com/apache/maven-enforcer/blob/master/enforcer-rules/src/site/markdown/banDistributionManagement.md.vm) | 2 of 2 inside `<version>` |
| [maven-enforcer / `enforcer-rules/banDuplicatePomDependencyVersions.md.vm`](https://github.com/apache/maven-enforcer/blob/master/enforcer-rules/src/site/markdown/banDuplicatePomDependencyVersions.md.vm) | 1 of 1 inside `<version>` |
| [maven-enforcer / `enforcer-rules/banDynamicVersions.md.vm`](https://github.com/apache/maven-enforcer/blob/master/enforcer-rules/src/site/markdown/banDynamicVersions.md.vm) | 1 of 1 inside `<version>` |
| [maven-enforcer / `enforcer-rules/banTransitiveDependencies.md.vm`](https://github.com/apache/maven-enforcer/blob/master/enforcer-rules/src/site/markdown/banTransitiveDependencies.md.vm) | 1 of 1 inside `<version>` |
| [maven-enforcer / `enforcer-rules/bannedDependencies.md.vm`](https://github.com/apache/maven-enforcer/blob/master/enforcer-rules/src/site/markdown/bannedDependencies.md.vm) | 2 of 2 inside `<version>` |
| [maven-enforcer / `enforcer-rules/bannedPlugins.md.vm`](https://github.com/apache/maven-enforcer/blob/master/enforcer-rules/src/site/markdown/bannedPlugins.md.vm) | 1 of 1 inside `<version>` |
| [maven-enforcer / `enforcer-rules/bannedRepositories.md.vm`](https://github.com/apache/maven-enforcer/blob/master/enforcer-rules/src/site/markdown/bannedRepositories.md.vm) | 1 of 1 inside `<version>` |
| [maven-enforcer / `enforcer-rules/dependencyConvergence.md.vm`](https://github.com/apache/maven-enforcer/blob/master/enforcer-rules/src/site/markdown/dependencyConvergence.md.vm) | 1 of 1 inside `<version>` |
| [maven-enforcer / `enforcer-rules/enforceBytecodeVersion.md.vm`](https://github.com/apache/maven-enforcer/blob/master/enforcer-rules/src/site/markdown/enforceBytecodeVersion.md.vm) | 1 of 1 inside `<version>` |
| [maven-enforcer / `enforcer-rules/reactorModuleConvergence.md.vm`](https://github.com/apache/maven-enforcer/blob/master/enforcer-rules/src/site/markdown/reactorModuleConvergence.md.vm) | 1 of 1 inside `<version>` |
| [maven-enforcer / `enforcer-rules/requireActiveProfile.md.vm`](https://github.com/apache/maven-enforcer/blob/master/enforcer-rules/src/site/markdown/requireActiveProfile.md.vm) | 2 of 2 inside `<version>` |
| [maven-enforcer / `enforcer-rules/requireEnvironmentVariable.md.vm`](https://github.com/apache/maven-enforcer/blob/master/enforcer-rules/src/site/markdown/requireEnvironmentVariable.md.vm) | 1 of 1 inside `<version>` |
| [maven-enforcer / `enforcer-rules/requireExplicitDependencyScope.md.vm`](https://github.com/apache/maven-enforcer/blob/master/enforcer-rules/src/site/markdown/requireExplicitDependencyScope.md.vm) | 1 of 1 inside `<version>` |
| [maven-enforcer / `enforcer-rules/requireJavaVendor.md.vm`](https://github.com/apache/maven-enforcer/blob/master/enforcer-rules/src/site/markdown/requireJavaVendor.md.vm) | 1 of 1 inside `<version>` |
| [maven-enforcer / `enforcer-rules/requireJavaVersion.md.vm`](https://github.com/apache/maven-enforcer/blob/master/enforcer-rules/src/site/markdown/requireJavaVersion.md.vm) | 1 of 1 inside `<version>` |
| [maven-enforcer / `enforcer-rules/requireMatchingCoordinates.md.vm`](https://github.com/apache/maven-enforcer/blob/master/enforcer-rules/src/site/markdown/requireMatchingCoordinates.md.vm) | 1 of 1 inside `<version>` |
| [maven-enforcer / `enforcer-rules/requireMavenVersion.md.vm`](https://github.com/apache/maven-enforcer/blob/master/enforcer-rules/src/site/markdown/requireMavenVersion.md.vm) | 1 of 1 inside `<version>` |
| [maven-enforcer / `enforcer-rules/requireNoRepositories.md.vm`](https://github.com/apache/maven-enforcer/blob/master/enforcer-rules/src/site/markdown/requireNoRepositories.md.vm) | 1 of 1 inside `<version>` |
| [maven-enforcer / `enforcer-rules/requireOS.md.vm`](https://github.com/apache/maven-enforcer/blob/master/enforcer-rules/src/site/markdown/requireOS.md.vm) | 1 of 1 inside `<version>` |
| [maven-enforcer / `enforcer-rules/requirePluginVersions.md.vm`](https://github.com/apache/maven-enforcer/blob/master/enforcer-rules/src/site/markdown/requirePluginVersions.md.vm) | 1 of 1 inside `<version>` |
| [maven-enforcer / `enforcer-rules/requirePrerequisite.md.vm`](https://github.com/apache/maven-enforcer/blob/master/enforcer-rules/src/site/markdown/requirePrerequisite.md.vm) | 1 of 1 inside `<version>` |
| [maven-enforcer / `enforcer-rules/requireProfileIdsExist.md.vm`](https://github.com/apache/maven-enforcer/blob/master/enforcer-rules/src/site/markdown/requireProfileIdsExist.md.vm) | 1 of 1 inside `<version>` |
| [maven-enforcer / `enforcer-rules/requireProperty.md.vm`](https://github.com/apache/maven-enforcer/blob/master/enforcer-rules/src/site/markdown/requireProperty.md.vm) | 1 of 1 inside `<version>` |
| [maven-enforcer / `enforcer-rules/requireReleaseDeps.md.vm`](https://github.com/apache/maven-enforcer/blob/master/enforcer-rules/src/site/markdown/requireReleaseDeps.md.vm) | 2 of 2 inside `<version>` |
| [maven-enforcer / `enforcer-rules/requireReleaseVersion.md.vm`](https://github.com/apache/maven-enforcer/blob/master/enforcer-rules/src/site/markdown/requireReleaseVersion.md.vm) | 1 of 1 inside `<version>` |
| [maven-enforcer / `enforcer-rules/requireSameVersions.md.vm`](https://github.com/apache/maven-enforcer/blob/master/enforcer-rules/src/site/markdown/requireSameVersions.md.vm) | 1 of 1 inside `<version>` |
| [maven-enforcer / `enforcer-rules/requireSnapshotVersion.md.vm`](https://github.com/apache/maven-enforcer/blob/master/enforcer-rules/src/site/markdown/requireSnapshotVersion.md.vm) | 1 of 1 inside `<version>` |
| [maven-enforcer / `enforcer-rules/requireUpperBoundDeps.md.vm`](https://github.com/apache/maven-enforcer/blob/master/enforcer-rules/src/site/markdown/requireUpperBoundDeps.md.vm) | 1 of 1 inside `<version>` |
| [maven-enforcer / `maven-enforcer-plugin/examples/check-specific-rule-via-cli.md.vm`](https://github.com/apache/maven-enforcer/blob/master/maven-enforcer-plugin/src/site/markdown/examples/check-specific-rule-via-cli.md.vm) | 2 of 2 inside `<version>` |
| [maven-enforcer / `maven-enforcer-plugin/usage.md.vm`](https://github.com/apache/maven-enforcer/blob/master/maven-enforcer-plugin/src/site/markdown/usage.md.vm) | 1 of 1 inside `<version>` |
| [maven-antrun-plugin / `examples/tasksAttributes.md.vm`](https://github.com/apache/maven-antrun-plugin/blob/master/src/site/markdown/examples/tasksAttributes.md.vm) | 1 of 1 inside `<version>` |
| [maven-antrun-plugin / `tasks/attachArtifact.md.vm`](https://github.com/apache/maven-antrun-plugin/blob/master/src/site/markdown/tasks/attachArtifact.md.vm) | 1 of 1 inside `<version>` |
| [maven-antrun-plugin / `tasks/dependencyFilesets.md.vm`](https://github.com/apache/maven-antrun-plugin/blob/master/src/site/markdown/tasks/dependencyFilesets.md.vm) | 1 of 1 inside `<version>` |
| [maven-assembly-plugin / `examples/using-inline-descriptors.md.vm`](https://github.com/apache/maven-assembly-plugin/blob/master/src/site/markdown/examples/using-inline-descriptors.md.vm) | 1 of 1 inside `<version>` |
| [maven-dependency-plugin / `examples/exclude-dependencies-from-dependency-analysis.md.vm`](https://github.com/apache/maven-dependency-plugin/blob/master/src/site/markdown/examples/exclude-dependencies-from-dependency-analysis.md.vm) | 1 of 1 inside `<version>` |
| [maven-dependency-plugin / `examples/failing-the-build-on-dependency-analysis-warnings.md.vm`](https://github.com/apache/maven-dependency-plugin/blob/master/src/site/markdown/examples/failing-the-build-on-dependency-analysis-warnings.md.vm) | 1 of 1 inside `<version>` |
| [maven-dependency-plugin / `examples/purging-local-repository.md.vm`](https://github.com/apache/maven-dependency-plugin/blob/master/src/site/markdown/examples/purging-local-repository.md.vm) | 1 of 1 inside `<version>` |
| [maven-dependency-plugin / `examples/unpacking-filemapper.md.vm`](https://github.com/apache/maven-dependency-plugin/blob/master/src/site/markdown/examples/unpacking-filemapper.md.vm) | 1 of 1 inside `<version>` |
| [maven-dependency-plugin / `usage.md.vm`](https://github.com/apache/maven-dependency-plugin/blob/master/src/site/markdown/usage.md.vm) | 8 of 8 inside `<version>` |
| [maven-jarsigner-plugin / `examples/sign-and-verify-project.md.vm`](https://github.com/apache/maven-jarsigner-plugin/blob/master/src/site/markdown/examples/sign-and-verify-project.md.vm) | 1 of 1 inside `<version>` |
| [maven-jarsigner-plugin / `usage.md.vm`](https://github.com/apache/maven-jarsigner-plugin/blob/master/src/site/markdown/usage.md.vm) | 2 of 2 inside `<version>` |
| [maven-jdeprscan-plugin / `usage.md.vm`](https://github.com/apache/maven-jdeprscan-plugin/blob/master/src/site/markdown/usage.md.vm) | 1 of 1 inside `<version>` |
| [maven-remote-resources-plugin / `supplemental-models.md.vm`](https://github.com/apache/maven-remote-resources-plugin/blob/master/src/site/markdown/supplemental-models.md.vm) | 2 of 2 inside `<version>` |
| [maven-plugin-tools / `maven-plugin-plugin/examples/using-annotations.md.vm`](https://github.com/apache/maven-plugin-tools/blob/master/maven-plugin-plugin/src/site/markdown/examples/using-annotations.md.vm) | 2 of 2 inside `<version>` |
| [maven-file-management / `examples/mojo.md.vm`](https://github.com/apache/maven-file-management/blob/master/src/site/markdown/examples/mojo.md.vm) | 1 of 1 inside `<version>` |
</details>
<details>
<summary>The 5 pages using <code>${project.version}</code> outside a version element too</summary>
| page | needs |
|---|---|
| [maven-jmod-plugin / `examples/example-describe.md.vm`](https://github.com/apache/maven-jmod-plugin/blob/master/src/site/markdown/examples/example-describe.md.vm) | 1 of 2 inside `<version>` |
| [maven-jmod-plugin / `examples/example-list.md.vm`](https://github.com/apache/maven-jmod-plugin/blob/master/src/site/markdown/examples/example-list.md.vm) | 1 of 2 inside `<version>` |
| [maven-jmod-plugin / `usage.md.vm`](https://github.com/apache/maven-jmod-plugin/blob/master/src/site/markdown/usage.md.vm) | 1 of 2 inside `<version>` |
| [maven-artifact-plugin / `reproducible.md.vm`](https://github.com/apache/maven-artifact-plugin/blob/master/src/site/markdown/reproducible.md.vm) | 0 of 1 inside `<version>` |
| [maven-artifact-plugin / `usage.md.vm`](https://github.com/apache/maven-artifact-plugin/blob/master/src/site/markdown/usage.md.vm) | 0 of 2 inside `<version>` |
</details>
<details>
<summary>The 106 pages needing Velocity for something else</summary>
| page | needs |
|---|---|
| [maven-wrapper / `maven-wrapper-distribution/index.md.vm`](https://github.com/apache/maven-wrapper/blob/master/maven-wrapper-distribution/src/site/markdown/index.md.vm) | `${project.description}`, `${project.name}` |
| [maven-archetypes / `maven-archetype-plugin-site/src/main/resources/archetype-resources/markdown-velocity.md.vm`](https://github.com/apache/maven-archetypes/blob/master/maven-archetype-plugin-site/src/main/resources/archetype-resources/src/site/markdown/markdown-velocity.md.vm) | `${esc.d}`, `${esc.h}` |
| [maven-archetypes / `maven-archetype-site-simple/src/main/resources/archetype-resources/markdown-velocity.md.vm`](https://github.com/apache/maven-archetypes/blob/master/maven-archetype-site-simple/src/main/resources/archetype-resources/src/site/markdown/markdown-velocity.md.vm) | `${esc.d}`, `${esc.h}` |
| [maven-archetypes / `maven-archetype-site-simple/src/test/resources/projects/it-basic/reference/markdown-velocity.md.vm`](https://github.com/apache/maven-archetypes/blob/master/maven-archetype-site-simple/src/test/resources/projects/it-basic/reference/src/site/markdown/markdown-velocity.md.vm) | `${esc.d}`, `${esc.h}` |
| [maven-archetypes / `maven-archetype-site/src/main/resources/archetype-resources/markdown-velocity.md.vm`](https://github.com/apache/maven-archetypes/blob/master/maven-archetype-site/src/main/resources/archetype-resources/src/site/markdown/markdown-velocity.md.vm) | `${esc.d}`, `${esc.h}` |
| [maven-apache-resources / `incubator-disclaimer/index.md.vm`](https://github.com/apache/maven-apache-resources/blob/master/incubator-disclaimer/src/site/markdown/index.md.vm) | `${project.name}`, `${project.scm.url}`, `${project.version}` |
| [maven-apache-resources / `jar-txt/index.md.vm`](https://github.com/apache/maven-apache-resources/blob/master/jar-txt/src/site/markdown/index.md.vm) | `${project.name}`, `${project.scm.url}`, `${project.version}` |
| [maven-apache-resources / `jar/index.md.vm`](https://github.com/apache/maven-apache-resources/blob/master/jar/src/site/markdown/index.md.vm) | `${project.name}`, `${project.scm.url}`, `${project.version}` |
| [maven-apache-resources / `source-release/index.md.vm`](https://github.com/apache/maven-apache-resources/blob/master/source-release/src/site/markdown/index.md.vm) | `${project.name}`, `${project.version}` |
| [maven-parent / `docs/index.md.vm`](https://github.com/apache/maven-parent/blob/master/docs/src/site/markdown/index.md.vm) | `${esc.d}`, `${maven.site.path.suffix}`, `${maven.site.path}` |
| [maven-wagon / `wagon-providers/wagon-scm/usage.md.vm`](https://github.com/apache/maven-wagon/blob/master/wagon-providers/wagon-scm/src/site/markdown/usage.md.vm) | `${mavenScmVersion}`, `${mavenSitePluginVersion}`, `${project.version}` |
| [maven-clean-plugin / `examples/delete_additional_files.md.vm`](https://github.com/apache/maven-clean-plugin/blob/master/src/site/markdown/examples/delete_additional_files.md.vm) | `${project.basedir}`, `${project.version}` |
| [maven-install-plugin / `examples/custom-pom-installation.md.vm`](https://github.com/apache/maven-install-plugin/blob/master/src/site/markdown/examples/custom-pom-installation.md.vm) | `${project.artifactId}`, `${project.groupId}`, `${project.version}` |
| [maven-install-plugin / `examples/generic-pom-generation.md.vm`](https://github.com/apache/maven-install-plugin/blob/master/src/site/markdown/examples/generic-pom-generation.md.vm) | `${project.artifactId}`, `${project.groupId}`, `${project.version}` |
| [maven-install-plugin / `examples/installing-secondary-artifacts.md.vm`](https://github.com/apache/maven-install-plugin/blob/master/src/site/markdown/examples/installing-secondary-artifacts.md.vm) | `${project.artifactId}`, `${project.groupId}`, `${project.version}` |
| [maven-install-plugin / `examples/specific-local-repo.md.vm`](https://github.com/apache/maven-install-plugin/blob/master/src/site/markdown/examples/specific-local-repo.md.vm) | `${project.artifactId}`, `${project.groupId}`, `${project.version}` |
| [maven-resources-plugin / `examples/copy-resources.md.vm`](https://github.com/apache/maven-resources-plugin/blob/master/src/site/markdown/examples/copy-resources.md.vm) | `${basedir}`, `${project.version}` |
| [maven-resources-plugin / `examples/encoding.md.vm`](https://github.com/apache/maven-resources-plugin/blob/master/src/site/markdown/examples/encoding.md.vm) | `${esc.d}`, `${project.version}` |
| [maven-resources-plugin / `examples/escape-filtering.md.vm`](https://github.com/apache/maven-resources-plugin/blob/master/src/site/markdown/examples/escape-filtering.md.vm) | `${esc.b}`, `${esc.d}`, `${project.version}` |
| [maven-resources-plugin / `usage.md.vm`](https://github.com/apache/maven-resources-plugin/blob/master/src/site/markdown/usage.md.vm) | `${mavenFilteringVersion}` |
| [maven-ear-plugin / `examples/eclipse-and-maven-integration.md.vm`](https://github.com/apache/maven-ear-plugin/blob/master/src/site/markdown/examples/eclipse-and-maven-integration.md.vm) | `${project.build.directory}` |
| [maven-ear-plugin / `examples/filtering-advanced.md.vm`](https://github.com/apache/maven-ear-plugin/blob/master/src/site/markdown/examples/filtering-advanced.md.vm) | `${db.password}`, `${db.url}`, `${db.username}`, `${project.version}` |
| [maven-ear-plugin / `usage.md.vm`](https://github.com/apache/maven-ear-plugin/blob/master/src/site/markdown/usage.md.vm) | `${mavenArchiverVersion}`, `${mavenFilteringVersion}`, `${project.version}` |
| [maven-ejb-plugin / `usage.md.vm`](https://github.com/apache/maven-ejb-plugin/blob/master/src/site/markdown/usage.md.vm) | `${mavenArchiverVersion}`, `${mavenFilteringVersion}`, `${project.version}` |
| [maven-jar-plugin / `examples/manifest-customization.md.vm`](https://github.com/apache/maven-jar-plugin/blob/master/src/site/markdown/examples/manifest-customization.md.vm) | `${esc.d}`, `${mavenArchiverVersion}`, `${project.version}` |
| [maven-jar-plugin / `usage.md.vm`](https://github.com/apache/maven-jar-plugin/blob/master/src/site/markdown/usage.md.vm) | `${mavenArchiverVersion}` |
| [maven-rar-plugin / `examples/manifest.md.vm`](https://github.com/apache/maven-rar-plugin/blob/master/src/site/markdown/examples/manifest.md.vm) | `${basedir}`, `${project.version}` |
| [maven-rar-plugin / `examples/rar-resources.md.vm`](https://github.com/apache/maven-rar-plugin/blob/master/src/site/markdown/examples/rar-resources.md.vm) | `${basedir}`, `${esc.d}`, `${project.version}` |
| [maven-shade-plugin / `examples/resource-transformers.md.vm`](https://github.com/apache/maven-shade-plugin/blob/master/src/site/markdown/examples/resource-transformers.md.vm) | `${app.main.class}`, `${maven.compile.source}`, `${maven.compile.target}`, `${project.version}` |
| [maven-shade-plugin / `usage.md.vm`](https://github.com/apache/maven-shade-plugin/blob/master/src/site/markdown/usage.md.vm) | `${currentVersion}` |
| [maven-war-plugin / `examples/adding-filtering-webresources.md.vm`](https://github.com/apache/maven-war-plugin/blob/master/src/site/markdown/examples/adding-filtering-webresources.md.vm) | `${interpolated_property}`, `${project.version}` |
| [maven-war-plugin / `examples/war-manifest-guide.md.vm`](https://github.com/apache/maven-war-plugin/blob/master/src/site/markdown/examples/war-manifest-guide.md.vm) | `${pom.version}`, `${project.version}` |
| [maven-war-plugin / `usage.md.vm`](https://github.com/apache/maven-war-plugin/blob/master/src/site/markdown/usage.md.vm) | `${mavenArchiverVersion}`, `${mavenFilteringVersion}`, `${project.version}` |
| [maven-changelog-plugin / `changing-scm-impl.md.vm`](https://github.com/apache/maven-changelog-plugin/blob/master/src/site/markdown/changing-scm-impl.md.vm) | `${project.version}`, `${sitePluginVersion}` |
| [maven-changes-plugin / `examples/alternate-changes-xml-location.md.vm`](https://github.com/apache/maven-changes-plugin/blob/master/src/site/markdown/examples/alternate-changes-xml-location.md.vm) | `${basedir}`, `${esc.d}`, `${project.version}` |
| [maven-changes-plugin / `examples/configuring-trac-report.md.vm`](https://github.com/apache/maven-changes-plugin/blob/master/src/site/markdown/examples/configuring-trac-report.md.vm) | `${esc.d}`, `${project.version}` |
| [maven-changes-plugin / `examples/include-announcement-file.md.vm`](https://github.com/apache/maven-changes-plugin/blob/master/src/site/markdown/examples/include-announcement-file.md.vm) | `${esc.d}`, `${project.version}` |
| [maven-changes-plugin / `examples/using-a-custom-announcement-template.md.vm`](https://github.com/apache/maven-changes-plugin/blob/master/src/site/markdown/examples/using-a-custom-announcement-template.md.vm) | `${esc.d}`, `${project.version}` |
| [maven-checkstyle-plugin / `examples/custom-property-expansion.md.vm`](https://github.com/apache/maven-checkstyle-plugin/blob/master/src/site/markdown/examples/custom-property-expansion.md.vm) | `${basedir}`, `${project.version}` |
| [maven-checkstyle-plugin / `examples/upgrading-checkstyle.md.vm`](https://github.com/apache/maven-checkstyle-plugin/blob/master/src/site/markdown/examples/upgrading-checkstyle.md.vm) | `${checkstyleVersion}`, `${project.version}` |
| [maven-checkstyle-plugin / `history.md.vm`](https://github.com/apache/maven-checkstyle-plugin/blob/master/src/site/markdown/history.md.vm) | Velocity directives |
| [maven-checkstyle-plugin / `index.md.vm`](https://github.com/apache/maven-checkstyle-plugin/blob/master/src/site/markdown/index.md.vm) | `${checkstyleVersion}`, `${javaVersion}`, `${project.name}` |
| [maven-doap-plugin / `examples/with-site-plugin.md.vm`](https://github.com/apache/maven-doap-plugin/blob/master/src/site/markdown/examples/with-site-plugin.md.vm) | `${esc.d}`, `${project.version}` |
| [maven-doap-plugin / `usage.md.vm`](https://github.com/apache/maven-doap-plugin/blob/master/src/site/markdown/usage.md.vm) | `${esc.d}`, `${project.version}` |
| [maven-javadoc-plugin / `examples/aggregate-dependency-sources.md.vm`](https://github.com/apache/maven-javadoc-plugin/blob/master/src/site/markdown/examples/aggregate-dependency-sources.md.vm) | `${esc.d}`, `${project.version}` |
| [maven-javadoc-plugin / `examples/alternate-doclet.md.vm`](https://github.com/apache/maven-javadoc-plugin/blob/master/src/site/markdown/examples/alternate-doclet.md.vm) | `${esc.d}`, `${project.version}` |
| [maven-javadoc-plugin / `examples/alternate-javadoc-tool.md.vm`](https://github.com/apache/maven-javadoc-plugin/blob/master/src/site/markdown/examples/alternate-javadoc-tool.md.vm) | `${esc.d}`, `${project.version}` |
| [maven-javadoc-plugin / `examples/help-configuration.md.vm`](https://github.com/apache/maven-javadoc-plugin/blob/master/src/site/markdown/examples/help-configuration.md.vm) | `${basedir}`, `${project.version}` |
| [maven-javadoc-plugin / `examples/javadoc-resources.md.vm`](https://github.com/apache/maven-javadoc-plugin/blob/master/src/site/markdown/examples/javadoc-resources.md.vm) | `${basedir}`, `${esc.d}`, `${project.version}` |
| [maven-javadoc-plugin / `examples/links-configuration.md.vm`](https://github.com/apache/maven-javadoc-plugin/blob/master/src/site/markdown/examples/links-configuration.md.vm) | `${esc.d}`, `${project.version}` |
| [maven-javadoc-plugin / `examples/stylesheet-configuration.md.vm`](https://github.com/apache/maven-javadoc-plugin/blob/master/src/site/markdown/examples/stylesheet-configuration.md.vm) | `${basedir}`, `${project.version}` |
| [maven-javadoc-plugin / `examples/test-javadocs.md.vm`](https://github.com/apache/maven-javadoc-plugin/blob/master/src/site/markdown/examples/test-javadocs.md.vm) | `${esc.d}`, `${project.version}` |
| [maven-javadoc-plugin / `usage.md.vm`](https://github.com/apache/maven-javadoc-plugin/blob/master/src/site/markdown/usage.md.vm) | `${basedir}`, `${project.version}` |
| [maven-jdeps-plugin / `usage.md.vm`](https://github.com/apache/maven-jdeps-plugin/blob/master/src/site/markdown/usage.md.vm) | `${project.artifactId}`, `${project.version}` |
| [maven-pmd-plugin / `examples/cpdCsharp.md.vm`](https://github.com/apache/maven-pmd-plugin/blob/master/src/site/markdown/examples/cpdCsharp.md.vm) | `${basedir}`, `${pmdVersion}`, `${project.version}` |
| [maven-pmd-plugin / `examples/differentRulesetForTests.md.vm`](https://github.com/apache/maven-pmd-plugin/blob/master/src/site/markdown/examples/differentRulesetForTests.md.vm) | `${basedir}`, `${esc.d}`, `${project.version}` |
| [maven-pmd-plugin / `examples/javascriptReport.md.vm`](https://github.com/apache/maven-pmd-plugin/blob/master/src/site/markdown/examples/javascriptReport.md.vm) | `${basedir}`, `${pmdVersion}`, `${project.version}` |
| [maven-pmd-plugin / `examples/jspReport.md.vm`](https://github.com/apache/maven-pmd-plugin/blob/master/src/site/markdown/examples/jspReport.md.vm) | `${basedir}`, `${pmdVersion}`, `${project.version}` |
| [maven-pmd-plugin / `examples/multi-module-config.md.vm`](https://github.com/apache/maven-pmd-plugin/blob/master/src/site/markdown/examples/multi-module-config.md.vm) | `${pmdVersion}`, `${project.version}` |
| [maven-pmd-plugin / `examples/upgrading-PMD-at-runtime.md.vm`](https://github.com/apache/maven-pmd-plugin/blob/master/src/site/markdown/examples/upgrading-PMD-at-runtime.md.vm) | `${esc.d}`, `${pmdVersion}`, `${project.version}` |
| [maven-pmd-plugin / `examples/usingRuleSets.md.vm`](https://github.com/apache/maven-pmd-plugin/blob/master/src/site/markdown/examples/usingRuleSets.md.vm) | `${pmdVersion}`, `${project.version}` |
| [maven-pmd-plugin / `index.md.vm`](https://github.com/apache/maven-pmd-plugin/blob/master/src/site/markdown/index.md.vm) | `${javaVersion}`, `${pmdVersion}`, `${project.name}` |
| [maven-project-info-reports-plugin / `examples/custom-report.md.vm`](https://github.com/apache/maven-project-info-reports-plugin/blob/master/src/site/markdown/examples/custom-report.md.vm) | `${esc.d}`, `${project.version}` |
| [maven-archetype / `archetype-packaging/archetype-packaging.md.vm`](https://github.com/apache/maven-archetype/blob/master/archetype-packaging/src/site/markdown/archetype-packaging.md.vm) | `${project.basedir}` |
| [maven-archetype / `maven-archetype-plugin/index.md.vm`](https://github.com/apache/maven-archetype/blob/master/maven-archetype-plugin/src/site/markdown/index.md.vm) | `${javaVersion}` |
| [maven-enforcer / `enforcer-rules/evaluateBeanshell.md.vm`](https://github.com/apache/maven-enforcer/blob/master/enforcer-rules/src/site/markdown/evaluateBeanshell.md.vm) | `${project.artifactId}`, `${project.version}` |
| [maven-enforcer / `enforcer-rules/externalRules.md.vm`](https://github.com/apache/maven-enforcer/blob/master/enforcer-rules/src/site/markdown/externalRules.md.vm) | `${esc.d}`, `${project.basedir}`, `${project.version}` |
| [maven-enforcer / `enforcer-rules/requireFileChecksum.md.vm`](https://github.com/apache/maven-enforcer/blob/master/enforcer-rules/src/site/markdown/requireFileChecksum.md.vm) | `${project.build.outputDirectory}`, `${project.version}` |
| [maven-enforcer / `enforcer-rules/requireFilesDontExist.md.vm`](https://github.com/apache/maven-enforcer/blob/master/enforcer-rules/src/site/markdown/requireFilesDontExist.md.vm) | `${project.build.outputDirectory}`, `${project.version}` |
| [maven-enforcer / `enforcer-rules/requireFilesExist.md.vm`](https://github.com/apache/maven-enforcer/blob/master/enforcer-rules/src/site/markdown/requireFilesExist.md.vm) | `${project.build.outputDirectory}`, `${project.version}` |
| [maven-enforcer / `enforcer-rules/requireFilesSize.md.vm`](https://github.com/apache/maven-enforcer/blob/master/enforcer-rules/src/site/markdown/requireFilesSize.md.vm) | `${project.build.directory}`, `${project.build.outputDirectory}`, `${project.version}` |
| [maven-enforcer / `enforcer-rules/requireTextFileChecksum.md.vm`](https://github.com/apache/maven-enforcer/blob/master/enforcer-rules/src/site/markdown/requireTextFileChecksum.md.vm) | `${esc.d}`, `${project.build.outputDirectory}`, `${project.version}` |
| [maven-enforcer / `maven-enforcer-extension/usage.md.vm`](https://github.com/apache/maven-enforcer/blob/master/maven-enforcer-extension/src/site/markdown/usage.md.vm) | `${maven.home}`, `${project.version}` |
| [maven-antrun-plugin / `examples/classpaths.md.vm`](https://github.com/apache/maven-antrun-plugin/blob/master/src/site/markdown/examples/classpaths.md.vm) | Velocity directives |
| [maven-antrun-plugin / `examples/customTasks.md.vm`](https://github.com/apache/maven-antrun-plugin/blob/master/src/site/markdown/examples/customTasks.md.vm) | `${esc.d}`, `${project.version}` |
| [maven-antrun-plugin / `tasks/versionMapper.md.vm`](https://github.com/apache/maven-antrun-plugin/blob/master/src/site/markdown/tasks/versionMapper.md.vm) | `${maven.dependency.classpath}`, `${maven.project.dependencies.versions}`, `${project.version}` |
| [maven-antrun-plugin / `usage.md.vm`](https://github.com/apache/maven-antrun-plugin/blob/master/src/site/markdown/usage.md.vm) | `${esc.d}`, `${project.version}` |
| [maven-assembly-plugin / `advanced-descriptor-topics.md.vm`](https://github.com/apache/maven-assembly-plugin/blob/master/src/site/markdown/advanced-descriptor-topics.md.vm) | `${artifactId}`, `${esc.d}`, `${mdoVersion}` |
| [maven-assembly-plugin / `advanced-module-set-topics.md.vm`](https://github.com/apache/maven-assembly-plugin/blob/master/src/site/markdown/advanced-module-set-topics.md.vm) | `${esc.d}`, `${mdoVersion}`, `${module.artifactId}`, `${module.classifier}`, `${module.extension}`, `${module.groupId}`, `${module.version}` |
| [maven-assembly-plugin / `examples/multimodule/module-binary-inclusion-simple.md.vm`](https://github.com/apache/maven-assembly-plugin/blob/master/src/site/markdown/examples/multimodule/module-binary-inclusion-simple.md.vm) | `${mdoVersion}`, `${project.artifactId}`, `${project.version}` |
| [maven-assembly-plugin / `examples/multimodule/module-source-inclusion-simple.md.vm`](https://github.com/apache/maven-assembly-plugin/blob/master/src/site/markdown/examples/multimodule/module-source-inclusion-simple.md.vm) | `${esc.d}`, `${mdoVersion}`, `${module.artifactId}`, `${project.version}` |
| [maven-assembly-plugin / `examples/sharing-descriptors.md.vm`](https://github.com/apache/maven-assembly-plugin/blob/master/src/site/markdown/examples/sharing-descriptors.md.vm) | `${mdoVersion}`, `${project.version}` |
| [maven-assembly-plugin / `examples/single/filtering-some-distribution-files.md.vm`](https://github.com/apache/maven-assembly-plugin/blob/master/src/site/markdown/examples/single/filtering-some-distribution-files.md.vm) | `${basedir}`, `${esc.d}`, `${mdoVersion}`, `${project.version}` |
| [maven-assembly-plugin / `examples/single/using-components.md.vm`](https://github.com/apache/maven-assembly-plugin/blob/master/src/site/markdown/examples/single/using-components.md.vm) | `${mdoVersion}`, `${project.version}` |
| [maven-assembly-plugin / `examples/single/using-container-descriptor-handlers.md.vm`](https://github.com/apache/maven-assembly-plugin/blob/master/src/site/markdown/examples/single/using-container-descriptor-handlers.md.vm) | `${mdoVersion}`, `${project.version}` |
| [maven-assembly-plugin / `usage.md.vm`](https://github.com/apache/maven-assembly-plugin/blob/master/src/site/markdown/usage.md.vm) | `${mavenArchiverVersion}`, `${mavenFilteringVersion}`, `${project.version}` |
| [maven-dependency-plugin / `examples/copying-artifacts.md.vm`](https://github.com/apache/maven-dependency-plugin/blob/master/src/site/markdown/examples/copying-artifacts.md.vm) | `${esc.d}`, `${project.version}` |
| [maven-dependency-plugin / `examples/copying-project-dependencies.md.vm`](https://github.com/apache/maven-dependency-plugin/blob/master/src/site/markdown/examples/copying-project-dependencies.md.vm) | `${esc.d}`, `${project.version}` |
| [maven-dependency-plugin / `examples/managing-dependencies.md.vm`](https://github.com/apache/maven-dependency-plugin/blob/master/src/site/markdown/examples/managing-dependencies.md.vm) | `${my.group}` |
| [maven-dependency-plugin / `examples/render-dependencies.md.vm`](https://github.com/apache/maven-dependency-plugin/blob/master/src/site/markdown/examples/render-dependencies.md.vm) | Velocity directives |
| [maven-dependency-plugin / `examples/unpacking-artifacts.md.vm`](https://github.com/apache/maven-dependency-plugin/blob/master/src/site/markdown/examples/unpacking-artifacts.md.vm) | `${esc.d}`, `${project.version}` |
| [maven-dependency-plugin / `examples/unpacking-project-dependencies.md.vm`](https://github.com/apache/maven-dependency-plugin/blob/master/src/site/markdown/examples/unpacking-project-dependencies.md.vm) | `${esc.d}`, `${project.version}` |
| [maven-dependency-plugin / `examples/using-dependencies-sources.md.vm`](https://github.com/apache/maven-dependency-plugin/blob/master/src/site/markdown/examples/using-dependencies-sources.md.vm) | `${esc.d}`, `${project.version}` |
| [maven-remote-resources-plugin / `examples/sharing-resources.md.vm`](https://github.com/apache/maven-remote-resources-plugin/blob/master/src/site/markdown/examples/sharing-resources.md.vm) | `${esc.d}`, `${project.version}` |
| [maven-remote-resources-plugin / `index.md.vm`](https://github.com/apache/maven-remote-resources-plugin/blob/master/src/site/markdown/index.md.vm) | `${esc.d}`, `${project.name}` |
| [maven-remote-resources-plugin / `usage.md.vm`](https://github.com/apache/maven-remote-resources-plugin/blob/master/src/site/markdown/usage.md.vm) | `${esc.d}`, `${mavenFilteringVersion}`, `${project.version}` |
| [maven-scm-publish-plugin / `examples/one-module-configuration.md.vm`](https://github.com/apache/maven-scm-publish-plugin/blob/master/src/site/markdown/examples/one-module-configuration.md.vm) | `${esc.d}`, `${project.version}` |
| [maven-scm-publish-plugin / `various-tips.md.vm`](https://github.com/apache/maven-scm-publish-plugin/blob/master/src/site/markdown/various-tips.md.vm) | `${esc.d}`, `${project.scm.developerConnection}`, `${project.version}`, `${scmPubCheckoutDirectory}`, `${user.home}` |
| [maven-plugin-tools / `maven-plugin-annotations/index.md.vm`](https://github.com/apache/maven-plugin-tools/blob/master/maven-plugin-annotations/src/site/markdown/index.md.vm) | `${project.description}`, `${project.name}` |
| [maven-plugin-tools / `maven-plugin-plugin/examples/generate-descriptor.md.vm`](https://github.com/apache/maven-plugin-tools/blob/master/maven-plugin-plugin/src/site/markdown/examples/generate-descriptor.md.vm) | `${esc.d}`, `${project.version}` |
| [maven-plugin-tools / `maven-plugin-plugin/examples/generate-help.md.vm`](https://github.com/apache/maven-plugin-tools/blob/master/maven-plugin-plugin/src/site/markdown/examples/generate-help.md.vm) | `${esc.d}`, `${project.version}` |
| [maven-plugin-tools / `maven-plugin-report-plugin/examples/generate-report.md.vm`](https://github.com/apache/maven-plugin-tools/blob/master/maven-plugin-report-plugin/src/site/markdown/examples/generate-report.md.vm) | `${esc.d}`, `${project.version}` |
| [maven-filtering / `index.md.vm`](https://github.com/apache/maven-filtering/blob/master/src/site/markdown/index.md.vm) | `${esc.d}`, `${project.name}` |
| [maven-shared-resources / `index.md.vm`](https://github.com/apache/maven-shared-resources/blob/master/src/site/markdown/index.md.vm) | `${project.name}`, `${project.version}` |
| [maven-shared-resources / `maven_checks.md.vm`](https://github.com/apache/maven-shared-resources/blob/master/src/site/markdown/maven_checks.md.vm) | `${project.basedir}` |
| [maven-shared-resources / `usage.md.vm`](https://github.com/apache/maven-shared-resources/blob/master/src/site/markdown/usage.md.vm) | `${project.artifactId}`, `${project.groupId}`, `${project.version}` |
</details>
--
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: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Migrate Maven site documentation from APT to Markdown [maven-doxia-converter]
Posted by "slachiewicz (via GitHub)" <gi...@apache.org>.
slachiewicz commented on issue #139:
URL: https://github.com/apache/maven-doxia-converter/issues/139#issuecomment-5198504236
## Progress update
308 of 729 site APT documents converted, 421 remaining (of which about 300 are in scope; the rest are the archived SVN sandbox, `codehaus-plexus.github.io` and the Maven 3 branches).
Converted since the issue was opened: 31 repositories in the small-plugin tranche and 12 in the mid-size tranche, roughly 300 pages. Each is a single commit on a `site-apt-to-markdown` branch, verified by building the site before and after and comparing the visible text and link targets of every generated page.
### Further traps found
**A backslash does not reliably escape a reference.** `\${foo}` only renders as `${foo}` when `foo` resolves in the document's Velocity context; when it does not, Velocity emits the backslash too and the page shows `\${foo}`. `${esc.d}{foo}` always yields a literal dollar and is what these pages now use. 138 occurrences were affected.
**An APT table caption has no Markdown equivalent.** `<caption>` is dropped and the caption text ends up as a paragraph after the table.
**Intraword emphasis does not survive.** The sink writes `_x_`, which CommonMark does not treat as emphasis when it follows a word character, so `Set<i>String</i>` rendered as literal `Set_String_`. Only one page was affected, and there the APT rendering was itself wrong: the source meant the Java type `Set<String>` and APT had read the angle brackets as italic markup.
**Bold ending in an asterisk.** `**maven.source.***` parses as `**maven.source.**` followed by a stray `*`.
**A non-UTF-8 output file.** The converter follows the autodetected input encoding, and an ASCII source is detected as ISO-8859-1, so an APT escaped space (which becomes U+00A0) is written as a lone `0xa0` byte. Passing `-outEncoding UTF-8` avoids it.
### Worth noting
Several differences the comparison flagged turned out to be pre-existing faults in the APT rendering that the conversion repairs:
- `{{{#Identity Mapper}Identity Mapper}}` rendered as `href="#Identity Mapper"` pointing at `id="Identity_Mapper"`, so the link never resolved.
- `<<<${basedir}/...>>>` rendered as `$<a id="basedir">basedir</a>/...`, an anchor APT invented from the braces.
- `<<<\<overlay\>>>>` rendered with an anchor spliced into the middle of the code span.
The accepted remaining differences are `<b>`/`<i>` becoming `<strong>`/`<em>`, and quotes and ellipses in prose picking up the Markdown module's typographic substitution. Code spans and code blocks are left alone by that substitution.
--
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: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org