You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by sl...@apache.org on 2026/08/09 15:55:22 UTC
(maven-plugin-tools) branch master updated (c6319288 -> de4eb023)
This is an automated email from the ASF dual-hosted git repository.
slachiewicz pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/maven-plugin-tools.git
from c6319288 [MPLUGIN-421] Address JavaParser review feedback
new 926e1d1b Rename the site document ahead of converting it
new de4eb023 Convert the index page from xdoc to Markdown
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
src/site/markdown/index.md | 69 +++++++++++++++++++++++
src/site/xdoc/index.xml | 135 ---------------------------------------------
2 files changed, 69 insertions(+), 135 deletions(-)
create mode 100644 src/site/markdown/index.md
delete mode 100644 src/site/xdoc/index.xml
(maven-plugin-tools) 01/02: Rename the site document ahead of converting it
Posted by sl...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
slachiewicz pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-plugin-tools.git
commit 926e1d1b909959e73aaa65667f61ce86efb6abb5
Author: Sylwester Lachiewicz <sl...@apache.org>
AuthorDate: Sun Aug 9 17:34:48 2026 +0200
Rename the site document ahead of converting it
Git's rename detection is similarity-based, so a rename and a rewrite in
one commit is recorded as a delete plus an add and git log --follow stops
there. Please merge or rebase rather than squash.
Generated-by: Claude Opus 5 (1M context)
---
src/site/{xdoc/index.xml => markdown/index.md} | 0
1 file changed, 0 insertions(+), 0 deletions(-)
diff --git a/src/site/xdoc/index.xml b/src/site/markdown/index.md
similarity index 100%
rename from src/site/xdoc/index.xml
rename to src/site/markdown/index.md
(maven-plugin-tools) 02/02: Convert the index page from xdoc to Markdown
Posted by sl...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
slachiewicz pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-plugin-tools.git
commit de4eb023b586773673c8c54367621c25f0c96cc7
Author: Sylwester Lachiewicz <sl...@apache.org>
AuthorDate: Sun Aug 9 17:36:45 2026 +0200
Convert the index page from xdoc to Markdown
Converted with doxia-converter. The YAML front matter is kept: it carries
the page's title and author, which the skin turns into <title> and
<meta name="author">.
The SVG dependency diagram is written back as inline HTML. The converter
drops the <object> embed -- "Unknown Sink event 'object', ignoring!" --
which would have removed the diagram entirely. Markdown has no equivalent,
and Doxia passes the raw block through unchanged.
The only rendering difference is that a non-breaking space is now written
  where it was   -- the same character in hexadecimal.
