You are viewing a plain text version of this content. The canonical link for it is here.
Posted to doxia-commits@maven.apache.org by vs...@apache.org on 2009/08/29 13:14:06 UTC

svn commit: r809114 - in /maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src: main/resources/org/apache/maven/doxia/siterenderer/resources/ test/java/org/apache/maven/doxia/siterenderer/

Author: vsiveton
Date: Sat Aug 29 11:14:06 2009
New Revision: 809114

URL: http://svn.apache.org/viewvc?rev=809114&view=rev
Log:
o comment blank lines
o publicize Doxia
o added xml:lang and meta Content-Language
o updated test case

Modified:
    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/test/java/org/apache/maven/doxia/siterenderer/DefaultSiteRendererTest.java
    maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/HeadVerifier.java

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=809114&r1=809113&r2=809114&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 Sat Aug 29 11:14:06 2009
@@ -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 at $dateFormat.format( $currentDate ) -->
 #macro ( link $href $name )
   #if ( ( $href.toLowerCase().startsWith("http") || $href.toLowerCase().startsWith("https") ) )
     <a href="$href" class="externalLink">$name</a>
@@ -7,7 +7,7 @@
     <a href="$href">$name</a>
   #end
 #end
-
+##
 #macro ( linkWithImage $href $name $img $align )
   #if ( ( $href.toLowerCase().startsWith("http") || $href.toLowerCase().startsWith("https") ) )
     #if ( $align == "left" )
@@ -23,7 +23,7 @@
     #end
   #end
 #end
-
+##
 #macro ( banner $banner $id )
   #if ( $banner )
     #if( $banner.href )
@@ -31,7 +31,7 @@
     #else
         <div id="$id">
     #end
-
+##
     #if( $banner.src )
         #set ( $src = $banner.src )
         #if ( ! ( $src.toLowerCase().startsWith("http") || $src.toLowerCase().startsWith("https") ) )
@@ -47,7 +47,7 @@
     #else
         $banner.name
     #end
-
+##
     #if( $banner.href )
         </a>
     #else
@@ -55,7 +55,7 @@
     #end
   #end
 #end
-
+##
 #macro ( links $links )
   #set ( $counter = 0 )
   #foreach( $item in $links )
@@ -68,14 +68,14 @@
     #end
   #end
 #end
-
+##
 #macro ( breadcrumbs $breadcrumbs )
   #set ( $counter = 0 )
   #foreach( $item in $breadcrumbs )
     #set ( $counter = $counter + 1 )
     #set ( $currentItemHref = $PathTool.calculateLink( $item.href, $relativePath ) )
     #set ( $currentItemHref = $currentItemHref.replaceAll( "\\", "/" ) )
-
+##
     #if ( $currentItemHref == $alignedFileName || $currentItemHref == "" )
       $item.name
     #else
@@ -86,7 +86,7 @@
     #end
   #end
 #end
-
+##
 #macro ( displayTree $display $item )
   #if ( $item && $item.items && $item.items.size() > 0 )
     #foreach( $subitem in $item.items )
@@ -95,17 +95,17 @@
       #if ( $alignedFileName == $subitemHref )
         #set ( $display = true )
       #end
-
+##
       #displayTree( $display $subitem )
     #end
   #end
 #end
-
+##
 #macro ( menuItem $item )
   #set ( $collapse = "none" )
   #set ( $currentItemHref = $PathTool.calculateLink( $item.href, $relativePath ) )
   #set ( $currentItemHref = $currentItemHref.replaceAll( "\\", "/" ) )
-
+##
   #if ( $item && $item.items && $item.items.size() > 0 )
     #if ( $item.collapse == false )
       #set ( $collapse = "expanded" )
@@ -113,10 +113,10 @@
       ## By default collapsed
       #set ( $collapse = "collapsed" )
     #end
-
+##
     #set ( $display = false )
     #displayTree( $display $item )
-
+##
     #if ( $alignedFileName == $currentItemHref || $display )
       #set ( $collapse = "expanded" )
     #end
@@ -128,7 +128,7 @@
     #else
       #set ( $align = "left" )
     #end
-
+##
     #if ( ! ( $item.img.toLowerCase().startsWith("http") || $item.img.toLowerCase().startsWith("https") ) )
       #set ( $src = $PathTool.calculateLink( $item.img, $relativePath ) )
       #set ( $src = $src.replaceAll( "\\", "/" ) )
@@ -136,19 +136,19 @@
     #else
       #set ( $src = ' src="' + $item.img + '"' )
     #end
