gollum 1.3.1 → 1.4.2

data/lib/gollum.rb

@@ -16,11 +16,12 @@ require File.expand_path('../gollum/wiki', __FILE__)
 require File.expand_path('../gollum/page', __FILE__)
 require File.expand_path('../gollum/file', __FILE__)
 require File.expand_path('../gollum/markup', __FILE__)
-require File.expand_path('../gollum/albino', __FILE__)
 require File.expand_path('../gollum/sanitization', __FILE__)
+require File.expand_path('../gollum/tex', __FILE__)
+require File.expand_path('../gollum/web_sequence_diagram', __FILE__)
 
 module Gollum
-  VERSION = '1.3.1'
+  VERSION = '1.4.2'
 
   class Error < StandardError; end
 

data/lib/gollum/committer.rb

@@ -1,7 +1,7 @@
 module Gollum
-  # Responsible for handling the commit process for a Wiki.  It sets up the 
+  # Responsible for handling the commit process for a Wiki.  It sets up the
   # Git index, provides methods for modifying the tree, and stores callbacks
-  # to be fired after the commit has been made.  This is specifically 
+  # to be fired after the commit has been made.  This is specifically
   # designed to handle multiple updated pages in a single commit.
   class Committer
     # Gets the instance of the Gollum::Wiki that is being updated.
@@ -21,7 +21,7 @@ module Gollum
     #           :tree      - Optional String SHA of the tree to create the
     #                        index from.
     #           :committer - Optional Gollum::Committer instance.  If provided,
-    #                        assume that this operation is part of batch of 
+    #                        assume that this operation is part of batch of
     #                        updates and the commit happens later.
     #
     # Returns the Committer instance.
@@ -73,7 +73,7 @@ module Gollum
     #
     # dir    - The String subdirectory of the Gollum::Page without any
     #          prefix or suffix slashes (e.g. "foo/bar").
-    # name   - The String Gollum::Page name.
+    # name   - The String Gollum::Page filename_stripped.
     # format - The Symbol Gollum::Page format.
     # data   - The String wiki data to store in the tree map.
     # allow_same_ext - A Boolean determining if the tree map allows the same
@@ -111,7 +111,8 @@ module Gollum
     # is a working directory present.
     #
     # dir    - The String directory in which the file lives.
-    # name   - The String name of the page (may be in human format).
+    # name   - The String name of the page or the stripped filename
+    #          (should be pre-canonicalized if required).
     # format - The Symbol format of the page.
     #
     # Returns nothing.
@@ -151,7 +152,7 @@ module Gollum
 
     # Adds a callback to be fired after a commit.
     #
-    # block - A block that expects this Committer instance and the created 
+    # block - A block that expects this Committer instance and the created
     #         commit's SHA1 as the arguments.
     #
     # Returns nothing.

data/lib/gollum/frontend/app.rb

@@ -13,9 +13,9 @@ module Precious
     dir = File.dirname(File.expand_path(__FILE__))
 
     # We want to serve public assets for now
-
-    set :public,    "#{dir}/public"
-    set :static,    true
+    set :public_folder, "#{dir}/public"
+    set :static,         true
+    set :default_markup, :markdown
 
     set :mustache, {
       # Tell mustache where the Views constant lives
@@ -78,7 +78,7 @@ module Precious
 
       begin
         wiki.write_page(name, format, params[:content], commit_message)
-        redirect "/#{CGI.escape(name)}"
+        redirect "/#{CGI.escape(Gollum::Page.cname(name))}"
       rescue Gollum::DuplicatePageError => e
         @message = "Duplicate page: #{e.message}"
         mustache :error
@@ -145,6 +145,12 @@ module Precious
       mustache :compare
     end
 
+    get '/_tex.png' do
+      content_type 'image/png'
+      formula = Base64.decode64(params[:data])
+      Gollum::Tex.render_formula(formula)
+    end
+
     get %r{^/(javascript|css|images)} do
       halt 404
     end
@@ -200,7 +206,7 @@ module Precious
     end
 
     def update_wiki_page(wiki, page, content, commit_message, name = nil, format = nil)
-      return if !page ||  
+      return if !page ||
         ((!content || page.raw_data == content) && page.format == format)
       name    ||= page.name
       format    = (format || page.format).to_sym

data/lib/gollum/frontend/public/css/gollum.css

@@ -1,3 +1,10 @@
+#wiki-wrapper #template blockquote {
+  margin: 1em 0;
+  border-left: 4px solid #ddd;
+  padding-left: .8em;
+  color: #555;
+}
+
 /*
   gollum.css
   A basic stylesheet for Gollum
@@ -6,7 +13,7 @@
 /* @section core */
 body, html {
   font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
-  font-size: 10px; /* -> 1em */
+  font-size: 10px;
   margin: 0;
   padding: 0;
 }
