Author: hboutemy
Date: Fri Dec 18 23:18:11 2015
New Revision: 1720856
URL: http://svn.apache.org/viewvc?rev=1720856&view=rev
Log:
[DOXIASITETOOLS-126] don't copy resources when rendering documents
Modified:
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/java/org/apache/maven/doxia/siterenderer/Renderer.java
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/RenderingContext.java
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=1720856&r1=1720855&r2=1720856&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 Dec 18 23:18:11 2015
@@ -125,19 +125,6 @@ public class DefaultSiteRenderer
// ----------------------------------------------------------------------
/** {@inheritDoc} */
- public void render( Collection<DocumentRenderer> documents,
SiteRenderingContext siteRenderingContext,
- File outputDirectory )
- throws RendererException, IOException
- {
- renderModule( documents, siteRenderingContext, outputDirectory );
-
- for ( File siteDirectory : siteRenderingContext.getSiteDirectories() )
- {
- copyResources( siteRenderingContext, new File( siteDirectory,
"resources" ), outputDirectory );
- }
- }
-
- /** {@inheritDoc} */
public Map<String, DocumentRenderer> locateDocumentFiles(
SiteRenderingContext siteRenderingContext )
throws IOException, RendererException
{
@@ -287,11 +274,12 @@ public class DefaultSiteRenderer
}
}
- private void renderModule( Collection<DocumentRenderer> docs,
SiteRenderingContext siteRenderingContext,
- File outputDirectory )
- throws IOException, RendererException
+ /** {@inheritDoc} */
+ public void render( Collection<DocumentRenderer> documents,
SiteRenderingContext siteRenderingContext,
+ File outputDirectory )
+ throws RendererException, IOException
{
- for ( DocumentRenderer docRenderer : docs )
+ for ( DocumentRenderer docRenderer : documents )
{
RenderingContext renderingContext =
docRenderer.getRenderingContext();
@@ -734,8 +722,14 @@ public class DefaultSiteRenderer
}
/** {@inheritDoc} */
- public void copyResources( SiteRenderingContext siteRenderingContext, File
resourcesDirectory,
- File outputDirectory )
+ public void copyResources( SiteRenderingContext siteRenderingContext, File
resourcesDirectory, File outputDirectory )
+ throws IOException
+ {
+ throw new AssertionError( "copyResources( SiteRenderingContext, File,
File ) is deprecated." );
+ }
+
+ /** {@inheritDoc} */
+ public void copyResources( SiteRenderingContext siteRenderingContext, File
outputDirectory )
throws IOException
{
if ( siteRenderingContext.getSkinJarFile() != null )
@@ -831,9 +825,14 @@ public class DefaultSiteRenderer
}
// Copy extra site resources
- if ( resourcesDirectory != null && resourcesDirectory.exists() )
+ for ( File siteDirectory : siteRenderingContext.getSiteDirectories() )
{
- copyDirectory( resourcesDirectory, outputDirectory );
+ File resourcesDirectory = new File( siteDirectory, "resources" );
+
+ if ( resourcesDirectory != null && resourcesDirectory.exists() )
+ {
+ copyDirectory( resourcesDirectory, outputDirectory );
+ }
}
// Check for the existence of /css/site.css
@@ -853,7 +852,7 @@ public class DefaultSiteRenderer
if ( getLogger().isDebugEnabled() )
{
getLogger().debug(
- "The file '" + siteCssFile.getAbsolutePath() + "' does not
exists. Creating an empty file." );
+ "The file '" + siteCssFile.getAbsolutePath() + "' does not
exist. Creating an empty file." );
}
Writer writer = null;
try
Modified:
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/Renderer.java
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/Renderer.java?rev=1720856&r1=1720855&r2=1720856&view=diff
==============================================================================
---
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/Renderer.java
(original)
+++
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/Renderer.java
Fri Dec 18 23:18:11 2015
@@ -70,7 +70,7 @@ public interface Renderer
throws RendererException;
/**
- * Return a SiteRenderingContext.
+ * Return a SiteRenderingContext for a site using a skin.
*
* @param skinFile
* @param attributes
@@ -85,7 +85,7 @@ public interface Renderer
throws IOException;
/**
- * Return a SiteRenderingContext.
+ * Return a SiteRenderingContext for a site using a local template.
*
* @param templateFile
* @param skinFile
@@ -108,11 +108,23 @@ public interface Renderer
* @param resourcesDirectory
* @param outputDirectory
* @throws java.io.IOException if it bombs.
+ * @deprecated since 1.7, use copyResources without resourcesDirectory
parameter
*/
void copyResources( SiteRenderingContext siteRenderingContext, File
resourcesDirectory, File outputDirectory )
throws IOException;
/**
+ * Copy resource files from skin, template, and site resources.
+ *
+ * @param siteRenderingContext
+ * @param outputDirectory
+ * @throws java.io.IOException if it bombs.
+ * @since 1.7
+ */
+ void copyResources( SiteRenderingContext siteRenderingContext, File
outputDirectory )
+ throws IOException;
+
+ /**
* Return the document files in a Map.
*
* @param siteRenderingContext
@@ -124,7 +136,7 @@ public interface Renderer
throws IOException, RendererException;
/**
- * Render a document.
+ * Render a document written in a Doxia markup language.
*
* @param writer the writer to render the document to.
* @param renderingContext the document's rendering context
Modified:
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/RenderingContext.java
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/RenderingContext.java?rev=1720856&r1=1720855&r2=1720856&view=diff
==============================================================================
---
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/RenderingContext.java
(original)
+++
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/RenderingContext.java
Fri Dec 18 23:18:11 2015
@@ -28,7 +28,7 @@ import org.codehaus.plexus.util.PathTool
import org.codehaus.plexus.util.StringUtils;
/**
- * The rendering context of a document.
+ * The rendering context of a document written in a Doxia supported markup.
*
* @author <a href="mailto:[email protected]";>Jason van Zyl</a>
* @version $Id$