-
+##
     #if( $item.alt )
       #set ( $alt = ' alt="' + $item.alt + '"' )
     #else
       #set ( $alt = ' alt="' + $item.name + '"' )
     #end
-
+##
     #if( $item.border )
       #set ( $border = ' border="' + $item.border + '"' )
     #else
       #set ( $border = ' border="0"' )
     #end
-
+##
     #if( $item.width )
       #set ( $width = ' width="' + $item.width + '"' )
     #else
@@ -159,9 +159,9 @@
     #else
       #set ( $height = "" )
     #end
-
+##
     #set ( $img = '<img class="imageLink"' + $src + $alt + $border + $width + $height + "/>" )
-
+##
     #if ( $align == "left" )
       #if ( $alignedFileName == $currentItemHref )
         <strong>$img $item.name</strong>
@@ -193,7 +193,7 @@
   #end
   </li>
 #end
-
+##
 #macro ( mainMenu $menus )
   #foreach( $menu in $menus )
     #if ( $menu.name )
@@ -203,7 +203,7 @@
         #else
           #set ( $align = "left" )
         #end
-
+##
         #if ( ! ( $menu.img.toLowerCase().startsWith("http") || $menu.img.toLowerCase().startsWith("https") ) )
           #set ( $src = $PathTool.calculateLink( $menu.img, $relativePath ) )
           #set ( $src = $src.replaceAll( "\\", "/" ) )
@@ -211,19 +211,19 @@
         #else
           #set ( $src = ' src="' + $menu.img + '"' )
         #end
-
+##
         #if( $menu.alt )
           #set ( $alt = ' alt="' + $menu.alt + '"' )
         #else
           #set ( $alt = ' alt="' + $menu.name + '"' )
         #end
-
+##
         #if( $menu.border )
           #set ( $border = ' border="' + $menu.border + '"' )
         #else
           #set ( $border = ' border="0"' )
         #end
-
+##
         #if( $menu.width )
           #set ( $width = ' width="' + $menu.width + '"' )
         #else
@@ -234,9 +234,9 @@
         #else
           #set ( $height = "" )
         #end
-
+##
         #set ( $img = '<img class="imageLink"' + $src + $alt + $border + $width + $height + "/>" )
-
+##
         #if ( $align == "left" )
         <h5>$img $menu.name</h5>
         #else
@@ -255,7 +255,7 @@
     #end
   #end
 #end
-
+##
 #macro ( copyright )
   #if ( $project )
     #if ( ${project.organization} && ${project.organization.name} )
@@ -263,15 +263,15 @@
     #else
       #set ( $period = "." )
    #end
-
+##
    #set ( $currentYear = ${currentDate.year} + 1900 )
-
+##
     #if ( ${project.inceptionYear} && ( ${project.inceptionYear} != ${currentYear.toString()} ) )
       ${project.inceptionYear}-${currentYear}${period}
     #else
       ${currentYear}${period}
     #end
-
+##
     #if ( ${project.organization} )
       #if ( ${project.organization.name} && ${project.organization.url} )
           <a href="$project.organization.url">${project.organization.name}</a>.
@@ -281,24 +281,24 @@
     #end
   #end
 #end
-
+##
 #macro ( publishDate $position $publishDate $version )
   #if ( $publishDate && $publishDate.format )
     #set ( $format = $publishDate.format )
   #else
     #set ( $format = "yyyy-MM-dd" )
   #end
-
+##
   $dateFormat.applyPattern( $format )
-
+##
   #set ( $dateToday = $dateFormat.format( $currentDate ) )
-
+##
   #if ( $publishDate && $publishDate.position )
     #set ( $datePosition = $publishDate.position )
   #else
     #set ( $datePosition = "left" )
   #end
-
+##
   #if ( $version )
     #if ( $version.position )
       #set ( $versionPosition = $version.position )
@@ -309,7 +309,7 @@
     #set ( $version = "" )
     #set ( $versionPosition = "left" )
   #end
-
+##
   #set ( $breadcrumbs = $decoration.body.breadcrumbs )
   #set ( $links = $decoration.body.links )
 
@@ -318,7 +318,7 @@
   #else
     #set ( $prefix = "" )
   #end
-
+##
   #if ( $datePosition.equalsIgnoreCase( $position ) )
     #if ( ( $datePosition.equalsIgnoreCase( "right" ) ) || ( $datePosition.equalsIgnoreCase( "bottom" ) ) )
       $prefix <span id="publishDate">$i18n.getString( "site-renderer", $locale, "template.lastpublished" ): $dateToday</span>