@@ -30,18 +37,13 @@ a:hover, a:visited {
 
 /* @section head */
 #head {
-  border-bottom: 1px solid #ccc;
   margin: 4.5em 0 0.5em;
   padding: 0.5em 0;
   overflow: hidden;
 }
 
   #head h1 {
-    font-size: 3.3em;
-    float: left;
-    line-height: normal;
-    margin: 0;
-    padding: 0.08em 0 0 0;
+     display: none;
   }
   
   #head ul.actions {
@@ -206,12 +208,11 @@ a:hover, a:visited {
   
   /* @section page-footer */
   .page #footer {
-    border-top: 1px solid #ccc;
     margin: 1em 0 7em;
   }
   
   #footer p#last-edit {
-    font-size: 1.2em;
+    font-size: .9em;
     line-height: 1.6em;
     color: #999;
     margin: 0.9em 0;
@@ -647,18 +648,13 @@ ul.actions {
     text-indent: -5000px;
     width: 28px;
   }
-  
+
   .ff #head #searchbar #searchbar-fauxtext #search-submit span,
   .ie #head #searchbar #searchbar-fauxtext #search-submit span {
     height: 2.2em;
   }
-  
+
   #head #searchbar #searchbar-fauxtext #search-submit:hover span {
     background-position: -431px -28px;
     padding: 0;
   }
-
-
-#MathJax_Message {
-  display: none;
-}

data/lib/gollum/frontend/public/css/template.css

@@ -2,9 +2,29 @@
   Gollum v3 Template
 */
 
+/* margin & padding reset*/
+* {
+  margin: 0;
+  padding: 0;
+}
+
+
+html, body {
+  color: black;
+}
+
+body {
+  font: 13.34px helvetica,arial,freesans,clean,sans-serif;
+  line-height: 1.4;
+}
+
+img {
+  border: 0;
+}
+
 #template {
-  font-size: 13px;
-  line-height: 23px;
+  font-size: 14px;
+  line-height: 1.4;
   margin-bottom: 40px;
 }
 
@@ -15,7 +35,7 @@ a.absent {
 
 /* Primary Body Copy */
 #template p {
-  margin: 16px 0 0;
+  margin: 1em 0;
   padding: 0;
 }
   
@@ -32,15 +52,14 @@ a.absent {
 }
 
 #template h1 {
-  border-top: 4px solid #ccc;
-  font-size: 32px;
+  border-bottom: 1px solid #ccc;
+  font-size: 33px; /* was 32, GH is 33px */
   line-height: normal;
-  padding: 10px 0 0;
-  margin: 30px 0 0;
+  padding: .08em 0 0 0;
+  margin: 0;
 }
 
 #template h2 {
-  border-top: 4px solid #ccc;
   font-size: 22px;
   line-height: normal;
   margin: 22px 0 0;
@@ -91,7 +110,6 @@ a.absent {
   /* Border Reset for headers with horizontal rules */ 
   #template > h2:first-child, 
   #template > h1:first-child {
-    border: 0;
     margin: 12px 0 0;
     padding: 10px 0 0;
   }
@@ -100,19 +118,21 @@ a.absent {
 /* Lists, Blockquotes & Such */
 #template ul, 
 #template ol {
-  margin: 0;
-  padding: 20px 0 0;
-  list-style-position: inside;  
+  margin-top: 1.5em;
+  margin-left: 2.6em;
 }
 
   /* Nested Lists */
+  #template ul li, 
+  #template ol li, 
   #template ul li ul, 
   #template ol li ol,
   #template ul li ol,
   #template ol li ul,
   #template ul ul, 
   #template ol ol {
-    padding: 0 0 0 14px;
+    padding: 0;
+    margin: .5em 0;
   }
 
 #template dl {
@@ -266,7 +286,7 @@ a.absent {
   background-color: #f8f8f8;
   border: 1px solid #dedede;
   font-size: 13px;
-  padding: 1px 5px;
+  padding: 0;
 
   -moz-border-radius: 3px;
   -webkit-border-radius: 3px;
@@ -279,38 +299,83 @@ a.absent {
   font-size: 13px;
   line-height: 19px;
   overflow: auto;
-  padding: 6px;
+  padding: 6px 10px;
 
   -moz-border-radius: 3px;
   -webkit-border-radius: 3px;
   border-radius: 3px;
 }
 
+pre, code {
+  font: 12px 'Bitstream Vera Sans Mono','Courier',monospace
+}
+
 #template pre code, #template pre tt {
   background-color: transparent;
   border: none;
 }
 
