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 2016/03/31 08:35:30 UTC
svn commit: r1737181 - in
/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src:
main/java/org/apache/maven/doxia/siterenderer/
main/resources/org/apache/maven/doxia/siterenderer/resources/ site/apt/
Author: hboutemy
Date: Thu Mar 31 06:35:30 2016
New Revision: 1737181
URL: http://svn.apache.org/viewvc?rev=1737181&view=rev
Log:
[DOXIASITETOOLS-164] added documentDate variable, with it loose semantics (as Doxia Sink date() API) and deprecated (and removed from default template) dateCreation and revision date
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/resources/org/apache/maven/doxia/siterenderer/resources/default-site-macros.vm
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/resources/org/apache/maven/doxia/siterenderer/resources/default-site.vm
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/site/apt/index.apt.vm
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=1737181&r1=1737180&r2=1737181&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 Thu Mar 31 06:35:30 2016
@@ -631,17 +631,22 @@ public class DefaultSiteRenderer
context.put( "bodyContent", siteRendererSink.getBody() );
- SimpleDateFormat sdf = new SimpleDateFormat( "yyyyMMdd" );
- if ( StringUtils.isNotEmpty( siteRendererSink.getDate() ) )
+ // document date (got from Doxia Sink date() API)
+ String documentDate = siteRendererSink.getDate();
+ if ( StringUtils.isNotEmpty( documentDate ) )
{
- String documentDate = siteRendererSink.getDate();
+ context.put( "documentDate", documentDate );
+ // deprecated variables that rework the document date, suppose one semantics over others
+ // (ie creation date, while it may be last modification date if the document writer decided so)
+ // see DOXIASITETOOLS-20 for the beginning and DOXIASITETOOLS-164 for the end of this story
try
{
// we support only ISO 8601 date
Date creationDate = new SimpleDateFormat( "yyyy-MM-dd" ).parse( documentDate );
context.put( "creationDate", creationDate );
+ SimpleDateFormat sdf = new SimpleDateFormat( "yyyyMMdd" );
context.put( "dateCreation", sdf.format( creationDate ) );
}
catch ( java.text.ParseException e )
Modified: maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/resources/org/apache/maven/doxia/siterenderer/resources/default-site-macros.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-macros.vm?rev=1737181&r1=1737180&r2=1737181&view=diff
==============================================================================
--- maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/resources/org/apache/maven/doxia/siterenderer/resources/default-site-macros.vm (original)
+++ maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/resources/org/apache/maven/doxia/siterenderer/resources/default-site-macros.vm Thu Mar 31 06:35:30 2016
@@ -338,7 +338,7 @@
| <span id="projectVersion">$i18n.getString( "site-renderer", $locale, "template.version" ): ${project.version}</span>
#end
</div>
- #elseif ( $datePosition.equalsIgnoreCase("left") )
+ #elseif ( $datePosition.equalsIgnoreCase( "left" ) )
<div class="xleft">
<span id="publishDate">$i18n.getString( "site-renderer", $locale, "template.lastpublished" ): $dateValue</span>
#if ( $versionPosition.equalsIgnoreCase( $position ) )
@@ -356,7 +356,7 @@
<div id="lastPublished">
<span id="projectVersion">$i18n.getString( "site-renderer", $locale, "template.version" ): ${project.version}</span>
</div>
- #elseif ( $versionPosition.equalsIgnoreCase("left") )
+ #elseif ( $versionPosition.equalsIgnoreCase( "left" ) )
<div class="xleft">
<span id="projectVersion">$i18n.getString( "site-renderer", $locale, "template.version" ): ${project.version}</span>
#if ( $breadcrumbs && $breadcrumbs.size() > 0 )
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=1737181&r1=1737180&r2=1737181&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 Thu Mar 31 06:35:30 2016
@@ -31,11 +31,8 @@
#foreach( $author in $authors )
<meta name="author" content="$author" />
#end
-#if ( $dateCreation )
- <meta name="Date-Creation-yyyymmdd" content="$dateCreation" />
-#end
-#if ( $dateRevision )
- <meta name="Date-Revision-yyyymmdd" content="$dateRevision" />
+#if ( $documentDate )
+ <meta name="date" content="$documentDate" />
#end
#if ( $locale )
<meta http-equiv="Content-Language" content="$locale.language" />
Modified: maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/site/apt/index.apt.vm
URL: http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/site/apt/index.apt.vm?rev=1737181&r1=1737180&r2=1737181&view=diff
==============================================================================
--- maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/site/apt/index.apt.vm (original)
+++ maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/site/apt/index.apt.vm Thu Mar 31 06:35:30 2016
@@ -171,9 +171,11 @@ Doxia Sitetools - Site Renderer
*---------------------------------+----------------------+-------------------------------+
| <<<bodyContent>>> | <<<String>>> | HTML body content of the Doxia generated output. |
*---------------------------------+----------------------+-------------------------------+
-| <<<dateCreation>>> | <<<String>>> | <<Deprecated>>: use <<<creationDate>>>. The date specified in the source document, in the format "yyyyMMdd". |
+| <<<dateCreation>>> | <<<String>>> | <<Deprecated>>: use <<<documentDate>>>. The date specified in the source document, in the format "yyyyMMdd". |
*---------------------------------+----------------------+-------------------------------+
-| <<<creationDate>>> | <<<Date>>> | The date specified in the source document. |
+| <<<creationDate>>> | <<<Date>>> | <<Deprecated>>: use <<<documentDate>>>. The date specified in the source document. |
+*---------------------------------+----------------------+-------------------------------+
+| <<<documentDate>>> | <<<String>>> | The date specified in the source document: semantics has to be chosen by document writer (document creation date, or document last modification date, or ...), and format is not enforced. |
*---------------------------------+----------------------+-------------------------------+
| <<<headContent>>> | <<<String>>> | HTML head content of the Doxia generated output. |
*---------------------------------+----------------------+-------------------------------+