@@ -366,75 +366,75 @@
     #end
   #end
 #end
-
+##
 #macro ( poweredByLogo $poweredBy )
-    #if( $poweredBy )
-        #foreach ($item in $poweredBy)
-            #if( $item.href )
-                #set ( $href = $PathTool.calculateLink( $item.href, $relativePath ) )
-                #set ( $href = $href.replaceAll( "\\", "/" ) )
-            #else
-                #set ( $href="http://maven.apache.org/" )
-            #end
-
-            #if( $item.name )
-                #set ( $name = $item.name )
-            #else
-                #set ( $name = $i18n.getString( "site-renderer", $locale, "template.builtby" )  )
-                #set ( $name = "${name} Maven"  )
-            #end
-
-            #if( $item.img )
-                #set ( $img = $item.img )
-            #else
-                #set ( $img = "images/logos/maven-feather.png" )
-            #end
-
-            #if ( ! ( $img.toLowerCase().startsWith("http") || $img.toLowerCase().startsWith("https") ) )
-              #set ( $img = $PathTool.calculateLink( $img, $relativePath ) )
-              #set ( $img = $src.replaceAll( "\\", "/" ) )
-            #end
-
-            #if( $item.alt )
-                #set ( $alt = ' alt="' + $item.alt + '"' )
-            #else
-                #set ( $alt = ' alt="' + $name + '"' )
-            #end
-
-            #if( $item.border )
-                #set ( $border = ' border="' + $item.border + '"' )
-            #else
-                #set ( $border = "" )
-            #end
-
-            #if( $item.width )
-                #set ( $width = ' width="' + $item.width + '"' )
-            #else
-                #set ( $width = "" )
-            #end
-            #if( $item.height )
-                #set ( $height = ' height="' + $item.height + '"' )
-            #else
-                #set ( $height = "" )
-            #end
-
-            <a href="$href" title="$name" class="poweredBy">
-              <img class="poweredBy" $alt src="$img" $border $width $height />
-            </a>
-        #end
-        #if( $poweredBy.isEmpty() )
-        <a href="http://maven.apache.org/" title="$i18n.getString( "site-renderer", $locale, "template.builtby" ) Maven" class="poweredBy">
-          <img class="poweredBy" alt="$i18n.getString( "site-renderer", $locale, "template.builtby" ) Maven" src="$relativePath/images/logos/maven-feather.png" />
-        </a>
-        #end
-    #else
-        <a href="http://maven.apache.org/" title="$i18n.getString( "site-renderer", $locale, "template.builtby" ) Maven" class="poweredBy">
-          <img class="poweredBy" alt="$i18n.getString( "site-renderer", $locale, "template.builtby" ) Maven" src="$relativePath/images/logos/maven-feather.png" />
-        </a>
+  #if( $poweredBy )
+    #foreach ($item in $poweredBy)
+      #if( $item.href )
+        #set ( $href = $PathTool.calculateLink( $item.href, $relativePath ) )
+        #set ( $href = $href.replaceAll( "\\", "/" ) )
+      #else
+        #set ( $href="http://maven.apache.org/" )
+      #end
+##
+      #if( $item.name )
+        #set ( $name = $item.name )
+      #else
+        #set ( $name = $i18n.getString( "site-renderer", $locale, "template.builtby" )  )
+        #set ( $name = "${name} Maven"  )
+      #end
+##
+      #if( $item.img )
+        #set ( $img = $item.img )
+      #else
+        #set ( $img = "images/logos/maven-feather.png" )
+      #end
+##
+      #if ( ! ( $img.toLowerCase().startsWith("http") || $img.toLowerCase().startsWith("https") ) )
+        #set ( $img = $PathTool.calculateLink( $img, $relativePath ) )
+        #set ( $img = $src.replaceAll( "\\", "/" ) )
+      #end
+##
+      #if( $item.alt )
+        #set ( $alt = ' alt="' + $item.alt + '"' )
+      #else
+        #set ( $alt = ' alt="' + $name + '"' )
+      #end
+##
+      #if( $item.border )
+        #set ( $border = ' border="' + $item.border + '"' )
+      #else
+        #set ( $border = "" )
+      #end
+##
+      #if( $item.width )
+        #set ( $width = ' width="' + $item.width + '"' )
+      #else
+        #set ( $width = "" )
+      #end
+      #if( $item.height )
+        #set ( $height = ' height="' + $item.height + '"' )
+      #else
+        #set ( $height = "" )
+      #end
+##
+      <a href="$href" title="$name" class="poweredBy">
+        <img class="poweredBy" $alt src="$img" $border $width $height />
+      </a>
+    #end
+    #if( $poweredBy.isEmpty() )
+      <a href="http://maven.apache.org/" title="$i18n.getString( "site-renderer", $locale, "template.builtby" ) Maven" class="poweredBy">
+        <img class="poweredBy" alt="$i18n.getString( "site-renderer", $locale, "template.builtby" ) Maven" src="$relativePath/images/logos/maven-feather.png" />
+      </a>
     #end
