Author: dennisl
Date: Fri Apr 6 22:15:45 2012
New Revision: 1310614
URL: http://svn.apache.org/viewvc?rev=1310614&view=rev
Log:
[DOXIASITETOOLS-71] Add the version of doxia-site-renderer that is used to the
generated site
Redid the implementation after feedback from Robert Scholte. The version is
read from a properties file inside META-INF and is exposed to the Velocity
context. That means that it is also available to other skins.
Modified:
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/pom.xml
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/resources/org/apache/maven/doxia/siterenderer/resources/default-site.vm
Modified: maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/pom.xml
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/pom.xml?rev=1310614&r1=1310613&r2=1310614&view=diff
==============================================================================
--- maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/pom.xml (original)
+++ maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/pom.xml Fri Apr 6
22:15:45 2012
@@ -47,42 +47,6 @@ under the License.
</contributor>
</contributors>
- <build>
- <resources>
- <resource>
- <directory>${basedir}/src/main/resources</directory>
- <includes>
-
<include>org/apache/maven/doxia/siterenderer/resources/default-site.vm</include>
- </includes>
- <filtering>true</filtering> <!-- add project version -->
- </resource>
- <resource>
- <directory>${basedir}/src/main/resources</directory>
- <excludes>
-
<exclude>org/apache/maven/doxia/siterenderer/resources/default-site.vm</exclude>
- </excludes>
- </resource>
- </resources>
-
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-resources-plugin</artifactId>
- <configuration>
- <!--
- We can't use the default delimiters here, because the Velocity
- template contains expressions that will be interpolated when a site
- is generated.
- -->
- <delimiters>
- <delimiter>@</delimiter>
- </delimiters>
- <useDefaultDelimiters>false</useDefaultDelimiters>
- </configuration>
- </plugin>
- </plugins>
- </build>
-
<dependencies>
<!-- doxia -->
<dependency>
Modified:
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java?rev=1310614&r1=1310613&r2=1310614&view=diff
==============================================================================
---
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java
(original)
+++
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java
Fri Apr 6 22:15:45 2012
@@ -51,6 +51,7 @@ import java.util.LinkedList;
import java.util.List;
import java.util.Locale;
import java.util.Map;
+import java.util.Properties;
import java.util.zip.ZipEntry;
import java.util.zip.ZipException;
import java.util.zip.ZipFile;
@@ -85,7 +86,6 @@ import org.codehaus.plexus.util.WriterFa
import org.codehaus.plexus.velocity.SiteResourceLoader;
import org.codehaus.plexus.velocity.VelocityComponent;
-
/**
* <p>DefaultSiteRenderer class.</p>
*
@@ -427,7 +427,7 @@ public class DefaultSiteRenderer
private Context createVelocityContext( SiteRendererSink sink,
SiteRenderingContext siteRenderingContext )
{
- ToolManager toolManager = new ToolManager( true );
+ ToolManager toolManager = new ToolManager( true );
Context context = toolManager.createContext();
//
----------------------------------------------------------------------
@@ -499,6 +499,30 @@ public class DefaultSiteRenderer
context.put( "locale", locale );
context.put( "supportedLocales", Collections.unmodifiableList(
siteRenderingContext.getSiteLocales() ) );
+ InputStream inputStream = null;
+ try
+ {
+ inputStream =
this.getClass().getClassLoader().getResourceAsStream(
"META-INF/maven/org.apache.maven.doxia/doxia-site-renderer/pom.properties" );
+ if ( inputStream == null )
+ {
+ getLogger().debug( "pom.properties for doxia-site-renderer
could not be found." );
+ }
+ else
+ {
+ Properties properties = new Properties();
+ properties.load( inputStream );
+ context.put( "doxiaVersion", properties.getProperty( "version"
) );
+ }
+ }
+ catch( IOException e )
+ {
+ getLogger().debug( "Failed to load pom.properties, so doxiaVersion
is not available in the velocityContext." );
+ }
+ finally
+ {
+ IOUtil.close( inputStream );
+ }
+
// Add user properties
Map<String, ?> templateProperties =
siteRenderingContext.getTemplateProperties();
Modified:
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/resources/org/apache/maven/doxia/siterenderer/resources/default-site.vm
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/resources/org/apache/maven/doxia/siterenderer/resources/default-site.vm?rev=1310614&r1=1310613&r2=1310614&view=diff
==============================================================================
---
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/resources/org/apache/maven/doxia/siterenderer/resources/default-site.vm
(original)
+++
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/resources/org/apache/maven/doxia/siterenderer/resources/default-site.vm
Fri Apr 6 22:15:45 2012
@@ -1,5 +1,5 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<!-- Generated by Apache Maven Doxia @project.version@ at $dateFormat.format(
$currentDate ) -->
+<!-- Generated by Apache Maven Doxia Site Renderer $doxiaVersion at
$dateFormat.format( $currentDate ) -->
#macro ( link $href $name $target $img $position $alt $border $width $height
$title )
#set ( $linkTitle = ' title="' + $name + '"' )
#if( $target )