-#template .highlight { background: #ffffff; }
-#template .highlight .c { color: #999988; font-style: italic }
-#template .highlight .err { color: #a61717; background-color: #e3d2d2 }
-#template .highlight .k { font-weight: bold }
-#template .highlight .o { font-weight: bold }
-#template .highlight .cm { color: #999988; font-style: italic }
-#template .highlight .cp { color: #999999; font-weight: bold }
-#template .highlight .c1 { color: #999988; font-style: italic }
-#template .highlight .cs { color: #999999; font-weight: bold; font-style: italic }
-#template .highlight .gd { color: #000000; background-color: #ffdddd }
-#template .highlight .gd .x { color: #000000; background-color: #ffaaaa }
-#template .highlight .ge { font-style: italic }
-#template .highlight .gr { color: #aa0000 }
-#template .highlight .gh { color: #999999 }
-#template .highlight .gi { color: #000000; background-color: #ddffdd }
-#template .highlight .gi .x { color: #000000; background-color: #aaffaa }
-#template .highlight .gc { color: #999; background-color: #EAF2F5 }
-#template .highlight .go { color: #888888 }
-#template .highlight .gp { color: #555555 }
-#template .highlight .gs { font-weight: bold }
-#template .highlight .gu { color: #aaaaaa }
-#template .highlight .gt { color: #aa0000 }
-
+/*
+  Highlight rules from pull req 191 
+  https://github.com/eboto/gollum/commit/5df09477abf4a04c82c7fcaa2bd7ee2a85e7ec82
+*/
+#template .highlight { background:#fff; }
+#template .highlight .c { color:#998;font-style:italic; }
+#template .highlight .err { color:#a61717;background-color:#e3d2d2; }
+#template .highlight .k { font-weight:bold; }
+#template .highlight .o { font-weight:bold; }
+#template .highlight .cm { color:#998;font-style:italic; }
+#template .highlight .cp { color:#999;font-weight:bold; }
+#template .highlight .c1 { color:#998;font-style:italic; }
+#template .highlight .cs { color:#999;font-weight:bold;font-style:italic; }
+#template .highlight .gd { color:#000;background-color:#fdd; }
+#template .highlight .gd .x { color:#000;background-color:#faa; }
+#template .highlight .ge { font-style:italic; }
+#template .highlight .gr { color:#a00; }
+#template .highlight .gh { color:#999; }
+#template .highlight .gi { color:#000;background-color:#dfd; }
+#template .highlight .gi .x { color:#000;background-color:#afa; }
+#template .highlight .go { color:#888; }
+#template .highlight .gp { color:#555; }
+#template .highlight .gs { font-weight:bold; }
+#template .highlight .gu { color:#800080;font-weight:bold; }
+#template .highlight .gt { color:#a00; }
+#template .highlight .kc { font-weight:bold; }
+#template .highlight .kd { font-weight:bold; }
+#template .highlight .kp { font-weight:bold; }
+#template .highlight .kr { font-weight:bold; }
+#template .highlight .kt { color:#458;font-weight:bold; }
+#template .highlight .m { color:#099; }
+#template .highlight .s { color:#d14; }
+#template .highlight .na { color:#008080; }
+#template .highlight .nb { color:#0086B3; }
+#template .highlight .nc { color:#458;font-weight:bold; }
+#template .highlight .no { color:#008080; }
+#template .highlight .ni { color:#800080; }
+#template .highlight .ne { color:#900;font-weight:bold; }
+#template .highlight .nf { color:#900;font-weight:bold; }
+#template .highlight .nn { color:#555; }
+#template .highlight .nt { color:#000080; }
+#template .highlight .nv { color:#008080; }
+#template .highlight .ow { font-weight:bold; }
+#template .highlight .w { color:#bbb; }
+#template .highlight .mf { color:#099; }
+#template .highlight .mh { color:#099; }
+#template .highlight .mi { color:#099; }
+#template .highlight .mo { color:#099; }
+#template .highlight .sb { color:#d14; }
+#template .highlight .sc { color:#d14; }
+#template .highlight .sd { color:#d14; }
+#template .highlight .s2 { color:#d14; }
+#template .highlight .se { color:#d14; }
+#template .highlight .sh { color:#d14; }
+#template .highlight .si { color:#d14; }
+#template .highlight .sx { color:#d14; }
+#template .highlight .sr { color:#009926; }
+#template .highlight .s1 { color:#d14; }
+#template .highlight .ss { color:#990073; }
+#template .highlight .bp { color:#999; }
+#template .highlight .vc { color:#008080; }
+#template .highlight .vg { color:#008080; }
+#template .highlight .vi { color:#008080; }
+#template .highlight .il { color:#099; }