+  #else
+    <a href="http://maven.apache.org/" title="$i18n.getString( "site-renderer", $locale, "template.builtby" ) Maven" class="poweredBy">
+      <img class="poweredBy" alt="$i18n.getString( "site-renderer", $locale, "template.builtby" ) Maven" src="$relativePath/images/logos/maven-feather.png" />
+    </a>
+  #end
 #end
-
-<html xmlns="http://www.w3.org/1999/xhtml">
+##
+<html xmlns="http://www.w3.org/1999/xhtml"#if ( $locale ) xml:lang="$locale.language" lang="$locale.language"#end>
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=${outputEncoding}" />
     <title>$title</title>
@@ -444,15 +444,18 @@
       @import url("$relativePath/css/site.css");
     </style>
     <link rel="stylesheet" href="$relativePath/css/print.css" type="text/css" media="print" />
-    #foreach( $author in $authors )
+#foreach( $author in $authors )
       <meta name="author" content="$author" />
-    #end
+#end
 #if ( $dateCreation )
     <meta name="Date-Creation-yyyymmdd" content="$dateCreation" />
 #end
 #if ( $dateRevision )
     <meta name="Date-Revision-yyyymmdd" content="$dateRevision" />
 #end
+#if ( $locale )
+    <meta http-equiv="Content-Language" content="$locale.language" />
+#end
     #if ( $decoration.body.head )
       #foreach( $item in $decoration.body.head.getChildren() )
         ## Workaround for DOXIA-150 due to a non-desired behaviour in p-u

Modified: maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/DefaultSiteRendererTest.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/DefaultSiteRendererTest.java?rev=809114&r1=809113&r2=809114&view=diff
==============================================================================
--- maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/DefaultSiteRendererTest.java (original)
+++ maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/DefaultSiteRendererTest.java Sat Aug 29 11:14:06 2009
@@ -29,6 +29,7 @@
 import java.util.HashMap;
 import java.util.Iterator;
 import java.util.List;
+import java.util.Locale;
 import java.util.Map;
 
 import org.apache.maven.doxia.site.decoration.DecorationModel;
@@ -61,6 +62,11 @@
     private Renderer renderer;
 
     /**
+     * The locale before executing tests.
+     */
+    private Locale oldLocale;
+
+    /**
      * @throws java.lang.Exception if something goes wrong.
      * @see org.codehaus.plexus.PlexusTestCase#setUp()
      */
@@ -88,6 +94,9 @@
 
         // Safety
         FileUtils.deleteDirectory( getTestFile( OUTPUT ) );
+
+        oldLocale = Locale.getDefault();
+        Locale.setDefault( Locale.ENGLISH );
     }
 
     /**
@@ -99,6 +108,8 @@
     {
         release( renderer );
         super.tearDown();
+
+        Locale.setDefault( oldLocale );
     }
 
     /**

Modified: maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/HeadVerifier.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/HeadVerifier.java?rev=809114&r1=809113&r2=809114&view=diff
==============================================================================
--- maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/HeadVerifier.java (original)
+++ maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/HeadVerifier.java Sat Aug 29 11:14:06 2009
@@ -87,6 +87,10 @@
         assertEquals( meta.getAttributeValue( "content" ), new SimpleDateFormat( "yyyyMMdd" ).format( new Date() ) );
 
         meta = (HtmlMeta) elementIterator.next();
+        assertEquals( meta.getAttributeValue( "http-equiv" ), "Content-Language" );
+        assertEquals( meta.getAttributeValue( "content" ), "en" );
+
+        meta = (HtmlMeta) elementIterator.next();
         assertEquals( meta.getAttributeValue( "name" ), "description" );
         assertEquals( meta.getAttributeValue( "content" ), "Free Web tutorials" );