From 40d02e54f2d24eacdfc0b4494aa6368c22830a9e Mon Sep 17 00:00:00 2001
From: Rene Saarsoo <nene@triin.net>
Date: Fri, 10 Jun 2011 12:02:39 +0300
Subject: [PATCH] Add configurable footer.

Useful for showing some about-information for the docs.

Added code to Rakefile to display the current JSDuck revision there.
---
 Rakefile                              |  4 ++++
 bin/jsduck                            |  4 ++++
 lib/jsduck/app.rb                     |  3 +++
 template/app/view/Viewport.js         |  6 ++++++
 template/index.html                   |  3 ++-
 template/resources/sass/viewport.scss | 14 +++++++++++++-
 6 files changed, 32 insertions(+), 2 deletions(-)

diff --git a/Rakefile b/Rakefile
index 0afc3d0b..8d503f4d 100644
--- a/Rakefile
+++ b/Rakefile
@@ -72,9 +72,11 @@ end
 desc "Run JSDuck on ExtJS SDK for export"
 task :export do
   load_sdk_vars
+  rev = `git rev-parse HEAD`.slice(0, 7)
 
   run_jsduck([
     "--title", "Ext JS 4.0.3 API Documentation",
+    "--footer", "ExtJS 4.0.3 Documentation from Sencha. Generated with <a href='https://github.com/nene/jsduck'>JSDuck</a> revison #{rev}",
     "--extjs-path", "extjs/ext-all.js",
     "#{SDK_DIR}/extjs/src",
     "#{SDK_DIR}/platform/src",
@@ -92,6 +94,7 @@ end
 desc "Run JSDuck on ExtJS SDK for export"
 task :live_docs do
   load_sdk_vars
+  rev = `git rev-parse HEAD`.slice(0, 7)
 
   analytics = <<-EOHTML
     <script type="text/javascript">
@@ -128,6 +131,7 @@ task :live_docs do
 
   run_jsduck([
     "--title", "Ext JS 4.0.3 API Documentation",
+    "--footer", "ExtJS 4.0.3 Documentation from Sencha. Generated with <a href='https://github.com/nene/jsduck'>JSDuck</a> revison #{rev}",
     "--extjs-path", "extjs/ext-all.js",
     "--append-html", analytics,
     "#{SDK_DIR}/extjs/src",
diff --git a/bin/jsduck b/bin/jsduck
index 6b463f87..6e78dbc6 100755
--- a/bin/jsduck
+++ b/bin/jsduck
@@ -44,6 +44,10 @@ opts = OptionParser.new do | opts |
     app.extjs_path = path
   end
 
+  opts.on('--footer=TEXT', "Custom footer text for the documentation app.", " ") do |text|
+    app.footer = text
+  end
+
   opts.on('--guides=PATH', "Path to guides directory.",
     "Each subdirectory of that is treated as a guide",
     "and is expectd to contain a REAME.md file,",
diff --git a/lib/jsduck/app.rb b/lib/jsduck/app.rb
index 9b92cd73..30dc6eb0 100644
--- a/lib/jsduck/app.rb
+++ b/lib/jsduck/app.rb
@@ -33,6 +33,7 @@ module JsDuck
     attr_accessor :external_classes
     attr_accessor :show_private_classes
     attr_accessor :title
+    attr_accessor :footer
     attr_accessor :extjs_path
     attr_accessor :append_html
 
@@ -50,6 +51,7 @@ module JsDuck
       @external_classes = []
       @show_private_classes = false
       @title = "Ext JS API Documentation"
+      @footer = 'Generated with <a href="https://github.com/nene/jsduck">JSDuck</a>.'
       @extjs_path = "extjs/ext-all-debug.js"
       @append_html = ""
       @timer = Timer.new
@@ -321,6 +323,7 @@ module JsDuck
       Logger.instance.log("Creating #{dir}/index.html...")
       html = IO.read(template_dir+"/index.html")
       html.gsub!("{title}", @title)
+      html.gsub!("{footer}", @footer)
       html.gsub!("{extjs_path}", @extjs_path)
       html.gsub!("{append_html}", @append_html)
       FileUtils.rm(dir+"/index.html")
diff --git a/template/app/view/Viewport.js b/template/app/view/Viewport.js
index f9087001..f49173f1 100644
--- a/template/app/view/Viewport.js
+++ b/template/app/view/Viewport.js
@@ -103,6 +103,12 @@ Ext.define('Docs.view.Viewport', {
                         }
                     ]
                 }
+            },
+            {
+                region: 'south',
+                id: 'footer',
+                contentEl: 'footer-content',
+                height: 15
             }
         ];
 
diff --git a/template/index.html b/template/index.html
index 13d6365a..346cf9f9 100644
--- a/template/index.html
+++ b/template/index.html
@@ -4,7 +4,7 @@
   <title>{title}</title>
   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   <link rel="shortcut icon" type="image/ico" href="favicon.ico" />
-	<link rel="canonical" href="http://docs.sencha.com/ext-js/4-0/"/>
+  <link rel="canonical" href="http://docs.sencha.com/ext-js/4-0/"/>
   <link rel="stylesheet" href="resources/css/reset.css" type="text/css" />
   <link rel="stylesheet" href="resources/css/docs-ext.css" type="text/css" />
   <link rel="stylesheet" href="resources/css/scrollbars.css" type="text/css" />
@@ -35,6 +35,7 @@
         <input type="hidden" id="x-history-field" />
         <iframe id="x-history-frame"></iframe>
     </form>
+    <div id="footer-content" style="display: none">{footer}</div>
     {append_html}
 </body>
 </html>
diff --git a/template/resources/sass/viewport.scss b/template/resources/sass/viewport.scss
index a2fec85f..a6e6ca70 100644
--- a/template/resources/sass/viewport.scss
+++ b/template/resources/sass/viewport.scss
@@ -196,8 +196,20 @@ a:hover {
 #center-container, #west-region-container {
   background: #F8F8F8 url(../images/headBG.png) repeat-x; }
 
+#footer {
+  background: #F8F8F8;
+  color: gray;
+  text-align: right;
+  font-size: 10px;
+  padding-right: 40px;
+  // The footer-content div is initially hidden on page to prevent it
+  // being visible while loading-screen is shown.  Only after the div is
+  // brought inside footer component, make it visible.
+  #footer-content {
+    display: block !important; } }
+
 #center-container {
-  padding: 20px;
+  padding: 20px 20px 5px 20px;
 
   h1 {
     font-family: "klavika-web-1", "klavika-web-2", sans-serif;
-- 
GitLab