You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by mi...@apache.org on 2023/04/04 06:22:57 UTC
[maven-site-plugin] branch renames updated (a2ff1d9e -> ad7096a9)
This is an automated email from the ASF dual-hosted git repository.
michaelo pushed a change to branch renames
in repository https://gitbox.apache.org/repos/asf/maven-site-plugin.git
omit a2ff1d9e [MSITE-935] Upgrade to Doxia Sitetools 2.0.0-M6, Maven Reporting Impl/Exec 4.0.0-M6
add 5dca54bf [MSITE-934] Log output of site:run does not show locale
add e1c223ed [MSITE-937] Sitemap creates non-consecutive headings
add 5731eb95 [MSITE-938] Sitemap creates empty entry if href is null although menu item name isn't
new ad7096a9 [MSITE-935] Upgrade to Doxia Sitetools 2.0.0-M6, Maven Reporting Impl/Exec 4.0.0-M6
This update added new revisions after undoing existing revisions.
That is to say, some revisions that were in the old version of the
branch are not in the new version. This situation occurs
when a user --force pushes a change and generates a repository
containing something like this:
* -- * -- B -- O -- O -- O (a2ff1d9e)
\
N -- N -- N refs/heads/renames (ad7096a9)
You should already have received notification emails for all of the O
revisions, and so the following emails describe only the N revisions
from the common base, B.
Any revisions marked "omit" are not gone; other references still
refer to them. Any revisions marked "discard" are gone forever.
The 1 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:
.../java/org/apache/maven/plugins/site/render/SiteMap.java | 12 +++++++-----
.../java/org/apache/maven/plugins/site/run/DoxiaFilter.java | 13 +++++++++----
2 files changed, 16 insertions(+), 9 deletions(-)
[maven-site-plugin] 01/01: [MSITE-935] Upgrade to Doxia Sitetools 2.0.0-M6, Maven Reporting Impl/Exec 4.0.0-M6
Posted by mi...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
michaelo pushed a commit to branch renames
in repository https://gitbox.apache.org/repos/asf/maven-site-plugin.git
commit ad7096a970d9b17ea9918ad75d50df42ee5f897b
Author: Michael Osipov <mi...@apache.org>
AuthorDate: Sun Mar 26 22:37:11 2023 +0200
[MSITE-935] Upgrade to Doxia Sitetools 2.0.0-M6, Maven Reporting Impl/Exec 4.0.0-M6
This closes #135
---
pom.xml | 8 ++---
src/it/projects/MSITE-159/pom.xml | 2 +-
.../src/site/apt/velocity-context.apt.vm | 36 +++++++++++-----------
.../full-reporting/src/site/apt/index.apt.vm | 6 ++--
.../child/src/site/apt/index.apt | 8 ++---
src/it/projects/inheritance-interpolation/pom.xml | 2 +-
.../reactor-parent/src/site/apt/index.apt | 4 +--
.../inheritance-interpolation/verify.groovy | 2 +-
.../src/main/resources/META-INF/maven/site.vm | 4 +--
.../plugins/site/deploy/AbstractDeployMojo.java | 2 +-
.../descriptor/AbstractSiteDescriptorMojo.java | 30 +++++++++---------
.../plugins/site/descriptor/EffectiveSiteMojo.java | 19 +++++-------
.../descriptor/SiteDescriptorArtifactMetadata.java | 12 ++++----
.../site/render/AbstractSiteRenderingMojo.java | 36 +++++++++++-----------
.../render/CategorySummaryDocumentRenderer.java | 14 ++++-----
.../site/render/ReportDocumentRenderer.java | 22 ++++++-------
.../apache/maven/plugins/site/render/SiteMap.java | 18 +++++------
.../apache/maven/plugins/site/render/SiteMojo.java | 2 +-
.../apache/maven/plugins/site/run/DoxiaFilter.java | 6 ++--
src/site/apt/examples/sitedescriptor.apt | 4 +--
20 files changed, 117 insertions(+), 120 deletions(-)
diff --git a/pom.xml b/pom.xml
index d4929d29..197163cc 100644
--- a/pom.xml
+++ b/pom.xml
@@ -198,7 +198,7 @@ under the License.
<!-- for dependencies -->
<jettyVersion>9.4.50.v20221201</jettyVersion>
<doxiaVersion>2.0.0-M6</doxiaVersion>
- <doxiaSitetoolsVersion>2.0.0-M6</doxiaSitetoolsVersion>
+ <doxiaSitetoolsVersion>2.0.0-M7</doxiaSitetoolsVersion>
<wagonVersion>3.5.3</wagonVersion>
<slf4jVersion>1.7.36</slf4jVersion>
<!-- for ITs -->
@@ -209,7 +209,7 @@ under the License.
<projectInfoReportsPluginVersion>3.4.2</projectInfoReportsPluginVersion>
<surefirePluginVersion>3.0.0</surefirePluginVersion>
<mavenPluginPluginVersion>3.8.1</mavenPluginPluginVersion>
- <mavenReportingImplVersion>4.0.0-M5</mavenReportingImplVersion>
+ <mavenReportingImplVersion>4.0.0-M6</mavenReportingImplVersion>
<fluidoSkinVersion>2.0.0-M3</fluidoSkinVersion>
<surefire.version>3.0.0</surefire.version>
<project.build.outputTimestamp>2023-03-20T07:40:44Z</project.build.outputTimestamp>
@@ -225,7 +225,7 @@ under the License.
<dependency>
<groupId>org.apache.maven.reporting</groupId>
<artifactId>maven-reporting-exec</artifactId>
- <version>2.0.0-M5</version>
+ <version>2.0.0-M6</version>
</dependency>
<dependency>
<groupId>org.apache.maven.shared</groupId>
@@ -370,7 +370,7 @@ under the License.
<!-- Doxia Sitetools -->
<dependency>
<groupId>org.apache.maven.doxia</groupId>
- <artifactId>doxia-decoration-model</artifactId>
+ <artifactId>doxia-site-model</artifactId>
<version>${doxiaSitetoolsVersion}</version>
</dependency>
diff --git a/src/it/projects/MSITE-159/pom.xml b/src/it/projects/MSITE-159/pom.xml
index b5772b5d..374bf377 100644
--- a/src/it/projects/MSITE-159/pom.xml
+++ b/src/it/projects/MSITE-159/pom.xml
@@ -49,7 +49,7 @@ under the License.
<artifactId>maven-site-plugin</artifactId>
<version>@project.version@</version>
<configuration>
- <relativizeDecorationLinks>false</relativizeDecorationLinks>
+ <relativizeSiteLinks>false</relativizeSiteLinks>
</configuration>
</plugin>
</plugins>
diff --git a/src/it/projects/doxia-formats/src/site/apt/velocity-context.apt.vm b/src/it/projects/doxia-formats/src/site/apt/velocity-context.apt.vm
index d559ecac..d1c873e5 100644
--- a/src/it/projects/doxia-formats/src/site/apt/velocity-context.apt.vm
+++ b/src/it/projects/doxia-formats/src/site/apt/velocity-context.apt.vm
@@ -37,7 +37,7 @@ Doxia Site Renderer Velocity Context
*-----------------------+-------------------------------------------------------+-----+
#foreach( $key in $sorter.sort( $context.keys ) )
#set( $value = $context.get($key) )
-| <<<$key>>> | <<<#if ($value)$value.class.name#else?#end>>> | #if ($key != "decoration" && $key != "link")#if ($value)<<<$StringUtils.replace($value, '\' , '\\')>>>#end#end|
+| <<<$key>>> | <<<#if ($value)$value.class.name#else?#end>>> | #if ($key != "decoration" && $key != "site" && $key != "link")#if ($value)<<<$StringUtils.replace($value, '\' , '\\')>>>#end#end|
*-----------------------+-------------------------------------------------------+-----+
#end
@@ -45,25 +45,25 @@ Doxia Site Renderer Velocity Context
* Document Variables
-*-----------------------*-------------------------------------------------------*
-|| variable || examples ||
-*-----------------------+-------------------------------------------------------+
-| <<<alignedFileName>>> | = <<<$alignedFileName>>>
-*-----------------------+-------------------------------------------------------+
-| <<<decoration>>> | <<<decoration.name>>> = <<<$decoration.name>>>
-*-----------------------+-------------------------------------------------------+
-| <<<currentFileName>>> | = <<<$currentFileName>>>
-*-----------------------+-------------------------------------------------------+
+*------------------------*-------------------------------------------------------*
+|| variable || examples ||
+*------------------------+-------------------------------------------------------+
+| <<<alignedFileName>>> | = <<<$alignedFileName>>>
+*------------------------+-------------------------------------------------------+
+| <<<site>>> | <<<site.name>>> = <<<$site.name>>>
+*------------------------+-------------------------------------------------------+
+| <<<currentFileName>>> | = <<<$currentFileName>>>
+*------------------------+-------------------------------------------------------+
| <<<doxiaSiteRendererVersion>>> | = <<<$doxiaSiteRendererVersion>>>
-*-----------------------+-------------------------------------------------------+
-| <<<locale>>> | = <<<$locale>>>
-*-----------------------+-------------------------------------------------------+
-| <<<publishDate>>> | = <<<$publishDate>>>
-*-----------------------+-------------------------------------------------------+
-| <<<relativePath>>> | = <<<$relativePath>>>
-*-----------------------+-------------------------------------------------------+
+*------------------------+-------------------------------------------------------+
+| <<<locale>>> | = <<<$locale>>>
+*------------------------+-------------------------------------------------------+
+| <<<publishDate>>> | = <<<$publishDate>>>
+*------------------------+-------------------------------------------------------+
+| <<<relativePath>>> | = <<<$relativePath>>>
+*------------------------+-------------------------------------------------------+
| <<<supportedLocales>>> | = <<<$supportedLocales>>>
-*-----------------------+-------------------------------------------------------+
+*------------------------+-------------------------------------------------------+
* Tools
diff --git a/src/it/projects/full-reporting/src/site/apt/index.apt.vm b/src/it/projects/full-reporting/src/site/apt/index.apt.vm
index def785c8..90c9e7d3 100644
--- a/src/it/projects/full-reporting/src/site/apt/index.apt.vm
+++ b/src/it/projects/full-reporting/src/site/apt/index.apt.vm
@@ -28,7 +28,7 @@
Velocity processing
- See doxia-siterendering: site decoration and documents with file names ending in <<<.vm>>> are processed by Velocity.
+ See doxia-siterendering: site and documents with file names ending in <<<.vm>>> are processed by Velocity.
The velocity context defines some variables:
@@ -45,8 +45,6 @@ Velocity processing
*---------------------------------+--------------------+-------------------------------+
| <<<bodyContent>>> | <<<String>>> | $bodyContent |
*---------------------------------+--------------------+-------------------------------+
-| <<<decoration>>> | {{{../doxia-decoration-model/apidocs/org/apache/maven/doxia/site/decoration/DecorationModel.html}<<<DecorationModel>>>}} | $decoration.name |
-*---------------------------------+--------------------+-------------------------------+
| <<<dateCreation>>> | <<<String>>> | $dateCreation |
*---------------------------------+--------------------+-------------------------------+
| <<<dateRevision>>> | <<<String>>> | $dateRevision |
@@ -63,6 +61,8 @@ Velocity processing
*---------------------------------+--------------------+-------------------------------+
| <<<supportedLocales>>> | <<<List\<Locale\>>>> | $supportedLocales |
*---------------------------------+--------------------+-------------------------------+
+| <<<site>>> | {{{../doxia-site-model/apidocs/org/apache/maven/doxia/site/SiteModel.html}<<<SiteModel>>>}} | $site.name |
+*---------------------------------+--------------------+-------------------------------+
| <template properties> | | Properties defined by caller: see below for properties defined by <<<maven-site-plugin>>> |
*---------------------------------+--------------------+-------------------------------+
| <<<PathTool>>> | {{{http://plexus.codehaus.org/plexus-utils/apidocs/org/codehaus/plexus/util/PathTool.html}<<<PathTool>>>}} | $PathTool |
diff --git a/src/it/projects/inheritance-interpolation/child/src/site/apt/index.apt b/src/it/projects/inheritance-interpolation/child/src/site/apt/index.apt
index a79b4846..8cddde2a 100644
--- a/src/it/projects/inheritance-interpolation/child/src/site/apt/index.apt
+++ b/src/it/projects/inheritance-interpolation/child/src/site/apt/index.apt
@@ -1,5 +1,5 @@
-----
- POMs and Site Decoration Model Inheritance and Interpolation
+ POMs and Site Model Inheritance and Interpolation
-----
Hervé Boutemy
-----
@@ -26,8 +26,8 @@
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/doxia/references/apt-format.html
-POMs and Site Decoration Model Inheritance and Interpolation
+POMs and Site Model Inheritance and Interpolation
* {{{./pom.html} POM Inheritance and Interpolation}}
-
- * Site Decoration Model Inheritance and Interpolation: see this page
+
+ * Site Model Inheritance and Interpolation: see this page
diff --git a/src/it/projects/inheritance-interpolation/pom.xml b/src/it/projects/inheritance-interpolation/pom.xml
index 6323a6b6..420b44c4 100644
--- a/src/it/projects/inheritance-interpolation/pom.xml
+++ b/src/it/projects/inheritance-interpolation/pom.xml
@@ -28,7 +28,7 @@ under the License.
<version>1.0-SNAPSHOT</version>
<packaging>pom</packaging>
- <name>POM and Site Decoration Model inheritance and interpolation tests</name>
+ <name>POM and Site Model inheritance and interpolation tests</name>
<description>
this POM is reactor linking to reactor-accessible poms: child and reactor-parent
relative-parent is not expected to be in reactor, but accessible from relative path
diff --git a/src/it/projects/inheritance-interpolation/reactor-parent/src/site/apt/index.apt b/src/it/projects/inheritance-interpolation/reactor-parent/src/site/apt/index.apt
index 5cf71873..6c4ae757 100644
--- a/src/it/projects/inheritance-interpolation/reactor-parent/src/site/apt/index.apt
+++ b/src/it/projects/inheritance-interpolation/reactor-parent/src/site/apt/index.apt
@@ -1,5 +1,5 @@
-----
- Site Decoration Model Inheritance and Interpolation
+ Site Model Inheritance and Interpolation
-----
Hervé Boutemy
-----
@@ -26,7 +26,7 @@
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/doxia/references/apt-format.html
-Site Decoration Model Inheritance and Interpolation
+Site Model Inheritance and Interpolation
Site name inherited from repo-parent then interpolated: once interpolated,
expression from repo-parent should match current artifactId.
diff --git a/src/it/projects/inheritance-interpolation/verify.groovy b/src/it/projects/inheritance-interpolation/verify.groovy
index 340c5c8c..6a9c91b1 100644
--- a/src/it/projects/inheritance-interpolation/verify.groovy
+++ b/src/it/projects/inheritance-interpolation/verify.groovy
@@ -33,7 +33,7 @@ assert content.contains( '<<<http://maven.apache.org/${property}/relative-parent
assert content.contains( '<<<http://maven.apache.org/prop-value-from-reactor-parent/relative-parent/reactor-parent>>>' ); // reactor-parent
assert content.contains( '<<<http://maven.apache.org/prop-value-from-child/relative-parent/reactor-parent/child>>>' ); // child
-// Site Decoration Model inheritance+interpolation
+// Site Model inheritance+interpolation
childContent = new File( basedir, 'child/target/site/index.html' ).text;
assert childContent.contains( 'project.artifactId = child' );
diff --git a/src/it/projects/template-skin/src/main/resources/META-INF/maven/site.vm b/src/it/projects/template-skin/src/main/resources/META-INF/maven/site.vm
index 4c1e8133..b61e6d0e 100644
--- a/src/it/projects/template-skin/src/main/resources/META-INF/maven/site.vm
+++ b/src/it/projects/template-skin/src/main/resources/META-INF/maven/site.vm
@@ -36,7 +36,7 @@ locale=$locale
publishDate=$publishDate
relativePath=$relativePath
supportedLocales=$supportedLocales
-decoration=$decoration
+site=$site
</pre>
<h3>tools</h3>
@@ -88,4 +88,4 @@ project=$project
</pre>
</body>
-</html>
\ No newline at end of file
+</html>
diff --git a/src/main/java/org/apache/maven/plugins/site/deploy/AbstractDeployMojo.java b/src/main/java/org/apache/maven/plugins/site/deploy/AbstractDeployMojo.java
index caeb6e7d..65bf2b80 100644
--- a/src/main/java/org/apache/maven/plugins/site/deploy/AbstractDeployMojo.java
+++ b/src/main/java/org/apache/maven/plugins/site/deploy/AbstractDeployMojo.java
@@ -26,7 +26,7 @@ import java.util.Locale;
import java.util.Set;
import org.apache.maven.artifact.manager.WagonManager;
-import org.apache.maven.doxia.site.decoration.inheritance.URIPathDescriptor;
+import org.apache.maven.doxia.site.inheritance.URIPathDescriptor;
import org.apache.maven.execution.MavenExecutionRequest;
import org.apache.maven.execution.MavenSession;
import org.apache.maven.model.DistributionManagement;
diff --git a/src/main/java/org/apache/maven/plugins/site/descriptor/AbstractSiteDescriptorMojo.java b/src/main/java/org/apache/maven/plugins/site/descriptor/AbstractSiteDescriptorMojo.java
index 46a48940..b72e0230 100644
--- a/src/main/java/org/apache/maven/plugins/site/descriptor/AbstractSiteDescriptorMojo.java
+++ b/src/main/java/org/apache/maven/plugins/site/descriptor/AbstractSiteDescriptorMojo.java
@@ -22,8 +22,8 @@ import java.io.File;
import java.util.List;
import java.util.Locale;
-import org.apache.maven.doxia.site.decoration.DecorationModel;
-import org.apache.maven.doxia.site.decoration.inheritance.DecorationModelInheritanceAssembler;
+import org.apache.maven.doxia.site.SiteModel;
+import org.apache.maven.doxia.site.inheritance.SiteModelInheritanceAssembler;
import org.apache.maven.doxia.tools.SiteToolException;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugins.annotations.Component;
@@ -34,16 +34,16 @@ import org.eclipse.aether.RepositorySystemSession;
import org.eclipse.aether.repository.RemoteRepository;
/**
- * Abstract class to compute effective site decoration model for site descriptors.
+ * Abstract class to compute effective site model for site descriptors.
*
* @since 3.5
*/
public abstract class AbstractSiteDescriptorMojo extends AbstractSiteMojo {
/**
- * The component for assembling site decoration model inheritance.
+ * The component for assembling site model inheritance.
*/
@Component
- private DecorationModelInheritanceAssembler assembler;
+ private SiteModelInheritanceAssembler assembler;
/**
* The reactor projects.
@@ -82,23 +82,23 @@ public abstract class AbstractSiteDescriptorMojo extends AbstractSiteMojo {
*
* @since 2.3
*/
- @Parameter(property = "relativizeDecorationLinks", defaultValue = "true")
- private boolean relativizeDecorationLinks;
+ @Parameter(property = "relativizeSiteLinks", defaultValue = "true")
+ private boolean relativizeSiteLinks;
- protected DecorationModel prepareDecorationModel(Locale locale) throws MojoExecutionException {
- DecorationModel decorationModel;
+ protected SiteModel prepareSiteModel(Locale locale) throws MojoExecutionException {
+ SiteModel siteModel;
try {
- decorationModel = siteTool.getDecorationModel(
+ siteModel = siteTool.getSiteModel(
siteDirectory, locale, project, reactorProjects, repoSession, remoteProjectRepositories);
} catch (SiteToolException e) {
throw new MojoExecutionException("SiteToolException: " + e.getMessage(), e);
}
- if (relativizeDecorationLinks) {
+ if (relativizeSiteLinks) {
final String url = project.getUrl();
if (url == null) {
- getLog().warn("No project URL defined - decoration links will not be relativized!");
+ getLog().warn("No project URL defined - site links will not be relativized!");
} else {
List<Locale> localesList = getLocales();
@@ -108,11 +108,11 @@ public abstract class AbstractSiteDescriptorMojo extends AbstractSiteMojo {
// MSITE-658
final String localeUrl = !locale.equals(defaultLocale) ? append(url, locale.toString()) : url;
- getLog().info("Relativizing decoration links with respect to localized project URL: " + localeUrl);
- assembler.resolvePaths(decorationModel, localeUrl);
+ getLog().info("Relativizing site links with respect to localized project URL: " + localeUrl);
+ assembler.resolvePaths(siteModel, localeUrl);
}
}
- return decorationModel;
+ return siteModel;
}
private String append(String url, String path) {
diff --git a/src/main/java/org/apache/maven/plugins/site/descriptor/EffectiveSiteMojo.java b/src/main/java/org/apache/maven/plugins/site/descriptor/EffectiveSiteMojo.java
index b847a781..512efd51 100644
--- a/src/main/java/org/apache/maven/plugins/site/descriptor/EffectiveSiteMojo.java
+++ b/src/main/java/org/apache/maven/plugins/site/descriptor/EffectiveSiteMojo.java
@@ -23,8 +23,8 @@ import java.io.IOException;
import java.io.StringWriter;
import java.io.Writer;
-import org.apache.maven.doxia.site.decoration.DecorationModel;
-import org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Writer;
+import org.apache.maven.doxia.site.SiteModel;
+import org.apache.maven.doxia.site.io.xpp3.SiteXpp3Writer;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.Mojo;
@@ -58,18 +58,15 @@ public class EffectiveSiteMojo extends AbstractSiteDescriptorMojo {
* {@inheritDoc}
*/
public void execute() throws MojoExecutionException, MojoFailureException {
- DecorationModel decorationModel = prepareDecorationModel(getLocales().get(0));
+ SiteModel siteModel = prepareSiteModel(getLocales().get(0));
StringWriter w = new StringWriter();
XMLWriter writer = new PrettyPrintXMLWriter(
- w,
- StringUtils.repeat(" ", XmlWriterUtil.DEFAULT_INDENTATION_SIZE),
- decorationModel.getModelEncoding(),
- null);
+ w, StringUtils.repeat(" ", XmlWriterUtil.DEFAULT_INDENTATION_SIZE), siteModel.getModelEncoding(), null);
writeHeader(writer);
- writeEffectiveSite(decorationModel, writer);
+ writeEffectiveSite(siteModel, writer);
String effectiveSite = w.toString();
@@ -128,13 +125,13 @@ public class EffectiveSiteMojo extends AbstractSiteDescriptorMojo {
XmlWriterUtil.writeLineBreak(writer);
}
- private void writeEffectiveSite(DecorationModel decorationModel, XMLWriter writer) throws MojoExecutionException {
+ private void writeEffectiveSite(SiteModel siteModel, XMLWriter writer) throws MojoExecutionException {
String effectiveSite;
StringWriter sWriter = new StringWriter();
- DecorationXpp3Writer siteWriter = new DecorationXpp3Writer();
+ SiteXpp3Writer siteWriter = new SiteXpp3Writer();
try {
- siteWriter.write(sWriter, decorationModel);
+ siteWriter.write(sWriter, siteModel);
} catch (IOException e) {
throw new MojoExecutionException("Cannot serialize site descriptor to XML.", e);
}
diff --git a/src/main/java/org/apache/maven/plugins/site/descriptor/SiteDescriptorArtifactMetadata.java b/src/main/java/org/apache/maven/plugins/site/descriptor/SiteDescriptorArtifactMetadata.java
index 114a03e6..ebb23fa1 100644
--- a/src/main/java/org/apache/maven/plugins/site/descriptor/SiteDescriptorArtifactMetadata.java
+++ b/src/main/java/org/apache/maven/plugins/site/descriptor/SiteDescriptorArtifactMetadata.java
@@ -27,8 +27,8 @@ import org.apache.maven.artifact.metadata.AbstractArtifactMetadata;
import org.apache.maven.artifact.metadata.ArtifactMetadata;
import org.apache.maven.artifact.repository.ArtifactRepository;
import org.apache.maven.artifact.repository.metadata.RepositoryMetadataStoreException;
-import org.apache.maven.doxia.site.decoration.DecorationModel;
-import org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Writer;
+import org.apache.maven.doxia.site.SiteModel;
+import org.apache.maven.doxia.site.io.xpp3.SiteXpp3Writer;
import org.codehaus.plexus.util.WriterFactory;
/**
@@ -38,15 +38,15 @@ import org.codehaus.plexus.util.WriterFactory;
*
*/
public class SiteDescriptorArtifactMetadata extends AbstractArtifactMetadata {
- private final DecorationModel decoration;
+ private final SiteModel siteModel;
private final File file;
- public SiteDescriptorArtifactMetadata(Artifact artifact, DecorationModel decoration, File file) {
+ public SiteDescriptorArtifactMetadata(Artifact artifact, SiteModel siteModel, File file) {
super(artifact);
this.file = file;
- this.decoration = decoration;
+ this.siteModel = siteModel;
}
public String getRemoteFilename() {
@@ -69,7 +69,7 @@ public class SiteDescriptorArtifactMetadata extends AbstractArtifactMetadata {
destination.getParentFile().mkdirs();
try (Writer writer = WriterFactory.newXmlWriter(destination)) {
- new DecorationXpp3Writer().write(writer, decoration);
+ new SiteXpp3Writer().write(writer, siteModel);
} catch (IOException e) {
throw new RepositoryMetadataStoreException("Error saving in local repository", e);
}
diff --git a/src/main/java/org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.java b/src/main/java/org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.java
index 2dc9bb13..ef56c529 100644
--- a/src/main/java/org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.java
+++ b/src/main/java/org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.java
@@ -32,13 +32,13 @@ import java.util.Map;
import org.apache.maven.archiver.MavenArchiver;
import org.apache.maven.artifact.Artifact;
-import org.apache.maven.doxia.site.decoration.DecorationModel;
-import org.apache.maven.doxia.site.decoration.Menu;
-import org.apache.maven.doxia.site.decoration.MenuItem;
+import org.apache.maven.doxia.site.Menu;
+import org.apache.maven.doxia.site.MenuItem;
+import org.apache.maven.doxia.site.SiteModel;
import org.apache.maven.doxia.siterenderer.DocumentRenderer;
-import org.apache.maven.doxia.siterenderer.Renderer;
+import org.apache.maven.doxia.siterenderer.DocumentRenderingContext;
import org.apache.maven.doxia.siterenderer.RendererException;
-import org.apache.maven.doxia.siterenderer.RenderingContext;
+import org.apache.maven.doxia.siterenderer.SiteRenderer;
import org.apache.maven.doxia.siterenderer.SiteRenderingContext;
import org.apache.maven.doxia.tools.SiteTool;
import org.apache.maven.doxia.tools.SiteToolException;
@@ -98,7 +98,7 @@ public abstract class AbstractSiteRenderingMojo extends AbstractSiteDescriptorMo
* Site renderer.
*/
@Component
- protected Renderer siteRenderer;
+ protected SiteRenderer siteRenderer;
/**
* Directory containing generated documentation in source format (Doxia supported markup).
@@ -237,7 +237,7 @@ public abstract class AbstractSiteRenderingMojo extends AbstractSiteDescriptorMo
protected SiteRenderingContext createSiteRenderingContext(Locale locale)
throws MojoExecutionException, IOException, MojoFailureException {
- DecorationModel decorationModel = prepareDecorationModel(locale);
+ SiteModel siteModel = prepareSiteModel(locale);
if (attributes == null) {
attributes = new HashMap<>();
}
@@ -261,16 +261,15 @@ public abstract class AbstractSiteRenderingMojo extends AbstractSiteDescriptorMo
SiteRenderingContext context;
try {
- Artifact skinArtifact = siteTool.getSkinArtifactFromRepository(
- repoSession, remoteProjectRepositories, decorationModel.getSkin());
+ Artifact skinArtifact =
+ siteTool.getSkinArtifactFromRepository(repoSession, remoteProjectRepositories, siteModel.getSkin());
getLog().info(buffer().a("Rendering content with ")
.strong(skinArtifact.getId() + " skin")
.a('.')
.toString());
- context = siteRenderer.createContextForSkin(
- skinArtifact, attributes, decorationModel, project.getName(), locale);
+ context = siteRenderer.createContextForSkin(skinArtifact, attributes, siteModel, project.getName(), locale);
} catch (SiteToolException e) {
throw new MojoExecutionException("SiteToolException while preparing skin: " + e.getMessage(), e);
} catch (RendererException e) {
@@ -346,7 +345,8 @@ public abstract class AbstractSiteRenderingMojo extends AbstractSiteDescriptorMo
+ mavenReportExecution.getPlugin().getVersion()
+ ':'
+ mavenReportExecution.getGoal();
- RenderingContext docRenderingContext = new RenderingContext(siteDirectory, outputName, reportMojoInfo);
+ DocumentRenderingContext docRenderingContext =
+ new DocumentRenderingContext(siteDirectory, outputName, reportMojoInfo);
DocumentRenderer docRenderer =
new ReportDocumentRenderer(mavenReportExecution, docRenderingContext, getLog());
documents.put(outputName, docRenderer);
@@ -400,14 +400,14 @@ public abstract class AbstractSiteRenderingMojo extends AbstractSiteDescriptorMo
// TODO: I want to get rid of categories eventually. There's no way to add your own in a fully i18n manner
Map<String, List<MavenReport>> categories = categoriseReports(reportsByOutputName.values());
- siteTool.populateReportsMenu(context.getDecoration(), locale, categories);
- populateReportItems(context.getDecoration(), locale, reportsByOutputName);
+ siteTool.populateReportsMenu(context.getSiteModel(), locale, categories);
+ populateReportItems(context.getSiteModel(), locale, reportsByOutputName);
if (categories.containsKey(MavenReport.CATEGORY_PROJECT_INFORMATION) && generateProjectInfo) {
// add "Project Information" category summary document
List<MavenReport> categoryReports = categories.get(MavenReport.CATEGORY_PROJECT_INFORMATION);
- RenderingContext docRenderingContext = new RenderingContext(
+ DocumentRenderingContext docRenderingContext = new DocumentRenderingContext(
siteDirectory, "project-info.html", getSitePluginInfo() + ":CategorySummaryDocumentRenderer");
String title = i18n.getString("site-plugin", locale, "report.information.title");
String desc1 = i18n.getString("site-plugin", locale, "report.information.description1");
@@ -425,7 +425,7 @@ public abstract class AbstractSiteRenderingMojo extends AbstractSiteDescriptorMo
if (categories.containsKey(MavenReport.CATEGORY_PROJECT_REPORTS)) {
// add "Project Reports" category summary document
List<MavenReport> categoryReports = categories.get(MavenReport.CATEGORY_PROJECT_REPORTS);
- RenderingContext docRenderingContext = new RenderingContext(
+ DocumentRenderingContext docRenderingContext = new DocumentRenderingContext(
siteDirectory, "project-reports.html", getSitePluginInfo() + ":CategorySummaryDocumentRenderer");
String title = i18n.getString("site-plugin", locale, "report.project.title");
String desc1 = i18n.getString("site-plugin", locale, "report.project.description1");
@@ -449,8 +449,8 @@ public abstract class AbstractSiteRenderingMojo extends AbstractSiteDescriptorMo
}
protected void populateReportItems(
- DecorationModel decorationModel, Locale locale, Map<String, MavenReport> reportsByOutputName) {
- for (Menu menu : decorationModel.getMenus()) {
+ SiteModel siteModel, Locale locale, Map<String, MavenReport> reportsByOutputName) {
+ for (Menu menu : siteModel.getMenus()) {
populateItemRefs(menu.getItems(), locale, reportsByOutputName);
}
}
diff --git a/src/main/java/org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.java b/src/main/java/org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.java
index 965c16aa..d544b62e 100644
--- a/src/main/java/org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.java
+++ b/src/main/java/org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.java
@@ -26,9 +26,9 @@ import java.util.Locale;
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.doxia.siterenderer.DocumentRenderer;
-import org.apache.maven.doxia.siterenderer.Renderer;
+import org.apache.maven.doxia.siterenderer.DocumentRenderingContext;
import org.apache.maven.doxia.siterenderer.RendererException;
-import org.apache.maven.doxia.siterenderer.RenderingContext;
+import org.apache.maven.doxia.siterenderer.SiteRenderer;
import org.apache.maven.doxia.siterenderer.SiteRenderingContext;
import org.apache.maven.doxia.siterenderer.sink.SiteRendererSink;
import org.apache.maven.plugin.logging.Log;
@@ -41,7 +41,7 @@ import org.codehaus.plexus.i18n.I18N;
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
*/
public class CategorySummaryDocumentRenderer implements DocumentRenderer {
- private RenderingContext docRenderingContext;
+ private DocumentRenderingContext docRenderingContext;
private String title;
@@ -56,7 +56,7 @@ public class CategorySummaryDocumentRenderer implements DocumentRenderer {
private final Log log;
public CategorySummaryDocumentRenderer(
- RenderingContext docRenderingContext,
+ DocumentRenderingContext docRenderingContext,
String title,
String desc1,
String desc2,
@@ -66,7 +66,7 @@ public class CategorySummaryDocumentRenderer implements DocumentRenderer {
}
public CategorySummaryDocumentRenderer(
- RenderingContext docRenderingContext,
+ DocumentRenderingContext docRenderingContext,
String title,
String desc1,
String desc2,
@@ -82,7 +82,7 @@ public class CategorySummaryDocumentRenderer implements DocumentRenderer {
this.log = log;
}
- public void renderDocument(Writer writer, Renderer siteRenderer, SiteRenderingContext siteRenderingContext)
+ public void renderDocument(Writer writer, SiteRenderer siteRenderer, SiteRenderingContext siteRenderingContext)
throws RendererException, FileNotFoundException {
SiteRendererSink sink = new SiteRendererSink(docRenderingContext);
@@ -176,7 +176,7 @@ public class CategorySummaryDocumentRenderer implements DocumentRenderer {
return docRenderingContext.getOutputName();
}
- public RenderingContext getRenderingContext() {
+ public DocumentRenderingContext getRenderingContext() {
return docRenderingContext;
}
diff --git a/src/main/java/org/apache/maven/plugins/site/render/ReportDocumentRenderer.java b/src/main/java/org/apache/maven/plugins/site/render/ReportDocumentRenderer.java
index ba799e61..c574610a 100644
--- a/src/main/java/org/apache/maven/plugins/site/render/ReportDocumentRenderer.java
+++ b/src/main/java/org/apache/maven/plugins/site/render/ReportDocumentRenderer.java
@@ -30,9 +30,9 @@ import java.util.Locale;
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.doxia.sink.SinkFactory;
import org.apache.maven.doxia.siterenderer.DocumentRenderer;
-import org.apache.maven.doxia.siterenderer.Renderer;
+import org.apache.maven.doxia.siterenderer.DocumentRenderingContext;
import org.apache.maven.doxia.siterenderer.RendererException;
-import org.apache.maven.doxia.siterenderer.RenderingContext;
+import org.apache.maven.doxia.siterenderer.SiteRenderer;
import org.apache.maven.doxia.siterenderer.SiteRenderingContext;
import org.apache.maven.doxia.siterenderer.sink.SiteRendererSink;
import org.apache.maven.plugin.logging.Log;
@@ -55,7 +55,7 @@ import static org.apache.maven.shared.utils.logging.MessageUtils.buffer;
public class ReportDocumentRenderer implements DocumentRenderer {
private final MavenReport report;
- private final RenderingContext docRenderingContext;
+ private final DocumentRenderingContext docRenderingContext;
private final String reportMojoInfo;
@@ -64,7 +64,7 @@ public class ReportDocumentRenderer implements DocumentRenderer {
private final Log log;
public ReportDocumentRenderer(
- MavenReportExecution mavenReportExecution, RenderingContext docRenderingContext, Log log) {
+ MavenReportExecution mavenReportExecution, DocumentRenderingContext docRenderingContext, Log log) {
this.report = mavenReportExecution.getMavenReport();
this.docRenderingContext = docRenderingContext;
@@ -86,7 +86,7 @@ public class ReportDocumentRenderer implements DocumentRenderer {
private String outputName;
- MultiPageSubSink(File outputDir, String outputName, RenderingContext docRenderingContext) {
+ MultiPageSubSink(File outputDir, String outputName, DocumentRenderingContext docRenderingContext) {
super(docRenderingContext);
this.outputName = outputName;
this.outputDir = outputDir;
@@ -108,16 +108,16 @@ public class ReportDocumentRenderer implements DocumentRenderer {
private MavenReport report;
/**
- * The main RenderingContext, which is the base for the RenderingContext of subpages
+ * The main DocumentRenderingContext, which is the base for the DocumentRenderingContext of subpages
*/
- private RenderingContext docRenderingContext;
+ private DocumentRenderingContext docRenderingContext;
/**
* List of sinks (subpages) associated to this report
*/
private List<MultiPageSubSink> sinks = new ArrayList<MultiPageSubSink>();
- MultiPageSinkFactory(MavenReport report, RenderingContext docRenderingContext) {
+ MultiPageSinkFactory(MavenReport report, DocumentRenderingContext docRenderingContext) {
this.report = report;
this.docRenderingContext = docRenderingContext;
}
@@ -128,7 +128,7 @@ public class ReportDocumentRenderer implements DocumentRenderer {
String outputRelativeToTargetSite = PathTool.getRelativeFilePath(
report.getReportOutputDirectory().getPath(), new File(outputDir, outputName).getPath());
- RenderingContext subSinkContext = new RenderingContext(
+ DocumentRenderingContext subSinkContext = new DocumentRenderingContext(
docRenderingContext.getBasedir(),
docRenderingContext.getBasedirRelativePath(),
outputRelativeToTargetSite,
@@ -170,7 +170,7 @@ public class ReportDocumentRenderer implements DocumentRenderer {
}
@Override
- public void renderDocument(Writer writer, Renderer siteRenderer, SiteRenderingContext siteRenderingContext)
+ public void renderDocument(Writer writer, SiteRenderer siteRenderer, SiteRenderingContext siteRenderingContext)
throws RendererException, FileNotFoundException {
Locale locale = siteRenderingContext.getLocale();
String localReportName = report.getName(locale);
@@ -269,7 +269,7 @@ public class ReportDocumentRenderer implements DocumentRenderer {
}
@Override
- public RenderingContext getRenderingContext() {
+ public DocumentRenderingContext getRenderingContext() {
return docRenderingContext;
}
diff --git a/src/main/java/org/apache/maven/plugins/site/render/SiteMap.java b/src/main/java/org/apache/maven/plugins/site/render/SiteMap.java
index 82cc6df8..adeacb1f 100644
--- a/src/main/java/org/apache/maven/plugins/site/render/SiteMap.java
+++ b/src/main/java/org/apache/maven/plugins/site/render/SiteMap.java
@@ -25,9 +25,9 @@ import java.util.Locale;
import org.apache.maven.doxia.module.xdoc.XdocSinkFactory;
import org.apache.maven.doxia.sink.Sink;
-import org.apache.maven.doxia.site.decoration.DecorationModel;
-import org.apache.maven.doxia.site.decoration.Menu;
-import org.apache.maven.doxia.site.decoration.MenuItem;
+import org.apache.maven.doxia.site.Menu;
+import org.apache.maven.doxia.site.MenuItem;
+import org.apache.maven.doxia.site.SiteModel;
import org.codehaus.plexus.i18n.I18N;
/**
@@ -92,26 +92,26 @@ public class SiteMap {
/**
* Generates a sitemap.xml in targetDir/xdoc/.
* This is a valid xdoc document that can be processed by a Doxia parser.
- * The file lists all the menus and menu items of the DecorationModel in expanded form.
+ * The file lists all the menus and menu items of the SiteModel in expanded form.
*
- * @param model the DecorationModel to extract the menus from.
+ * @param siteModel the SiteModel to extract the menus from.
* @param targetDir the target output directory. The file will be created in targetDir/xdoc/.
* @param locale the Locale for the result.
*
* @throws IOException if the file cannot be ceated.
*/
- public void generate(DecorationModel model, File targetDir, Locale locale) throws IOException {
+ public void generate(SiteModel siteModel, File targetDir, Locale locale) throws IOException {
File outputDir = new File(targetDir, "xdoc");
Sink sink = new XdocSinkFactory().createSink(outputDir, "sitemap.xml", encoding);
try {
- extract(model, sink, locale);
+ extract(siteModel, sink, locale);
} finally {
sink.close();
}
}
- private void extract(DecorationModel decoration, Sink sink, Locale locale) {
+ private void extract(SiteModel siteModel, Sink sink, Locale locale) {
sink.head();
sink.title();
sink.text(i18n.getString("site-plugin", locale, "site.sitemap.title"));
@@ -128,7 +128,7 @@ public class SiteMap {
sink.text(i18n.getString("site-plugin", locale, "site.sitemap.description"));
sink.paragraph_();
- for (Menu menu : decoration.getMenus()) {
+ for (Menu menu : siteModel.getMenus()) {
sink.section2();
sink.sectionTitle2();
sink.text(menu.getName());
diff --git a/src/main/java/org/apache/maven/plugins/site/render/SiteMojo.java b/src/main/java/org/apache/maven/plugins/site/render/SiteMojo.java
index d525944a..2120f03d 100644
--- a/src/main/java/org/apache/maven/plugins/site/render/SiteMojo.java
+++ b/src/main/java/org/apache/maven/plugins/site/render/SiteMojo.java
@@ -170,7 +170,7 @@ public class SiteMojo extends AbstractSiteRenderingMojo {
if (generateSitemap) {
getLog().info("Generating Sitemap.");
- new SiteMap(getOutputEncoding(), i18n).generate(context.getDecoration(), generatedSiteDirectory, locale);
+ new SiteMap(getOutputEncoding(), i18n).generate(context.getSiteModel(), generatedSiteDirectory, locale);
}
// 3. Generated docs must be (re-)done afterwards as they are often generated by reports
diff --git a/src/main/java/org/apache/maven/plugins/site/run/DoxiaFilter.java b/src/main/java/org/apache/maven/plugins/site/run/DoxiaFilter.java
index c9d9a187..342118f1 100644
--- a/src/main/java/org/apache/maven/plugins/site/run/DoxiaFilter.java
+++ b/src/main/java/org/apache/maven/plugins/site/run/DoxiaFilter.java
@@ -37,8 +37,8 @@ import java.util.Map;
import org.apache.maven.doxia.siterenderer.DocumentRenderer;
import org.apache.maven.doxia.siterenderer.DoxiaDocumentRenderer;
-import org.apache.maven.doxia.siterenderer.Renderer;
import org.apache.maven.doxia.siterenderer.RendererException;
+import org.apache.maven.doxia.siterenderer.SiteRenderer;
import org.apache.maven.doxia.siterenderer.SiteRenderingContext;
import org.apache.maven.doxia.tools.SiteTool;
import org.apache.maven.plugins.site.render.ReportDocumentRenderer;
@@ -64,7 +64,7 @@ public class DoxiaFilter implements Filter {
private File outputDirectory;
- private Renderer siteRenderer;
+ private SiteRenderer siteRenderer;
private Map<String, DoxiaBean> i18nDoxiaContexts;
@@ -78,7 +78,7 @@ public class DoxiaFilter implements Filter {
outputDirectory = (File) servletContext.getAttribute(OUTPUT_DIRECTORY_KEY);
- siteRenderer = (Renderer) servletContext.getAttribute(SITE_RENDERER_KEY);
+ siteRenderer = (SiteRenderer) servletContext.getAttribute(SITE_RENDERER_KEY);
i18nDoxiaContexts = (Map<String, DoxiaBean>) servletContext.getAttribute(I18N_DOXIA_CONTEXTS_KEY);
diff --git a/src/site/apt/examples/sitedescriptor.apt b/src/site/apt/examples/sitedescriptor.apt
index b0f190e1..10fab2b1 100644
--- a/src/site/apt/examples/sitedescriptor.apt
+++ b/src/site/apt/examples/sitedescriptor.apt
@@ -38,7 +38,7 @@ Configuring the Site Descriptor
a file called <<<site.xml>>> which should be located in your <<<src/site>>> directory.
There is a
- {{{/doxia/doxia-sitetools/doxia-decoration-model/decoration.html}reference documentation for the site descriptor}}
+ {{{/doxia/doxia-sitetools/doxia-site-model/site.html}reference documentation for the site descriptor}}
available with its XML Schema.
Have a look at the
@@ -86,7 +86,7 @@ Configuring the Site Descriptor
+-----+
Refer to the site descriptor
- {{{/doxia/doxia-sitetools/doxia-decoration-model/decoration.html}reference}}
+ {{{/doxia/doxia-sitetools/doxia-site-model/site.html}reference}}
for a complete tag description.