Verified by rendering the site before and after and comparing the two on
title, author, visible text and every link target.
Generated-by: Claude Opus 5 (1M context)
---
src/site/markdown/index.md | 164 ++++++++++++++-------------------------------
1 file changed, 49 insertions(+), 115 deletions(-)
diff --git a/src/site/markdown/index.md b/src/site/markdown/index.md
index 4231b1ae..61db4d91 100644
--- a/src/site/markdown/index.md
+++ b/src/site/markdown/index.md
@@ -1,4 +1,9 @@
-<?xml version="1.0"?>
+---
+title: Introduction
+author:
+ - Vincent Siveton
+ - Hervé Boutemy
+---
<!--
/*
@@ -19,117 +24,46 @@
*/
-->
-<document xmlns="http://maven.apache.org/XDOC/2.0"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
-
- <properties>
- <title>Introduction</title>
- <author>Vincent Siveton</author>
- <author email="hboutemy_AT_apache_DOT_org">Hervé Boutemy</author>
- </properties>
-
- <body>
-
- <section name="Maven Plugin Tools">
-
- <p>The Maven Plugin Tools contains the necessary tools to generate repetitive content such as descriptor,
- help, and documentation.</p>
-
- <p>
- <object type="image/svg+xml" data="images/plugin-tools-deps.svg" width="643" height="284">
- </object>
- </p>
-
- <table>
- <tr><th><b>Module</b></th><th><b>Overview</b></th></tr>
- <tr>
- <td><b><a href="./maven-plugin-plugin/index.html">maven-plugin-plugin</a></b></td>
- <td>Create a Maven plugin descriptor for any mojos found in the source tree, generate reports, create help goal.</td>
- </tr>
- <tr>
- <td><b><a href="./maven-plugin-report-plugin/index.html">maven-plugin-report-plugin</a></b></td>
- <td>The Plugin Report Plugin is used to create reports about the plugin being built.</td>
- </tr>
- <tr>
- <td><a href="./maven-plugin-tools-generators/index.html">maven-plugin-tools-generators</a></td>
- <td>Generators (XML descriptor, help, documentation), used by maven-plugin-plugin to generate content from descriptor extracted from sources.</td>
- </tr>
- <tr>
- <td><a href="./maven-plugin-tools-api/index.html">maven-plugin-tools-api</a></td>
- <td>Extractor API, used by maven-plugin-plugin to extract Mojo information.</td>
- </tr>
- <tr>
- <td> <a href="./maven-plugin-tools-java/index.html">maven-plugin-tools-java</a></td>
- <td>Extractor for plugins written in Java annotated with Mojo Javadoc Tags.</td>
- </tr>
- <tr>
- <td> <a href="./maven-plugin-tools-annotations/index.html">maven-plugin-tools-annotations</a></td>
- <td>Extractor for plugins written in Java with Java annotations.</td>
- </tr>
- <tr>
- <td> <a href="./maven-plugin-annotations/index.html">maven-plugin-annotations</a></td>
- <td>Provides the Java annotations to use in Mojos.</td>
- </tr>
- <tr>
- <td><a href="./maven-script/index.html">maven-script</a> (deprecated)</td>
- <td>Maven Script Mojo Support lets developer write Maven plugins/goals with scripting languages instead of compiled Java.<br/>
- Deprecated since 3.7.0</td>
- </tr>
- </table>
-
- <subsection name="Plugin Descriptors">
- <p>The plugin descriptor is first being generated in memory finally containing some values in HTML format before being persisted into three different XML files.
- The formats differ in
- <ul>
- <li>whether they contain all elements or just a limited set of elements defined by the <a href="https://maven.apache.org/ref/current/maven-plugin-api/plugin.html">Plugin Descriptor Spec</a></li>
- <li>whether descriptive elements contain HTML or plain text values</li>
- <li>whether they are packaged in the resulting JAR or not</li>
- </ul>
- Javadoc tags are in general being resolved and replaced by their XHTML value before they end up in the according plugin descriptor attributes <code>description</code> and <code>deprecated</code>.
- Also javadoc code links via <code>{@link}</code> or <code>@see</code> are replaced by links to the according Javadoc pages if configured accordingly.
- Plaintext is afterwards being generated out of the XHTML (where most XHTML element are just stripped and links are emitted inside angle brackets).
- </p>
- <table>
- <tr>
- <th>File name</th>
- <th>Allows HTML</th>
- <th>Limited Elements</th>
- <th>Contained in JAR</th>
- </tr>
- <tr>
- <td>plugin.xml</td>
- <td>no</td>
- <td>no</td>
- <td>yes</td>
- </tr>
- <tr>
- <td>plugin-help.xml</td>
- <td>no</td>
- <td>yes</td>
- <td>yes</td>
- </tr>
- <tr>
- <td>plugin-enhanced.xml</td>
- <td>yes</td>
- <td>yes</td>
- <td>no (volatile file)</td>
- </tr>
- </table>
- <p>
- <img src="images/plugin-descriptors.svg" width="759" border="0" />
- </p>
- </subsection>
-
- <subsection name="See Also">
- <ul>
- <li><a href="/plugin-testing/">Maven Plugin Testing</a></li>
- <li><a href="/ref/current/maven-plugin-api/">Maven Plugin API</a></li>
- </ul>
- </subsection>
-
- </section>
-
- </body>
-
-</document>
+<object type="image/svg+xml" data="images/plugin-tools-deps.svg" width="643" height="284">
+</object>
+
+# Maven Plugin Tools
+
+The Maven Plugin Tools contains the necessary tools to generate repetitive content such as descriptor, help, and documentation.
+
+|**Module**|**Overview**|
+|---|---|
+|**[maven-plugin-plugin](./maven-plugin-plugin/index.html)**|Create a Maven plugin descriptor for any mojos found in the source tree, generate reports, create help goal.|
+|**[maven-plugin-report-plugin](./maven-plugin-report-plugin/index.html)**|The Plugin Report Plugin is used to create reports about the plugin being built.|
+|[maven-plugin-tools-generators](./maven-plugin-tools-generators/index.html)|Generators (XML descriptor, help, documentation), used by maven-plugin-plugin to generate content from descriptor extracted from sources.|
+|[maven-plugin-tools-api](./maven-plugin-tools-api/index.html)|Extractor API, used by maven-plugin-plugin to extract Mojo information.|
+| [maven-plugin-tools-java](./maven-plugin-tools-java/index.html)|Extractor for plugins written in Java annotated with Mojo Javadoc Tags.|
+| [maven-plugin-tools-annotations](./maven-plugin-tools-annotations/index.html)|Extractor for plugins written in Java with Java annotations.|
+| [maven-plugin-annotations](./maven-plugin-annotations/index.html)|Provides the Java annotations to use in Mojos.|
+|[maven-script](./maven-script/index.html) (deprecated)|Maven Script Mojo Support lets developer write Maven plugins/goals with scripting languages instead of compiled Java.<br />Deprecated since 3.7.0|
+
+## Plugin Descriptors
+
+The plugin descriptor is first being generated in memory finally containing some values in HTML format before being persisted into three different XML files. The formats differ in
+- whether they contain all elements or just a limited set of elements defined by the [Plugin Descriptor Spec](https://maven.apache.org/ref/current/maven-plugin-api/plugin.html)
+
+- whether descriptive elements contain HTML or plain text values
+
+- whether they are packaged in the resulting JAR or not
+
+Javadoc tags are in general being resolved and replaced by their XHTML value before they end up in the according plugin descriptor attributes `description` and `deprecated`. Also javadoc code links via `{@link}` or `@see` are replaced by links to the according Javadoc pages if configured accordingly. Plaintext is afterwards being generated out of the XHTML (where most XHTML element are just stripped and links are emitted inside angle brackets).
+
+|File name|Allows HTML|Limited Elements|Contained in JAR|
+|---|---|---|---|
+|plugin.xml|no|no|yes|
+|plugin-help.xml|no|yes|yes|
+|plugin-enhanced.xml|yes|yes|no (volatile file)|
+
+
+
+## See Also
+
+- [Maven Plugin Testing](/plugin-testing/)
+
+- [Maven Plugin API](/ref/current/maven-plugin-api/)
+