data/lib/gollum/frontend/public/javascript/editor/gollum.editor.js

@@ -62,7 +62,7 @@
           // get form fields
           var oldAction = $('#gollum-editor form').attr('action');
           var $form = $($('#gollum-editor form').get(0));
-          $form.attr('action', '/preview');
+          $form.attr('action', this.href || '/preview');
           $form.attr('target', '_blank');
           $form.submit();
 
@@ -154,7 +154,13 @@
     define: function( name, definitionObject ) {
       LanguageDefinition._ACTIVE_LANG = name;
       LanguageDefinition._LOADED_LANGS.push( name );
-      LanguageDefinition._LANG[name] = definitionObject;
+      if ( typeof $.GollumEditor.WikiLanguage == 'object' ) {
+        var definition = {};
+        $.extend(definition, $.GollumEditor.WikiLanguage, definitionObject);
+        LanguageDefinition._LANG[name] = definition;
+      } else {
+        LanguageDefinition._LANG[name] = definitionObject;
+      }
     },
 
     getActiveLanguage: function() {
@@ -162,6 +168,9 @@
     },
 
     setActiveLanguage: function( name ) {
+      if(LanguageDefinition.getHookFunctionFor("deactivate")) {
+        LanguageDefinition.getHookFunctionFor("deactivate")();
+      }
       if ( !LanguageDefinition.isLoadedFor(name) ) {
         LanguageDefinition._ACTIVE_LANG = null;
         LanguageDefinition.loadFor( name, function(x, t) {
@@ -180,13 +189,33 @@
             FormatSelector.updateSelected();
           }
 
+          if(LanguageDefinition.getHookFunctionFor("activate")) {
+            LanguageDefinition.getHookFunctionFor("activate")();
+          }
         } );
       } else {
         LanguageDefinition._ACTIVE_LANG = name;
         FunctionBar.refresh();
+
+        if(LanguageDefinition.getHookFunctionFor("activate")) {
+          LanguageDefinition.getHookFunctionFor("activate")();
+        }
       }
     },
 
