gollum 2.3.12 → 2.4.0

data/README.md

@@ -136,7 +136,13 @@ or JavaScript. These tags will be stripped from the converted HTML. See
 `docs/sanitization.md` for more details on what tags and attributes are
 allowed.
 
+## TITLES
 
+The first defined `h1` will override the default header on a page. There are two ways to set a page title. The metadata syntax:
+
+`<!-- --- title: New Title -->`
+
+The first `h1` tag can be set to always override the page title, without needing to use the metadata syntax. Start gollum with the `--h1-title` flag.
 ## BRACKET TAGS
 
 A variety of Gollum tags use a double bracket syntax. For example:
@@ -538,7 +544,7 @@ Gollum optionally takes a `--config file`. See [config.rb](https://github.com/gi
 
 ## CUSTOM CSS
 
-The `--css` flag will inject `custom.css` from the root of your git repository into each page. Here's an example of floating the sidebar to the left.
+The `--css` flag will inject `custom.css` from the root of your git repository into each page. `custom.css` must be commited to git or you will get a 302 redirect to the create page. Here's an example of floating the sidebar to the left.
 
 ```css
 #wiki-rightbar { float: left !important; }

data/Rakefile

@@ -146,7 +146,7 @@ task :gemspec => :validate do
     split("\n").
     sort.
     reject { |file| file =~ /^\./ }.
-    reject { |file| file =~ /^(rdoc|pkg|test|Home\.md)/ }.
+    reject { |file| file =~ /^(rdoc|pkg|test|Home\.md|\.gitattributes)/ }.
     map { |file| "    #{file}" }.
     join("\n")
 

data/bin/gollum

@@ -80,6 +80,9 @@ opts = OptionParser.new do |opts|
   opts.on("--collapse-tree", "Collapse file view tree. By default, expanded tree is shown.") do
     wiki_options[:collapse_tree] = true
   end
+  opts.on("--h1-title", "Sets page title to value of first h1") do
+    wiki_options[:h1_title] = true
+  end
 end
 
 # Read command line options into `options` hash

data/gollum.gemspec

@@ -5,8 +5,8 @@ Gem::Specification.new do |s|
   s.required_ruby_version = ">= 1.8.7"
 
   s.name              = 'gollum'
-  s.version           = '2.3.12'
-  s.date              = '2012-11-07'
+  s.version           = '2.4.0'
+  s.date              = '2012-11-11'
   s.rubyforge_project = 'gollum'
 
   s.summary     = "A simple, Git-powered wiki."

data/lib/gollum.rb

@@ -23,7 +23,7 @@ require File.expand_path('../gollum/web_sequence_diagram', __FILE__)
 require File.expand_path('../gollum/frontend/uri_encode_component', __FILE__)
 
 module Gollum
-  VERSION = '2.3.12'
+  VERSION = '2.4.0'
 
   def self.assets_path
     ::File.expand_path('gollum/frontend/public', ::File.dirname(__FILE__))

data/lib/gollum/file_view.rb

@@ -22,7 +22,7 @@ module Gollum
     def new_page page
       name = page.name
       url  = url_for_page page
-      %Q(  <li class="file"><a href="#{url}">#{name}</a></li>\n)
+      %Q(  <li class="file"><a href="#{url}"><span class="icon"></span>#{name}</a></li>)
     end
 
     def new_folder folder_path
@@ -38,10 +38,7 @@ module Gollum
     end
 
     def end_folder
-      <<-HTML
-        </ol>
-      </li>
-      HTML
+      "</ol></li>\n"
     end
 
     def url_for_page page
@@ -85,13 +82,11 @@ module Gollum
       # Handle special case of only one folder.
       if (count - folder_start == 1)
         page = @pages[ folder_start ]
-        name = page.name
-        url  = url_for_page page
         html += <<-HTML
         <li>
           <label>#{::File.dirname(page.path)}</label> <input type="checkbox" #{@checked} />
           <ol>
-            <li class="file"><a href="#{url}">#{name}</a></li>
+          #{new_page page}
          </ol>
         </li>
         HTML

data/lib/gollum/frontend/app.rb

@@ -239,6 +239,7 @@ module Precious
       @toc_content = wiki.universal_toc ? @page.toc_data : nil
       @mathjax = wiki.mathjax
       @css = wiki.css
+      @h1_title = wiki.h1_title
       @editable = false
       mustache :page
     end
@@ -362,6 +363,7 @@ module Precious
         @toc_content = wiki.universal_toc ? @page.toc_data : nil
         @mathjax = wiki.mathjax
         @css = wiki.css
+        @h1_title = wiki.h1_title
         mustache :page
       elsif file = wiki.file(fullpath)
         content_type file.mime_type

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

@@ -1,121 +1,128 @@
-*, html {
-  font-family: Verdana, Arial, Helvetica, sans-serif;
-}
-
-#results a:hover {
-  background-color: #4c4c4c;
-}
-
-#home_button {
-  position: absolute;
-  top: 10px;
-  left: 50%;
-}
-
-#home_button .minibutton {
-  font-size: 1em;
-  text-align: center;
-}
-
-#results {
-  position: absolute;
-  top: 60px;
-  left: 10px;
-}
-
-body, form, ul, li, p, h1, h2, h3, h4, h5 {
-  margin: 0;
-  padding: 0;
-}
-
-body {
-  background-color: #606061;
-  color: #ffffff;
-  margin: 0;
-}
-
-img {
-  border: none;
-}
-
-p {
-  font-size: 1em;
-  margin: 0 0 1em 0;
-}
-
-html { font-size: 100%; /* IE hack */ }
-body { font-size: 1em; /* Sets base font size to 16px */ }
-table { font-size: 100%; /* IE hack */ }
-input, select, textarea, th, td { font-size: 1em; }
-
-/* Prevent wrapping on large file names. */
-li.file {
-  white-space: nowrap;
-}
-
-/* CSS Tree menu styles */
-ol.tree
-{
-  padding: 0 0 0 30px;
-  width: 300px;
-}
-  li
-  {
-    position: relative;
-    margin-left: -15px;
-    list-style: none;
-  }
-  li.file
-  {
-    margin-left: -1px !important;
-    height: 1.5em;
-  }
-    li.file a
-    {
-      background: url(../images/fileview/document.png) 0 0 no-repeat;
-      color: #fff;
-      padding-left: 21px;
-      text-decoration: none;
-      display: block;
-    }
-    li.file a[href *= '.pdf']  { background: url(../images/fileview/document.png) 0 0 no-repeat; }
-    li.file a[href *= '.html']  { background: url(../images/fileview/document.png) 0 0 no-repeat; }
-    li.file a[href $= '.css']  { background: url(../images/fileview/document.png) 0 0 no-repeat; }
-    li.file a[href $= '.js']    { background: url(../images/fileview/document.png) 0 0 no-repeat; }
-  li input
-  {
-    position: absolute;
-    left: 0;
-    margin-left: 0;
-    opacity: 0;
-    z-index: 2;
-    cursor: pointer;
-    height: 1em;
-    width: 1em;
-    top: 0;
-  }
-    li input + ol
-    {
-      background: url(../images/fileview/toggle-small-expand.png) 40px 0 no-repeat;
-      margin: -1.188em 0 0 -44px; /* 15px */
-      height: 1.5em;
-    }
-    li input + ol > li { display: none; margin-left: -14px !important; padding-left: 1px; }
-  li label
-  {
-    background: url(../images/fileview/folder-horizontal.png) 15px 1px no-repeat;
-    cursor: pointer;
-    display: block;
-    padding-left: 37px;
-  }
-
-  li input:checked + ol
-  {
-    background: url(../images/fileview/toggle-small.png) 40px 5px no-repeat;
-    margin: -1.5em 0 0 -44px; /* 20px */
-    padding: 1.563em 0 0 80px;
-    height: auto;
-  }
-    li input:checked + ol > li { display: block; margin: 0 0 0.125em;  /* 2px */}
-    li input:checked + ol > li:last-child { margin: 0 0 0.063em; /* 1px */ }
-
+*, html {
+  font-family: Verdana, Arial, Helvetica, sans-serif;
+}
+
+#results a:hover {
+  background-color: #4c4c4c;
+}
+
+#home_button {
+  position: absolute;
+  top: 10px;
+  left: 50%;
+}
+
+#home_button .minibutton {
+  font-size: 1em;
+  text-align: center;
+}
+
+#results {
+  position: absolute;
+  top: 60px;
+  left: 10px;
+}
+
+body, form, ul, li, p, h1, h2, h3, h4, h5 {
+  margin: 0;
+  padding: 0;
+}
+
+body {
+  background-color: #606061;
+  color: #ffffff;
+  margin: 0;
+}
+
+img {
+  border: none;
+}
+
+p {
+  font-size: 1em;
+  margin: 0 0 1em 0;
+}
+
+html { font-size: 100%; /* IE hack */ }
+body { font-size: 1em; /* Sets base font size to 16px */ }
+table { font-size: 100%; /* IE hack */ }
+input, select, textarea, th, td { font-size: 1em; }
+
+/* Prevent wrapping on large file names. */
+li.file {
+  white-space: nowrap;
+}
+
+/* CSS Tree menu styles */
+ol.tree
+{
+  padding: 0 0 0 30px;
+  width: 300px;
+}
+  li
+  {
+    position: relative;
+    margin-left: -15px;
+    list-style: none;
+  }
+  li.file
+  {
+    margin-left: -1px !important;
+    height: 1.5em;
+  }
+    li.file a
+    {
+      color: #fff;
+      text-decoration: none;
+      display: inline-block;
+    }
+      li.file a span.icon
+      {
+        width: 14px;
+        height: 18px;
+        background: url(../images/fileview/document.png) 0 0 no-repeat;
+        display: inline-block;
+        margin-right: 7px;
+        vertical-align: text-top;
+      }
+      li.file a[href *= '.pdf'] span.icon { background: url(../images/fileview/document.png) 0 0 no-repeat; }
+      li.file a[href *= '.html'] span.icon { background: url(../images/fileview/document.png) 0 0 no-repeat; }
+      li.file a[href $= '.css'] span.icon { background: url(../images/fileview/document.png) 0 0 no-repeat; }
+      li.file a[href $= '.js']  span.icon { background: url(../images/fileview/document.png) 0 0 no-repeat; }
+  li input
+  {
+    position: absolute;
+    left: 0;
+    margin-left: 0;
+    opacity: 0;
+    z-index: 2;
+    cursor: pointer;
+    height: 1em;
+    width: 1em;
+    top: 0;
+  }
+    li input + ol
+    {
+      background: url(../images/fileview/toggle-small-expand.png) 40px 0 no-repeat;
+      margin: -1.188em 0 0 -44px; /* 15px */
+      height: 1.5em;
+    }
+    li input + ol > li { display: none; margin-left: -14px !important; padding-left: 1px; }
+  li label
+  {
+    background: url(../images/fileview/folder-horizontal.png) 15px 1px no-repeat;
+    cursor: pointer;
+    display: block;
+    padding-left: 37px;
+  }
+
+  li input:checked + ol
+  {
+    background: url(../images/fileview/toggle-small.png) 40px 5px no-repeat;
+    margin: -1.5em 0 0 -44px; /* 20px */
+    padding: 1.563em 0 0 80px;
+    height: auto;
+  }
+    li input:checked + ol > li { display: block; margin: 0 0 0.125em;  /* 2px */}
+    li input:checked + ol > li:last-child { margin: 0 0 0.063em; /* 1px */ }
+

data/lib/gollum/frontend/templates/page.mustache

@@ -7,7 +7,7 @@ Mousetrap.bind(['e'], function( e ) {
 </script>
 <div id="wiki-wrapper" class="page">
 <div id="head">
-  <h1>{{title}}</h1>
+  <h1>{{page_header}}</h1>
   <ul class="actions">
     <li class="minibutton">
       {{>searchbar}}

data/lib/gollum/frontend/views/page.rb

@@ -8,7 +8,16 @@ module Precious
       DEFAULT_AUTHOR = 'you'
 
       def title
-        @page.url_path.gsub("-", " ")
+        h1 = @h1_title ? page_header_from_content(@content) : false
+        h1 || @page.url_path_title
+      end
+
+      def page_header
+        page_header_from_content(@content) || title
+      end
+
+      def content
+        content_without_page_header(@content)
       end
 
       def author
@@ -94,6 +103,48 @@ module Precious
       def metadata
         @page.metadata
       end
+
+      private
+
+      # Wraps page formatted data to Nokogiri::HTML document.
+      #
+      def build_document(content)
+        Nokogiri::HTML(%{<div id="gollum-root">} + content + %{</div>})
+      end
+
+      # Finds header node inside Nokogiri::HTML document.
+      #
+      def find_header_node(doc)
+        case self.format
+          when :asciidoc
+            doc.css("div#gollum-root > div#header > h1:first-child")
+          when :org
+            doc.css("div#gollum-root > p.title:first-child")
+          when :pod
+            doc.css("div#gollum-root > a.dummyTopAnchor:first-child + h1")
+          when :rest
+            doc.css("div#gollum-root > div > div > h1:first-child")
+          else
+            doc.css("div#gollum-root > h1:first-child")
+        end
+      end
+
+      # Extracts title from page if present.
+      #
+      def page_header_from_content(content)
+        doc = build_document(content)
+        title = find_header_node(doc)
+        Sanitize.clean(title.to_html).strip unless title.empty?
+      end
+
+      # Returns page content without title if it was extracted.
+      #
+      def content_without_page_header(content)
+        doc = build_document(content)
+        title = find_header_node(doc)
+        title.remove unless title.empty?
+        doc.css("div#gollum-root").inner_html
+      end
     end
   end
 end

data/lib/gollum/page.rb

@@ -168,6 +168,27 @@ module Gollum
       path
     end
 
+    # Public: Defines title for page.rb
+    #
+    # Returns the String title
+    def url_path_title
+      metadata_title || url_path.gsub("-", " ")
+    end
+
+    # Public: Metadata title
+    #
+    # Set with <!-- --- title: New Title --> in page content
+    #
+    # Returns the String title or nil if not defined
+    def metadata_title
+      if metadata
+        title = metadata['title']
+        return title unless title.nil?
+      end
+
+      nil
+    end
+
     # Public: The url_path, but CGI escaped.
     #
     # Returns the String url_path
@@ -221,7 +242,7 @@ module Gollum
     # Public: Embedded metadata.
     #
     # Returns Hash of metadata.
-    def meta_data()
+    def metadata()
       formatted_data if markup_class.metadata == nil
       markup_class.metadata
     end

data/lib/gollum/wiki.rb

@@ -141,6 +141,10 @@ module Gollum
     # Defaults to false
     attr_reader :css
 
+    # Sets page title to value of first h1
+    # Defaults to false
+    attr_reader :h1_title
+
     # Public: Initialize a new Gollum Repo.
     #
     # path    - The String path to the Git repository that holds the Gollum
@@ -196,6 +200,7 @@ module Gollum
       @show_all             = options.fetch :show_all, false
       @collapse_tree        = options.fetch :collapse_tree, false
       @css                  = options.fetch :css, false
+      @h1_title             = options.fetch :h1_title, false
     end
 
     # Public: check whether the wiki's git repo exists on the filesystem.

data/licenses/licenses.txt

@@ -1,3 +1,12 @@
+For gollum code, everything should fall under the existing MIT License.
+Alternative permissive licenses (such as BSD) for 3rd party dependencies are
+acceptable. For image assets in Gollum, CC BY or CC BY-SA is fine. Anything
+released under a copyleft license (for example GPL, AGPL, LGPL, MPL, EPL,
+etc.) is not permitted in gollum. Public domain, CC BY or CC BY-SA for code in
+gollum is not permitted.
+
+---
+
 The following PNGs are based on Ubuntu 11.10 SVG files located in /usr/share/icons/unity-icon-theme/places/svg/
 - group-folders.svg
 - group-files.svg

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gollum
 version: !ruby/object:Gem::Version
-  version: 2.3.12
+  version: 2.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-07 00:00:00.000000000 Z
+date: 2012-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grit