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 11:05:18 UTC
(maven-site) 01/01: Stop pointing the report plugin guide at the retired PDF plugin
This is an automated email from the ASF dual-hosted git repository.
slachiewicz pushed a commit to branch drop-retired-pdf-plugin-references
in repository https://gitbox.apache.org/repos/asf/maven-site.git
commit 39768e3ca291d1138ce8a0552c5f5b1f76169f3c
Author: Sylwester Lachiewicz <sl...@apache.org>
AuthorDate: Sun Aug 9 13:04:29 2026 +0200
Stop pointing the report plugin guide at the retired PDF plugin
The guide recommended it twice, both times as `maven-pdf-site` — a name the
plugin never had — while linking to /plugins/maven-pdf-plugin/. That plugin was
retired in March 2025, so the introduction now names only maven-site-plugin.
The second mention was an example of a non-HTML renderer, and there is no
surviving plugin to swap in: Doxia's iText and FO modules went with DOXIA-630 in
2.0.0-M1, so the sentence names the remaining criterion instead — any Sink other
than the XHTML5 one.
Generated-by: Claude Opus 5 (1M context)
---
.../markdown/guides/plugin/guide-java-report-plugin-development.md.vm | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/content/markdown/guides/plugin/guide-java-report-plugin-development.md.vm b/content/markdown/guides/plugin/guide-java-report-plugin-development.md.vm
index 82175814..843fab17 100644
--- a/content/markdown/guides/plugin/guide-java-report-plugin-development.md.vm
+++ b/content/markdown/guides/plugin/guide-java-report-plugin-development.md.vm
@@ -27,7 +27,7 @@ under the License.
# Introduction
-This guide is intended to assist users in developing reporting plugins for Maven in Java, that will contribute to sites generated by [`maven-site-plugin`](/plugins/maven-site-plugin/) or site PDF documents generated by [`maven-pdf-site`](/plugins/maven-pdf-plugin/).
+This guide is intended to assist users in developing reporting plugins for Maven in Java, that will contribute to sites generated by [`maven-site-plugin`](/plugins/maven-site-plugin/).
First and foremost, a _report plugin_ is a _Maven plugin_ and it is strongly advised to first read the [Guide to Developing Java Plugins](./guide-java-plugin-development.html) to properly understand its core mechanisms.
@@ -395,7 +395,7 @@ At the very least, a document should include the following:
- Body (`sink.body()`)
- Section 1 with title (`sink.section1()` and `sink.sectionTitle1()`)
-The [`Sink`](/doxia/doxia/doxia-sink-api/apidocs/org/apache/maven/doxia/sink/Sink.html) object allows you to add raw text with the _rawText()_ method. More precisely, it allows you to add raw HTML code into the document for full flexibility. However, you should limit the usage of this method as you may add elements that are not supported by non-HTML renderers (like [`maven-pdf-site`](/plugins/maven-pdf-plugin/)).
+The [`Sink`](/doxia/doxia/doxia-sink-api/apidocs/org/apache/maven/doxia/sink/Sink.html) object allows you to add raw text with the _rawText()_ method. More precisely, it allows you to add raw HTML code into the document for full flexibility. However, you should limit the usage of this method as you may add elements that are not supported by non-HTML renderers, i.e. any Doxia Sink other than the XHTML5 one.
The Doxia Sink API allows you to specify [_SinkEventAttributes_](/doxia/doxia/doxia-sink-api/apidocs/org/apache/maven/doxia/sink/SinkEventAttributes.html) to each element, i.e. HTML properties, notably the class and the ID of an object, which allows for easy customization with an appropriate CSS (either provided by the specified Maven Skin, or by the project itself).