You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tomee.apache.org by rm...@apache.org on 2011/09/12 18:13:32 UTC

svn commit: r1169815 - in /openejb/trunk/sandbox/tools/src/main: java/org/apache/openejb/tools/examples/ resources/generate-index/ resources/generate-index/javascript/ resources/generate-index/velocity/

Author: rmannibucau
Date: Mon Sep 12 16:13:31 2011
New Revision: 1169815

URL: http://svn.apache.org/viewvc?rev=1169815&view=rev
Log:
OPENEJB-1657 OPENEJB-1656 OPENEJB-1658 facebook/twitter links + breadcrumb + example name replaced in readme.*

Added:
    openejb/trunk/sandbox/tools/src/main/resources/generate-index/javascript/common.js
    openejb/trunk/sandbox/tools/src/main/resources/generate-index/velocity/breadcrumb.vm
Modified:
    openejb/trunk/sandbox/tools/src/main/java/org/apache/openejb/tools/examples/GenerateIndex.java
    openejb/trunk/sandbox/tools/src/main/java/org/apache/openejb/tools/examples/ViewHelper.java
    openejb/trunk/sandbox/tools/src/main/resources/generate-index/config.properties
    openejb/trunk/sandbox/tools/src/main/resources/generate-index/velocity/code.vm
    openejb/trunk/sandbox/tools/src/main/resources/generate-index/velocity/example.vm
    openejb/trunk/sandbox/tools/src/main/resources/generate-index/velocity/external.vm
    openejb/trunk/sandbox/tools/src/main/resources/generate-index/velocity/footer.vm
    openejb/trunk/sandbox/tools/src/main/resources/generate-index/velocity/header.vm

Modified: openejb/trunk/sandbox/tools/src/main/java/org/apache/openejb/tools/examples/GenerateIndex.java
URL: http://svn.apache.org/viewvc/openejb/trunk/sandbox/tools/src/main/java/org/apache/openejb/tools/examples/GenerateIndex.java?rev=1169815&r1=1169814&r2=1169815&view=diff
==============================================================================
--- openejb/trunk/sandbox/tools/src/main/java/org/apache/openejb/tools/examples/GenerateIndex.java (original)
+++ openejb/trunk/sandbox/tools/src/main/java/org/apache/openejb/tools/examples/GenerateIndex.java Mon Sep 12 16:13:31 2011
@@ -25,6 +25,7 @@ import java.io.File;
 import java.io.IOException;
 import java.util.ArrayList;
 import java.util.Collection;
+import java.util.Collections;
 import java.util.List;
 import java.util.Map;
 import java.util.Properties;