+    getHookFunctionFor: function(attr, specified_lang) {
+      if ( !specified_lang ) {
+        specified_lang = LanguageDefinition._ACTIVE_LANG;
+      }
+
+      if ( LanguageDefinition.isLoadedFor(specified_lang) &&
+           LanguageDefinition._LANG[specified_lang][attr] &&
+           typeof LanguageDefinition._LANG[specified_lang][attr] == 'function' ) {
+        return LanguageDefinition._LANG[specified_lang][attr];
+      }
+
+      return null;
+    },
 
     /**
      *  gets a definition object for a specified attribute
@@ -368,17 +397,6 @@
     },
 
 
-    /**
-     *  EditorHas.mathJax
-     *  True if the editor has MathJax enabled and running, false otherwise.
-     *
-     *  @return boolean
-     */
-    mathJax: function() {
-      return (typeof window.MathJax == 'object');
-    },
-
-
     /**
      *  EditorHas.previewButton
      *  True if the editor has a preview button, false otherwise.
@@ -776,226 +794,216 @@
   var Help = {
 
     _ACTIVE_HELP: '',
-   _LOADED_HELP_LANGS: [],
-   _HELP: {},
+    _LOADED_HELP_LANGS: [],
+    _HELP: {},
 
+    /**
+     *  Help.define
+     *
+     *  Defines a new help context and enables the help function if it
+     *  exists in the Gollum Function Bar.
+     *
+     *  @param string name   The name you're giving to this help context.
+     *                       Generally, this should match the language name.
+     *  @param object definitionObject The definition object being loaded from a
+     *                                 language / help definition file.
+     *  @return void
+     */
+    define: function( name, definitionObject ) {
+      if ( Help.isValidHelpFormat( definitionObject ) ) {
+        debug('help is a valid format');
 
-   /**
-    *  Help.define
-    *
-    *  Defines a new help context and enables the help function if it
-    *  exists in the Gollum Function Bar.
-    *
-    *  @param string name   The name you're giving to this help context.
-    *                       Generally, this should match the language name.
-    *  @param object definitionObject The definition object being loaded from a
-    *                                 language / help definition file.
-    *  @return void
-    */
-   define: function( name, definitionObject ) {
-     if ( Help.isValidHelpFormat( definitionObject ) ) {
-       debug('help is a valid format');
-
-       Help._ACTIVE_HELP_LANG = name;
-       Help._LOADED_HELP_LANGS.push( name );
-       Help._HELP[name] = definitionObject;
-
-       if ( $("#function-help").length ) {
-         if ( $('#function-help').hasClass('disabled') ) {
-           $('#function-help').removeClass('disabled');
-         }
-         $('#function-help').unbind('click');
-         $('#function-help').click( Help.evtHelpButtonClick );
-
-         // generate help menus
-         Help.generateHelpMenuFor( name );
-       }
-     } else {
-       if ( $('#function-help').length ) {
-         $('#function-help').addClass('disabled');
-       }
-     }
-   },
+        Help._ACTIVE_HELP_LANG = name;
+        Help._LOADED_HELP_LANGS.push( name );
+        Help._HELP[name] = definitionObject;
 
+        if ( $("#function-help").length ) {
+          if ( $('#function-help').hasClass('disabled') ) {
+            $('#function-help').removeClass('disabled');
+          }
+          $('#function-help').unbind('click');
+          $('#function-help').click( Help.evtHelpButtonClick );
 
-   /**
-    *  Help.generateHelpMenuFor
-    *  Generates the markup for the main help menu given a context name.
-    *
-    *  @param string  name  The context name.
-    *  @return void
-    */
-   generateHelpMenuFor: function( name ) {
-     if ( !Help._HELP[name] ) {
-       debug('Help is not defined for ' + name.toString());
-       return false;
-     }
-     var helpData = Help._HELP[name];
-
-     if ( EditorHas.mathJax() && Help.isLoadedFor('mathjax') ) {
-       debug('Adding MathJax support to help');
-       // TODO
-     }
-
-     // clear this shiz out
-     $('#gollum-editor-help-parent').html('');
-     $('#gollum-editor-help-list').html('');
-     $('#gollum-editor-help-content').html('');
-
-     // go go inefficient algorithm
-     for ( var i=0; i < helpData.length; i++ ) {
-       if ( typeof helpData[i] != 'object' ) {
-         break;
-       }
+          // generate help menus
+          Help.generateHelpMenuFor( name );
 
-       var $newLi = $('<li><a href="#" rel="' + i + '">' +
-                      helpData[i].menuName + '</a></li>');
-       $('#gollum-editor-help-parent').append( $newLi );
-       if ( i === 0 ) {
-         // select on first run
-         $newLi.children('a').addClass('selected');
-       }
-       $newLi.children('a').click( Help.evtParentMenuClick );
-     }
+          if ( $('#gollum-editor-help').length &&
+               typeof $('#gollum-editor-help').attr('data-autodisplay') !== 'undefined' &&
+               $('#gollum-editor-help').attr('data-autodisplay') === 'true' ) {
+            Help.show();
+          }
+        }
+      } else {
+        if ( $('#function-help').length ) {
+          $('#function-help').addClass('disabled');
+        }
+      }
+    },
 
-     // generate parent submenu on first run
-     Help.generateSubMenu( helpData[0], 0 );
-     $($('#gollum-editor-help-list li a').get(0)).click();
+    /**
+     *  Help.generateHelpMenuFor
+     *  Generates the markup for the main help menu given a context name.
+     *
+     *  @param string  name  The context name.
+     *  @return void
+     */
+    generateHelpMenuFor: function( name ) {
+      if ( !Help._HELP[name] ) {
+        debug('Help is not defined for ' + name.toString());
+        return false;
+      }
+      var helpData = Help._HELP[name];
 
-   },
+      // clear this shiz out
+      $('#gollum-editor-help-parent').html('');
+      $('#gollum-editor-help-list').html('');
+      $('#gollum-editor-help-content').html('');
 
+      // go go inefficient algorithm
+      for ( var i=0; i < helpData.length; i++ ) {
+        if ( typeof helpData[i] != 'object' ) {
+          break;
+        }
 
-   /**
-    *  Help.generateSubMenu
-    *  Generates the markup for the inline help sub-menu given the data
-    *  object for the submenu and the array index to start at.
-    *
-    *  @param object subData The data for the sub-menu.
-    *  @param integer index  The index clicked on (parent menu index).
-    *  @return void
-    */
-   generateSubMenu: function( subData, index ) {
-     $('#gollum-editor-help-list').html('');
-     $('#gollum-editor-help-content').html('');
-     for ( var i=0; i < subData.content.length; i++ ) {
-       if ( typeof subData.content[i] != 'object' ) {
-         break;
-       }
+        var $newLi = $('<li><a href="#" rel="' + i + '">' +
+                       helpData[i].menuName + '</a></li>');
+        $('#gollum-editor-help-parent').append( $newLi );
+        if ( i === 0 ) {
+          // select on first run
+          $newLi.children('a').addClass('selected');
+        }
+        $newLi.children('a').click( Help.evtParentMenuClick );
+      }
 
-       var $subLi = $('<li><a href="#" rel="' + index + ':' + i + '">' +
-                      subData.content[i].menuName + '</a></li>');
-
-
-       $('#gollum-editor-help-list').append( $subLi );
-       $subLi.children('a').click( Help.evtSubMenuClick );
-     }
-   },
-
-
-   hide: function() {
-     if ( $.browser.msie ) {
-       $('#gollum-editor-help').css('display', 'none');
-     } else {
-       $('#gollum-editor-help').animate({
-                                          opacity: 0
-                                         }, 200,
-                                        function() {
-                                          $('#gollum-editor-help')
-                                            .animate({ height: 'hide' }, 200);
-                                        });
-     }
-   },
-
-   show: function() {
-     if ( $.browser.msie ) {
-       // bypass effects for internet explorer, since it does weird crap
-       // to text antialiasing with opacity animations
-       $('#gollum-editor-help').css('display', 'block');
-     } else {
-       $('#gollum-editor-help').animate({
-                                    height: 'show'
-                                   }, 200,
-                                  function() {
-                                    $('#gollum-editor-help')
-                                      .animate({ opacity: 1 }, 300);
-                                  });
-     }
-   },
+      // generate parent submenu on first run
+      Help.generateSubMenu( helpData[0], 0 );
+      $($('#gollum-editor-help-list li a').get(0)).click();
 
+    },
 
