You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2017/11/17 09:43:09 UTC
svn commit: r1815558 - in /maven/site/trunk/content:
apt/guides/plugin/guide-java-report-plugin-development.apt
apt/plugin-developers/index.apt site.xml
Author: hboutemy
Date: Fri Nov 17 09:43:09 2017
New Revision: 1815558
URL: http://svn.apache.org/viewvc?rev=1815558&view=rev
Log:
added report plugin introduction
Added:
maven/site/trunk/content/apt/guides/plugin/guide-java-report-plugin-development.apt
Modified:
maven/site/trunk/content/apt/plugin-developers/index.apt
maven/site/trunk/content/site.xml
Added: maven/site/trunk/content/apt/guides/plugin/guide-java-report-plugin-development.apt
URL: http://svn.apache.org/viewvc/maven/site/trunk/content/apt/guides/plugin/guide-java-report-plugin-development.apt?rev=1815558&view=auto
==============================================================================
--- maven/site/trunk/content/apt/guides/plugin/guide-java-report-plugin-development.apt (added)
+++ maven/site/trunk/content/apt/guides/plugin/guide-java-report-plugin-development.apt Fri Nov 17 09:43:09 2017
@@ -0,0 +1,50 @@
+ ------
+ Guide to Developing Java Report Plugins
+ ------
+ Hervé Boutemy
+ ------
+ 2017-11-16
+ ------
+
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements. See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership. The ASF licenses this file
+~~ to you under the Apache License, Version 2.0 (the
+~~ "License"); you may not use this file except in compliance
+~~ with the License. You may obtain a copy of the License at
+~~
+~~ http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing,
+~~ software distributed under the License is distributed on an
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+~~ KIND, either express or implied. See the License for the
+~~ specific language governing permissions and limitations
+~~ under the License.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/doxia/references/apt-format.html
+
+Introduction
+
+ This guide is intended to assist users in developing Java reporting plugins for
+ Maven that will contribute to sites generated by {{{/plugins/maven-site-plugin/}<<<maven-site-plugin>>>}}
+ or site pdf documents generated by {{{/plugins/maven-pdf-plugin/}<<<maven-pdf-site>>>}}.
+
+ Any Mojo becomes a <report> Mojo when it implements {{{/shared/maven-reporting-api/}Maven Reporting API}}. Then a plugin
+ may have some reporting goals and some build (non-reporting) goals.
+
+ Work In Progress (external reports, Doxia Sink API vs generated markup in <<<target/generated-site/>>>)...
+
+* Resources
+
+ [[1]] {{{./guide-java-plugin-development.html}Guide to Developing Java Plugins}}: Starting point, since a reporting plugin is a plugin...
+
+ [[2]] {{{/shared/maven-reporting-api/}Maven Reporting API}}: The Reporting API to implement when a Mojo provides reporting for site.
+
+ [[3]] {{{/shared/maven-reporting-impl/}Maven Reporting Implementation}}: Base implementation of both Reporting API and Plugin API.
+
+ [[4]] {{{/doxia/doxia/doxia-sink-api/}Doxia Sink API}}: API to generate content.
+
+ []
Modified: maven/site/trunk/content/apt/plugin-developers/index.apt
URL: http://svn.apache.org/viewvc/maven/site/trunk/content/apt/plugin-developers/index.apt?rev=1815558&r1=1815557&r2=1815558&view=diff
==============================================================================
--- maven/site/trunk/content/apt/plugin-developers/index.apt (original)
+++ maven/site/trunk/content/apt/plugin-developers/index.apt Fri Nov 17 09:43:09 2017
@@ -28,7 +28,7 @@
Plugin Developers Centre
- This documentation centre is for those that are developing Maven plugins. This might be for your own build, or as
+ This documentation centre is for those who are developing Maven plugins. This might be for your own build, or as
an accompaniment to your third party tool.
~~TODO: callout
@@ -42,6 +42,8 @@ Plugin Developers Centre
* {{{../guides/plugin/guide-java-plugin-development.html} Your First Mojo}} - Learn how to write your first plugin
+ * {{{../guides/plugin/guide-java-report-plugin-development.html} Your First Mojo}} - Learn how to write your first reporting plugin
+
* {{{./plugin-testing.html} Testing your Plugin}} - How to write tests for your plugins
* {{{./plugin-documenting.html} Documenting your Plugin}} - How to write documentation for your plugins
Modified: maven/site/trunk/content/site.xml
URL: http://svn.apache.org/viewvc/maven/site/trunk/content/site.xml?rev=1815558&r1=1815557&r2=1815558&view=diff
==============================================================================
--- maven/site/trunk/content/site.xml (original)
+++ maven/site/trunk/content/site.xml Fri Nov 17 09:43:09 2017
@@ -82,8 +82,9 @@ under the License.
<item name="POM Reference" href="/pom.html" />
</item>
<item name="Plugin Developer Centre" href="/plugin-developers/index.html" collapse="true">
- <item name="Introduction to Plugin Development" href="/guides/introduction/introduction-to-plugins.html" />
+ <item name="Introduction" href="/guides/introduction/introduction-to-plugins.html" />
<item name="Your First Mojo" href="/guides/plugin/guide-java-plugin-development.html" />
+ <item name="Your First Report Mojo" href="/guides/plugin/guide-java-report-plugin-development.html" />
<item name="Mojo API" href="/developers/mojo-api-specification.html" />
<item name="Maven API" href="/ref/current/index.html"/>
</item>