@@ -116,6 +117,12 @@ public class GenerateIndex {
         if (examples.contains(extractedDir)) {
             examples.remove(extractedDir);
         }
+
+		Map<String, String> exampleNames = new TreeMap<String, String>(Collections.reverseOrder()); // to start with the longest
+		for (File example : examples) {
+			exampleNames.put(example.getName(), "../" + example.getName()); // value is the link... should be enough
+		}
+		
         for (File example : examples) {
             // create a directory for each example
             File generated = new File(generatedDir, example.getPath().replace(extractedDir.getPath(), ""));
@@ -128,6 +135,12 @@ public class GenerateIndex {
                 if (readme.exists()) {
                     try {
                         html = PROCESSOR.markdown(FileUtils.readFileToString(readme));
+
+						// auto link examples
+                        // all example names should start with a space in the md if it was not already replaced
+						for (Map.Entry<String, String> exampleName : exampleNames.entrySet()){
+							html = html.replace(" " + exampleName.getKey(), "[" + exampleName.getKey() + "](" + exampleName.getValue() + ")");
+						}
                         break;
                     } catch (IOException e) {
                         LOGGER.warn("can't read readme file for example " + example.getName());
@@ -168,14 +181,18 @@ public class GenerateIndex {
                 File sourceFile = new File(generated, source);
                 mkdirp(sourceFile.getParentFile());
 
+				String sourcePath = sourceFile.getPath() + ".html";
                 tpl(properties.getProperty("template.code"),
                         newMap(String.class, Object.class)
                                 .add("title", source + " source")
+                                .add("breadcrumbName", file.getName())
                                 .add(OpenEJBTemplate.USER_JAVASCRIPTS, newList(String.class).add("prettyprint.js").list())
                                 .add("file", source)
                                 .add("code", code)
+                                .add("parentLink", link)
+                                .add("parentLabel", example.getName())
                                 .map(),
-                        sourceFile.getPath() + ".html");
+                        sourcePath);
             }
 
             List<String> resources = removePrefix(example.getPath(), resourceFiles);
@@ -195,6 +212,7 @@ public class GenerateIndex {
                 tpl(properties.getProperty("template.default"),
                         newMap(String.class, Object.class)
                                 .add("title", example.getName() + " example")
+                                .add("breadcrumbName", example.getName())
                                 .add(OpenEJBTemplate.USER_JAVASCRIPTS, newList(String.class).add("prettyprint.js").list())
                                 .add("apis", apiCount)
                                 .add("link", zip.getName())
@@ -206,6 +224,7 @@ public class GenerateIndex {
                 tpl(properties.getProperty("template.external"),
                         newMap(String.class, Object.class)
                                 .add("title", example.getName() + " example")
+                                .add("breadcrumbName", example.getName())
                                 .add(OpenEJBTemplate.USER_JAVASCRIPTS, newList(String.class).add("prettyprint.js").list())
                                 .add("content", html)
                                 .map(),

Modified: openejb/trunk/sandbox/tools/src/main/java/org/apache/openejb/tools/examples/ViewHelper.java
URL: http://svn.apache.org/viewvc/openejb/trunk/sandbox/tools/src/main/java/org/apache/openejb/tools/examples/ViewHelper.java?rev=1169815&r1=1169814&r2=1169815&view=diff
==============================================================================
--- openejb/trunk/sandbox/tools/src/main/java/org/apache/openejb/tools/examples/ViewHelper.java (original)
+++ openejb/trunk/sandbox/tools/src/main/java/org/apache/openejb/tools/examples/ViewHelper.java Mon Sep 12 16:13:31 2011
@@ -67,7 +67,7 @@ public final class ViewHelper {
     public static List<String> removePrefix(String prefix, List<File> files) {
         List<String> processed = new ArrayList<String>();
         for (File file : files) {
-            String path = file.getPath().substring(prefix.length());
+            String path = file.getPath().substring(prefix.length()).replace(File.separator, "/");
             if (path.startsWith("/")) {
                 processed.add(path.substring(1));
             } else {

Modified: openejb/trunk/sandbox/tools/src/main/resources/generate-index/config.properties
URL: http://svn.apache.org/viewvc/openejb/trunk/sandbox/tools/src/main/resources/generate-index/config.properties?rev=1169815&r1=1169814&r2=1169815&view=diff
==============================================================================
--- openejb/trunk/sandbox/tools/src/main/resources/generate-index/config.properties (original)
+++ openejb/trunk/sandbox/tools/src/main/resources/generate-index/config.properties Mon Sep 12 16:13:31 2011
@@ -1,6 +1,7 @@
 # website config
 home.resources = http://ci.apache.org/projects/openejb/examples-generated
-home.site = http://ci.apache.org/projects/openejb/examples-generated
+#home.site = http://ci.apache.org/projects/openejb/examples-generated
+home.site = /opt/dev/openejb/tools/target/examples/generated
 
 # input/output
 examples.zip = ../examples.zip

Added: openejb/trunk/sandbox/tools/src/main/resources/generate-index/javascript/common.js
URL: http://svn.apache.org/viewvc/openejb/trunk/sandbox/tools/src/main/resources/generate-index/javascript/common.js?rev=1169815&view=auto
==============================================================================
--- openejb/trunk/sandbox/tools/src/main/resources/generate-index/javascript/common.js (added)
+++ openejb/trunk/sandbox/tools/src/main/resources/generate-index/javascript/common.js Mon Sep 12 16:13:31 2011
@@ -0,0 +1,5 @@
+$(document).ready(function() {
+	var location = escape(window.localtion.href).replace("+", "%2B").replace("/", "%2F");
+	$('fb_share_link').attr('share_url', location);
+	$('fb_share_link').attr('share_url', 'http://twitter.com/share?url=' + location + "&via=OpenEJB");
+}

Added: openejb/trunk/sandbox/tools/src/main/resources/generate-index/velocity/breadcrumb.vm
URL: http://svn.apache.org/viewvc/openejb/trunk/sandbox/tools/src/main/resources/generate-index/velocity/breadcrumb.vm?rev=1169815&view=auto
==============================================================================
--- openejb/trunk/sandbox/tools/src/main/resources/generate-index/velocity/breadcrumb.vm (added)
+++ openejb/trunk/sandbox/tools/src/main/resources/generate-index/velocity/breadcrumb.vm Mon Sep 12 16:13:31 2011
@@ -0,0 +1 @@
+<a href="$home">Example Home</a> #if ($parentLink) &gt; <a href="$home/$parentLink">$parentLabel</a> #end &gt; $breadcrumbName
\ No newline at end of file

Modified: openejb/trunk/sandbox/tools/src/main/resources/generate-index/velocity/code.vm
URL: http://svn.apache.org/viewvc/openejb/trunk/sandbox/tools/src/main/resources/generate-index/velocity/code.vm?rev=1169815&r1=1169814&r2=1169815&view=diff
==============================================================================
--- openejb/trunk/sandbox/tools/src/main/resources/generate-index/velocity/code.vm (original)
+++ openejb/trunk/sandbox/tools/src/main/resources/generate-index/velocity/code.vm Mon Sep 12 16:13:31 2011
@@ -1,4 +1,5 @@
 #parse("generate-index/velocity/header.vm")
+#parse("generate-index/velocity/breadcrumb.vm")
             <h2>Source: $file</h2>
 
             <div class="preformatted panel" style="border-width: 1px;">

Modified: openejb/trunk/sandbox/tools/src/main/resources/generate-index/velocity/example.vm
URL: http://svn.apache.org/viewvc/openejb/trunk/sandbox/tools/src/main/resources/generate-index/velocity/example.vm?rev=1169815&r1=1169814&r2=1169815&view=diff
==============================================================================
--- openejb/trunk/sandbox/tools/src/main/resources/generate-index/velocity/example.vm (original)
+++ openejb/trunk/sandbox/tools/src/main/resources/generate-index/velocity/example.vm Mon Sep 12 16:13:31 2011
@@ -1,4 +1,5 @@
 #parse("generate-index/velocity/header.vm")
+#parse("generate-index/velocity/breadcrumb.vm")
             <div id="download">
                 <a href="$link">Download as zip</a>
             </div>

Modified: openejb/trunk/sandbox/tools/src/main/resources/generate-index/velocity/external.vm
URL: http://svn.apache.org/viewvc/openejb/trunk/sandbox/tools/src/main/resources/generate-index/velocity/external.vm?rev=1169815&r1=1169814&r2=1169815&view=diff
==============================================================================
--- openejb/trunk/sandbox/tools/src/main/resources/generate-index/velocity/external.vm (original)
+++ openejb/trunk/sandbox/tools/src/main/resources/generate-index/velocity/external.vm Mon Sep 12 16:13:31 2011
@@ -1,3 +1,4 @@
 #parse("generate-index/velocity/header.vm")
+#parse("generate-index/velocity/breadcrumb.vm")
             $content
 #parse("generate-index/velocity/footer.vm")

Modified: openejb/trunk/sandbox/tools/src/main/resources/generate-index/velocity/footer.vm
URL: http://svn.apache.org/viewvc/openejb/trunk/sandbox/tools/src/main/resources/generate-index/velocity/footer.vm?rev=1169815&r1=1169814&r2=1169815&view=diff
==============================================================================
--- openejb/trunk/sandbox/tools/src/main/resources/generate-index/velocity/footer.vm (original)
+++ openejb/trunk/sandbox/tools/src/main/resources/generate-index/velocity/footer.vm Mon Sep 12 16:13:31 2011
@@ -19,6 +19,8 @@
                   <SMALL>
                     <NOTICE><!-- $FOOTER -->
                       Apache OpenEJB is an project of The Apache Software Foundation (ASF)
+					  <a id="fb_share_link" name="fb_share" type="icon" share_url=""></a>
+					  <a id="tweeter_share_link" href="" class="twitter-share-button">Share on twitter</a>
                     </NOTICE>
                   </SMALL>
                 </SPAN>
@@ -44,6 +46,7 @@
         _uacct = "UA-2717626-1";
         urchinTracker();
       </SCRIPT>
+	  <script src="http://static.ak.fbcdn.net/connect.php/js/FB.Share" type="text/javascript"></script>
     </SPAN>
     </body>
 </html>

Modified: openejb/trunk/sandbox/tools/src/main/resources/generate-index/velocity/header.vm
URL: http://svn.apache.org/viewvc/openejb/trunk/sandbox/tools/src/main/resources/generate-index/velocity/header.vm?rev=1169815&r1=1169814&r2=1169815&view=diff
==============================================================================
--- openejb/trunk/sandbox/tools/src/main/resources/generate-index/velocity/header.vm (original)
+++ openejb/trunk/sandbox/tools/src/main/resources/generate-index/velocity/header.vm Mon Sep 12 16:13:31 2011
@@ -16,6 +16,8 @@
 
         <script src="$base/javascript/prettify.js" type="text/javascript"></script>
         <script src="$base/javascript/jquery-latest.js"></script>
+		<script src="http://platform.twitter.com/widgets.js" type="text/javascript"></script>
+		<script src="$base/javascript/common.js"></script>
 #if ($javascripts )
 #foreach( $js in $javascripts )
         <script src="$base/javascript/$js"></script>