-   /**
-    *  Help.showHelpFor
-    *  Displays the actual help content given the two menu indexes, which are
-    *  rendered in the rel="" attributes of the help menus
-    *
-    *  @param integer index1  parent index
-    *  @param integer index2  submenu index
-    *  @return void
-    */
-   showHelpFor: function( index1, index2 ) {
-     var html =
-       Help._HELP[Help._ACTIVE_HELP_LANG][index1].content[index2].data;
-     $('#gollum-editor-help-content').html(html);
-   },
+    /**
+     *  Help.generateSubMenu
+     *  Generates the markup for the inline help sub-menu given the data
+     *  object for the submenu and the array index to start at.
+     *
+     *  @param object subData The data for the sub-menu.
+     *  @param integer index  The index clicked on (parent menu index).
+     *  @return void
+     */
+    generateSubMenu: function( subData, index ) {
+      $('#gollum-editor-help-list').html('');
+      $('#gollum-editor-help-content').html('');
+      for ( var i=0; i < subData.content.length; i++ ) {
+        if ( typeof subData.content[i] != 'object' ) {
+          break;
+        }
 
+        var $subLi = $('<li><a href="#" rel="' + index + ':' + i + '">' +
+                       subData.content[i].menuName + '</a></li>');
 
-   /**
-    *  Help.isLoadedFor
-    *  Returns true if help is loaded for a specific markup language,
-    *  false otherwise.
-    *
-    *  @param string name   The name of the markup language.
-    *  @return boolean
-    */
-   isLoadedFor: function( name ) {
-     for ( var i=0; i < Help._LOADED_HELP_LANGS.length; i++ ) {
-       if ( name == Help._LOADED_HELP_LANGS[i] ) {
-         return true;
-       }
-     }
-     return false;
-   },
 
+        $('#gollum-editor-help-list').append( $subLi );
+        $subLi.children('a').click( Help.evtSubMenuClick );
+      }
+    },
 
-   isShown: function() {
-     return ( $('#gollum-editor-help').is(':visible') );
-   },
+    hide: function() {
+      if ( $.browser.msie ) {
+        $('#gollum-editor-help').css('display', 'none');
+      } else {
+        $('#gollum-editor-help').animate({
+          opacity: 0
+        }, 200, function() {
+          $('#gollum-editor-help')
+            .animate({ height: 'hide' }, 200);
+        });
+      }
+    },
 
+    show: function() {
+      if ( $.browser.msie ) {
+        // bypass effects for internet explorer, since it does weird crap
+        // to text antialiasing with opacity animations
+        $('#gollum-editor-help').css('display', 'block');
+      } else {
+        $('#gollum-editor-help').animate({
+          height: 'show'
+        }, 200, function() {
+          $('#gollum-editor-help')
+            .animate({ opacity: 1 }, 300);
+        });
+      }
+    },
 
-   /**
-    *  Help.isValidHelpFormat
-    *  Does a quick check to make sure that the help definition isn't in a
-    *  completely messed-up format.
-    *
-    *  @param object (Array) helpArr  The help definition array.
-    *  @return boolean
-    */
-   isValidHelpFormat: function( helpArr ) {
-     return ( typeof helpArr == 'object' &&
-              helpArr.length &&
-              typeof helpArr[0].menuName == 'string' &&
-              typeof helpArr[0].content == 'object' &&
-              helpArr[0].content.length );
-   },
+    /**
+     *  Help.showHelpFor
+     *  Displays the actual help content given the two menu indexes, which are
+     *  rendered in the rel="" attributes of the help menus
+     *
+     *  @param integer index1  parent index
+     *  @param integer index2  submenu index
+     *  @return void
+     */
+    showHelpFor: function( index1, index2 ) {
+      var html =
+        Help._HELP[Help._ACTIVE_HELP_LANG][index1].content[index2].data;
+      $('#gollum-editor-help-content').html(html);
+    },
 
+    /**
+     *  Help.isLoadedFor
+     *  Returns true if help is loaded for a specific markup language,
+     *  false otherwise.
+     *
+     *  @param string name   The name of the markup language.
+     *  @return boolean
+     */
+    isLoadedFor: function( name ) {
+      for ( var i=0; i < Help._LOADED_HELP_LANGS.length; i++ ) {
+        if ( name == Help._LOADED_HELP_LANGS[i] ) {
+          return true;
+        }
+      }
+      return false;
+    },
 
-   /**
-    *  Help.setActiveHelp
-    *  Sets the active help definition to the one defined in the argument,
-    *  re-rendering the help menu to match the new definition.
-    *
-    *  @param string  name  The name of the help definition.
-    *  @return void
-    */
-   setActiveHelp: function( name ) {
-     if ( !Help.isLoadedFor( name ) ) {
-       if ( $('#function-help').length ) {
-         $('#function-help').addClass('disabled'); 
-       }
-       if ( Help.isShown() ) {
-         Help.hide();
-       }
-     } else {
+    isShown: function() {
+      return ($('#gollum-editor-help').is(':visible'));
+    },
+
+    /**
+     *  Help.isValidHelpFormat
+     *  Does a quick check to make sure that the help definition isn't in a
+     *  completely messed-up format.
+     *
+     *  @param object (Array) helpArr  The help definition array.
+     *  @return boolean
+     */
+    isValidHelpFormat: function( helpArr ) {
+      return ( typeof helpArr == 'object' &&
+               helpArr.length &&
+               typeof helpArr[0].menuName == 'string' &&
+               typeof helpArr[0].content == 'object' &&
+               helpArr[0].content.length );
+    },
+
+    /**
+     *  Help.setActiveHelp
+     *  Sets the active help definition to the one defined in the argument,
+     *  re-rendering the help menu to match the new definition.
+     *
+     *  @param string  name  The name of the help definition.
+     *  @return void
+     */
+    setActiveHelp: function( name ) {
+      if ( !Help.isLoadedFor( name ) ) {
+        if ( $('#function-help').length ) {
+          $('#function-help').addClass('disabled');
+        }
+        if ( Help.isShown() ) {
+          Help.hide();
+        }
+      } else {
         Help._ACTIVE_HELP_LANG = name;
         if ( $("#function-help").length ) {
           if ( $('#function-help').hasClass('disabled') ) {
@@ -1005,80 +1013,84 @@
           $('#function-help').click( Help.evtHelpButtonClick );
           Help.generateHelpMenuFor( name );
         }
-     }
-   },
-
-
-   /**
-    *  Help.evtHelpButtonClick
-    *  Event handler for clicking the help button in the function bar.
-    *
-    *  @param jQuery.Event e  The jQuery event object.
-    *  @return void
-    */
-   evtHelpButtonClick: function( e ) {
-     e.preventDefault();
-     if ( Help.isShown() ) { Help.hide(); }
-     else { Help.show(); }
-   },
-
+      }
+    },
 
-   /**
-    *  Help.evtParentMenuClick
-    *  Event handler for clicking on an item in the parent menu. Automatically
-    *  renders the submenu for the parent menu as well as the first result for
-    *  the actual plain text.
-    *
-    *  @param jQuery.Event e  The jQuery event object.
-    *  @return void
-    */
-   evtParentMenuClick: function( e ) {
-     e.preventDefault();
-     // short circuit if we've selected this already
-     if ( $(this).hasClass('selected') ) { return; }
+    /**
+     *  Help.evtHelpButtonClick
+     *  Event handler for clicking the help button in the function bar.
+     *
+     *  @param jQuery.Event e  The jQuery event object.
+     *  @return void
+     */
+    evtHelpButtonClick: function( e ) {
+      e.preventDefault();
+      if ( Help.isShown() ) {
+        // turn off autodisplay if it's on
+        if ( $('#gollum-editor-help').length &&
+             $('#gollum-editor-help').attr('data-autodisplay') !== 'undefined' &&
+             $('#gollum-editor-help').attr('data-autodisplay') === 'true' ) {
+          $.post('/wiki/help?_method=delete');
+          $('#gollum-editor-help').attr('data-autodisplay', '');
+        }
+        Help.hide(); }
+      else { Help.show(); }
+    },
 
-     // populate from help data for this
-     var helpIndex = $(this).attr('rel');
-     var subData = Help._HELP[Help._ACTIVE_HELP_LANG][helpIndex];
+    /**
+     *  Help.evtParentMenuClick
+     *  Event handler for clicking on an item in the parent menu. Automatically
+     *  renders the submenu for the parent menu as well as the first result for
+     *  the actual plain text.
+     *
+     *  @param jQuery.Event e  The jQuery event object.
+     *  @return void
+     */
+    evtParentMenuClick: function( e ) {
+      e.preventDefault();
+      // short circuit if we've selected this already
+      if ( $(this).hasClass('selected') ) { return; }
+
+      // populate from help data for this
+      var helpIndex = $(this).attr('rel');
+      var subData = Help._HELP[Help._ACTIVE_HELP_LANG][helpIndex];
+
+      $('#gollum-editor-help-parent li a').removeClass('selected');
+      $(this).addClass('selected');
+      Help.generateSubMenu( subData, helpIndex );
+      $($('#gollum-editor-help-list li a').get(0)).click();
+    },
 
-     $('#gollum-editor-help-parent li a').removeClass('selected');
-     $(this).addClass('selected');
-     Help.generateSubMenu( subData, helpIndex );
-     $($('#gollum-editor-help-list li a').get(0)).click();
-   },
+    /**
+     *  Help.evtSubMenuClick
+     *  Event handler for clicking an item in a help submenu. Renders the
+     *  appropriate text for the submenu link.
+     *
+     *  @param jQuery.Event e  The jQuery event object.
+     *  @return void
+     */
+    evtSubMenuClick: function( e ) {
+      e.preventDefault();
+      if ( $(this).hasClass('selected') ) { return; }
+
+      // split index rel data
+      var rawIndex = $(this).attr('rel').split(':');
+      $('#gollum-editor-help-list li a').removeClass('selected');
+      $(this).addClass('selected');
+      Help.showHelpFor( rawIndex[0], rawIndex[1] );
+    }
+  };
 
+  // Publicly-accessible function to Help.define
+  $.GollumEditor.defineHelp = Help.define;
 
-   /**
-    *  Help.evtSubMenuClick
-    *  Event handler for clicking an item in a help submenu. Renders the
-    *  appropriate text for the submenu link.
-    *
-    *  @param jQuery.Event e  The jQuery event object.
-    *  @return void
-    */
-   evtSubMenuClick: function( e ) {
-     e.preventDefault();
-     if ( $(this).hasClass('selected') ) { return; }
-
-     // split index rel data
-     var rawIndex = $(this).attr('rel').split(':');
-     $('#gollum-editor-help-list li a').removeClass('selected');
-     $(this).addClass('selected');
-     Help.showHelpFor( rawIndex[0], rawIndex[1] );
-   }
- };
-
-
-   // Publicly-accessible function to Help.define
-   $.GollumEditor.defineHelp = Help.define;
-
-   // Dialog exists as its own thing now
-   $.GollumEditor.Dialog = $.GollumDialog;
-   $.GollumEditor.replaceSelection = function( repText ) {
-     FunctionBar.replaceFieldSelection( $('#gollum-editor-body'), repText );
-   };
+  // Dialog exists as its own thing now
+  $.GollumEditor.Dialog = $.GollumDialog;
+  $.GollumEditor.replaceSelection = function( repText ) {
+    FunctionBar.replaceFieldSelection( $('#gollum-editor-body'), repText );
+  };
 
-   // Placeholder exists as its own thing now
-   $.GollumEditor.Placeholder = $.GollumPlaceholder;
+  // Placeholder exists as its own thing now
+  $.GollumEditor.Placeholder = $.GollumPlaceholder;
 
 })(jQuery);