From 8e89ec504f804f805452a9e006db962f44a260b0 Mon Sep 17 00:00:00 2001 From: Arran Cudbard-Bell Date: Fri, 3 Jun 2011 23:21:59 -0700 Subject: [PATCH 01/30] Initial commit of Nokogiri based TOC generator --- lib/extensions/toc.rb | 132 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 132 insertions(+) create mode 100644 lib/extensions/toc.rb diff --git a/lib/extensions/toc.rb b/lib/extensions/toc.rb new file mode 100644 index 00000000..ab1889f3 --- /dev/null +++ b/lib/extensions/toc.rb @@ -0,0 +1,132 @@ +module Gollum::Extensions + class Toc_gen + attr_accessor :header_tags + + NODE_CONTENT = 0 + NODE_ORDER = 1 + + def initialize (doc, settings = {}) + @doc = doc + @header_tags = ['title','h1','h2','h3','h4','h5','h6'] + end + + # Generates a table of contents for @doc using headers + # + # Returns Nokogiri::XML::Node if there were headers to parse, or nil if none were found + def generate + return unless (headings = find_headings).count > 0 + + node_count = 0 + lvl = 0 + @lvls = [].fill(0..@header_tags.count) {[]} + + headings.each do |h| + node_count += 1 + lvl_new = heading_to_lvl h + + @lvls[lvl_new].push [build_toc_node(h), node_count] + + # Pass in the highest level prior to flattening for efficiency + flatten_to_lvl(lvl, lvl_new) if lvl_new < lvl + + lvl = lvl_new + end + + flatten_to_lvl(lvl, 0) + end + + # Escape title string for use in ID attribute + # + # title - Title string + # + # Returns string + def insert_anchors + find_headings.each do |h| + rep_h = Nokogiri::XML::Node.new('a', @doc) + rep_h['name'] = anchor_id(h.content) + rep_h.add_child(h.clone) + h.replace(rep_h) + end + end + + # Escape title string for use in ID attribute + # + # title - Title string + # + # Returns string + def anchor_id (title) + CGI::escape(title) + end + + # Convert heading into list element + # + # heading - Nokogiri::XML::Node representing a single heading + # + # Returns string + def build_toc_node(heading) + xml_node = Nokogiri::XML::Node.new('li', @doc) + xml_node.add_child("" + heading.content + "") + xml_node + end + + # Search the current @doc for headings + # + # Returns Nokogiri::XML::NodeSet + def find_headings + @doc.css(@header_tags.join ' ,') + end + + # Convert specified heading to integer level + # + # heading - Nokogiri::XML::Node representing a single heading + # + # Returns int + def heading_to_lvl(heading) + heading.name.gsub('h','').to_i + end + + # Convert Nokogiri::XML:Nodes higher in the level array than the specified low_idx + # into a node tree, and either append or prepend the tree to the level specified + # by low_idx. + # + # low_idx - The level in the array to flatten to + # high - The highest level to flatten from + # + # Returns Nokogiri::XML::Nodes if low_idx is 0, else nil + def flatten_to_lvl(high_idx, low_idx = 0) + lvl = high_idx + 1 + lvl_up = nil + + @lvls[low_idx..high_idx].reverse_each do |lvl_children| + lvl -= 1 + next if lvl_children.count() == 0 || !lvl_up && (lvl_up = lvl) + + flatten_lvl(lvl_up,lvl) + lvl_up = lvl + end + + # Level 0 flattens all levels, and returns an XML node containing the TOC data + flatten_lvl(lvl_up, 0).first[NODE_CONTENT] if lvl == 0 && lvl_up + end + + # Insert all Nokogiri::XML::Nodes at lvl_src into a new ul XML::Node as children. + # Then either append or prepend the ul node, depending on whether the first child + # at the src_level appeared before or after the node in the dst_level in @doc + # + # lvl_src - The level in the array to src li XML::Nodes from + # lvl_dst - The level in the array to insert resulting ul XML::Node + # + # Returns array of Nokogiri::XML::Nodes @ lvl_dst + def flatten_lvl(lvl_src, lvl_dst) + lvl_sib = Nokogiri::XML::Node.new('ul', @doc) + src_pos = @lvls[lvl_src].first[NODE_ORDER] + @lvls[lvl_src].each {|lvl_child| lvl_sib.add_child(lvl_child[NODE_CONTENT])} + @lvls[lvl_src] = [] + + lvl_dst > 0 && src_pos < @lvls[lvl_dst].last[NODE_ORDER] ? + @lvls[lvl_dst].insert(-2,[lvl_sib, src_pos]) : + @lvls[lvl_dst].push([lvl_sib, src_pos]) + @lvls[lvl_dst] + end + end +end \ No newline at end of file From 38c943d56479732de3dccdc97235b856673db7c9 Mon Sep 17 00:00:00 2001 From: Arran Cudbard-Bell Date: Fri, 3 Jun 2011 23:23:43 -0700 Subject: [PATCH 02/30] Add supporting modifications to frontend and css --- lib/gollum/frontend/app.rb | 32 +++++++++++++--- .../frontend/public/gollum/css/gollum.css | 38 +++++++++++++++++++ lib/gollum/frontend/templates/page.mustache | 22 +++++++---- lib/gollum/frontend/views/page.rb | 6 +++ 4 files changed, 85 insertions(+), 13 deletions(-) diff --git a/lib/gollum/frontend/app.rb b/lib/gollum/frontend/app.rb index 94352f49..84c6c515 100644 --- a/lib/gollum/frontend/app.rb +++ b/lib/gollum/frontend/app.rb @@ -6,6 +6,8 @@ require 'mustache/sinatra' require 'gollum/frontend/views/layout' require 'gollum/frontend/views/editable' +require 'extensions/toc' + module Precious class App < Sinatra::Base register Mustache::Sinatra @@ -108,10 +110,20 @@ module Precious end post '/preview' do - wiki = Gollum::Wiki.new(settings.gollum_path, settings.wiki_options) - @name = "Preview" - @page = wiki.preview_page(@name, params[:content], params[:format]) - @content = @page.formatted_data + wiki = Gollum::Wiki.new(settings.gollum_path, settings.wiki_options) + @name = "Preview" + @page = wiki.preview_page(@name, params[:content], params[:format]) + @content = @page.formatted_data do + |doc| + # Insert anchors for table of contents + toc = Gollum::Extensions::Toc_gen.new doc + if (toc_content = toc.generate) + toc.insert_anchors + @toc_content = toc_content.to_xhtml(:save_with => Nokogiri::XML::Node::SaveOptions::AS_XHTML) + else + @toc_content = nil + end + end @editable = false mustache :page end @@ -195,8 +207,18 @@ module Precious if page = wiki.page(name) @page = page @name = name - @content = page.formatted_data @editable = true + @content = page.formatted_data do + |doc| + # Insert anchors for table of contents + toc = Gollum::Extensions::Toc_gen.new doc + if (toc_content = toc.generate) + toc.insert_anchors + @toc_content = toc_content.to_xhtml(:save_with => Nokogiri::XML::Node::SaveOptions::AS_XHTML) + else + @toc_content = nil + end + end mustache :page elsif file = wiki.file(name) content_type file.mime_type diff --git a/lib/gollum/frontend/public/gollum/css/gollum.css b/lib/gollum/frontend/public/gollum/css/gollum.css index e8847dcb..5419d141 100755 --- a/lib/gollum/frontend/public/gollum/css/gollum.css +++ b/lib/gollum/frontend/public/gollum/css/gollum.css @@ -71,6 +71,7 @@ a:hover, a:visited { #wiki-body { display: block; float: left; + clear: left; margin-right: 3%; margin-bottom: 40px; width: 100%; @@ -80,6 +81,42 @@ a:hover, a:visited { width: 68%; } +/* @section toc */ +#wiki-toc-main { + background-color: #F7F7F7; + border: 1px solid #DDD; + font-size: 13px; + padding: 7px; + float:left; + margin-bottom: 20px; + + border-radius: 0.5em; + -moz-border-radius: 0.5em; + -webkit-border-radius: 0.5em; +} + +#wiki-toc-main > h2 { + font-size: 24px; + border-bottom: 1px solid #CCC; + color: black; + margin-top: 5px; + margin-bottom: 20px; +} + +#wiki-toc-main ul { + -webkit-margin-before: 0px; + -webkit-padding-start: 0px; + margin-left: 1em; + margin-right: 1em; + padding-left: 0; +} + +#wiki-toc-main ul li { + line-height: 1.75em; + list-style-position: inside; + list-style-type: round; +} + /* @section rightbar */ #wiki-rightbar { background-color: #f7f7f7; @@ -141,6 +178,7 @@ a:hover, a:visited { #wiki-header #header-content { margin-bottom: 1.5em; } + #wiki-footer #footer-content { margin-top: 1.5em; } diff --git a/lib/gollum/frontend/templates/page.mustache b/lib/gollum/frontend/templates/page.mustache index d60ae5d6..f43969db 100644 --- a/lib/gollum/frontend/templates/page.mustache +++ b/lib/gollum/frontend/templates/page.mustache @@ -18,7 +18,20 @@
-
+
+ {{#has_toc}} +
+

Table of contents

+ {{{toc_content}}} +
+ {{/has_toc}} + {{#has_sidebar}} +
+
+ {{{sidebar_content}}} +
+
+ {{/has_sidebar}}
{{#has_header}}
@@ -31,13 +44,6 @@ {{{content}}}
- {{#has_sidebar}} -
-
- {{{sidebar_content}}} -
-
- {{/has_sidebar}} {{#has_footer}}
diff --git a/lib/gollum/frontend/views/page.rb b/lib/gollum/frontend/views/page.rb index 2fe2ab0f..953cdb10 100644 --- a/lib/gollum/frontend/views/page.rb +++ b/lib/gollum/frontend/views/page.rb @@ -65,6 +65,12 @@ module Precious def sidebar_format has_sidebar && @sidebar.format.to_s end + def has_toc + !@toc_content.nil? + end + def toc_content + @toc_content + end end end end From 8435daa5985d4b2277f562de9b19e48792e20391 Mon Sep 17 00:00:00 2001 From: Arran Cudbard-Bell Date: Wed, 9 May 2012 15:37:42 +0200 Subject: [PATCH 03/30] Stop anchor highlighting --- lib/extensions/toc.rb | 3 ++- lib/gollum/frontend/public/gollum/css/template.css | 5 +++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/lib/extensions/toc.rb b/lib/extensions/toc.rb index ab1889f3..00de2670 100644 --- a/lib/extensions/toc.rb +++ b/lib/extensions/toc.rb @@ -43,7 +43,8 @@ module Gollum::Extensions def insert_anchors find_headings.each do |h| rep_h = Nokogiri::XML::Node.new('a', @doc) - rep_h['name'] = anchor_id(h.content) + rep_h['class'] = 'wiki-toc-anchor' + rep_h['id'] = anchor_id(h.content) rep_h.add_child(h.clone) h.replace(rep_h) end diff --git a/lib/gollum/frontend/public/gollum/css/template.css b/lib/gollum/frontend/public/gollum/css/template.css index 119c2395..3ee75697 100644 --- a/lib/gollum/frontend/public/gollum/css/template.css +++ b/lib/gollum/frontend/public/gollum/css/template.css @@ -26,6 +26,11 @@ a.absent { color: #c00; } +.markdown-body a[id].wiki-toc-anchor { + color: inherit; + text-decoration: none; +} + .markdown-body { font-size: 14px; line-height: 1.6; From 75c02475bea0a95e647f6bca98c1b322bcb0d30a Mon Sep 17 00:00:00 2001 From: kristi Date: Wed, 9 May 2012 12:14:45 -0700 Subject: [PATCH 04/30] Remove extensions namespace --- lib/gollum/frontend/app.rb | 6 +++--- lib/{extensions => gollum}/toc.rb | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) rename lib/{extensions => gollum}/toc.rb (99%) diff --git a/lib/gollum/frontend/app.rb b/lib/gollum/frontend/app.rb index 84c6c515..06bf6798 100644 --- a/lib/gollum/frontend/app.rb +++ b/lib/gollum/frontend/app.rb @@ -6,7 +6,7 @@ require 'mustache/sinatra' require 'gollum/frontend/views/layout' require 'gollum/frontend/views/editable' -require 'extensions/toc' +require 'toc' module Precious class App < Sinatra::Base @@ -116,7 +116,7 @@ module Precious @content = @page.formatted_data do |doc| # Insert anchors for table of contents - toc = Gollum::Extensions::Toc_gen.new doc + toc = Gollum::Toc_gen.new doc if (toc_content = toc.generate) toc.insert_anchors @toc_content = toc_content.to_xhtml(:save_with => Nokogiri::XML::Node::SaveOptions::AS_XHTML) @@ -211,7 +211,7 @@ module Precious @content = page.formatted_data do |doc| # Insert anchors for table of contents - toc = Gollum::Extensions::Toc_gen.new doc + toc = Gollum::Toc_gen.new doc if (toc_content = toc.generate) toc.insert_anchors @toc_content = toc_content.to_xhtml(:save_with => Nokogiri::XML::Node::SaveOptions::AS_XHTML) diff --git a/lib/extensions/toc.rb b/lib/gollum/toc.rb similarity index 99% rename from lib/extensions/toc.rb rename to lib/gollum/toc.rb index 00de2670..e0c3dfa8 100644 --- a/lib/extensions/toc.rb +++ b/lib/gollum/toc.rb @@ -1,4 +1,4 @@ -module Gollum::Extensions +module Gollum class Toc_gen attr_accessor :header_tags @@ -130,4 +130,4 @@ module Gollum::Extensions @lvls[lvl_dst] end end -end \ No newline at end of file +end From bb417c697584ce84d77ce5103cc0d8dcab681116 Mon Sep 17 00:00:00 2001 From: kristi Date: Wed, 9 May 2012 12:18:24 -0700 Subject: [PATCH 05/30] Rename class to Toc --- lib/gollum/frontend/app.rb | 4 ++-- lib/gollum/toc.rb | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/gollum/frontend/app.rb b/lib/gollum/frontend/app.rb index 06bf6798..25237416 100644 --- a/lib/gollum/frontend/app.rb +++ b/lib/gollum/frontend/app.rb @@ -116,7 +116,7 @@ module Precious @content = @page.formatted_data do |doc| # Insert anchors for table of contents - toc = Gollum::Toc_gen.new doc + toc = Gollum::Toc.new doc if (toc_content = toc.generate) toc.insert_anchors @toc_content = toc_content.to_xhtml(:save_with => Nokogiri::XML::Node::SaveOptions::AS_XHTML) @@ -211,7 +211,7 @@ module Precious @content = page.formatted_data do |doc| # Insert anchors for table of contents - toc = Gollum::Toc_gen.new doc + toc = Gollum::Toc.new doc if (toc_content = toc.generate) toc.insert_anchors @toc_content = toc_content.to_xhtml(:save_with => Nokogiri::XML::Node::SaveOptions::AS_XHTML) diff --git a/lib/gollum/toc.rb b/lib/gollum/toc.rb index e0c3dfa8..136218e6 100644 --- a/lib/gollum/toc.rb +++ b/lib/gollum/toc.rb @@ -1,5 +1,5 @@ module Gollum - class Toc_gen + class Toc attr_accessor :header_tags NODE_CONTENT = 0 From 63107566ec9b263cb393403ddc721c1058ed494d Mon Sep 17 00:00:00 2001 From: kristi Date: Wed, 9 May 2012 13:33:08 -0700 Subject: [PATCH 06/30] add Toc to Gollum --- lib/gollum.rb | 1 + lib/gollum/frontend/app.rb | 1 - 2 files changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/gollum.rb b/lib/gollum.rb index a6cfa818..8636ef8d 100644 --- a/lib/gollum.rb +++ b/lib/gollum.rb @@ -14,6 +14,7 @@ require File.expand_path('../gollum/pagination', __FILE__) require File.expand_path('../gollum/blob_entry', __FILE__) require File.expand_path('../gollum/wiki', __FILE__) require File.expand_path('../gollum/page', __FILE__) +require File.expand_path('../gollum/toc', __FILE__) require File.expand_path('../gollum/file', __FILE__) require File.expand_path('../gollum/markup', __FILE__) require File.expand_path('../gollum/sanitization', __FILE__) diff --git a/lib/gollum/frontend/app.rb b/lib/gollum/frontend/app.rb index 25237416..29776549 100644 --- a/lib/gollum/frontend/app.rb +++ b/lib/gollum/frontend/app.rb @@ -6,7 +6,6 @@ require 'mustache/sinatra' require 'gollum/frontend/views/layout' require 'gollum/frontend/views/editable' -require 'toc' module Precious class App < Sinatra::Base From 065d06a98f16521125d2039b7a6a18a8156136b7 Mon Sep 17 00:00:00 2001 From: kristi Date: Wed, 9 May 2012 13:33:54 -0700 Subject: [PATCH 07/30] Move toc calling code out of app; put in Page.toc_data Page stores the formatted document parsed by Nokogiri --- lib/gollum/frontend/app.rb | 27 +++++---------------------- lib/gollum/page.rb | 19 ++++++++++++++++++- 2 files changed, 23 insertions(+), 23 deletions(-) diff --git a/lib/gollum/frontend/app.rb b/lib/gollum/frontend/app.rb index 29776549..73d000c6 100644 --- a/lib/gollum/frontend/app.rb +++ b/lib/gollum/frontend/app.rb @@ -112,17 +112,8 @@ module Precious wiki = Gollum::Wiki.new(settings.gollum_path, settings.wiki_options) @name = "Preview" @page = wiki.preview_page(@name, params[:content], params[:format]) - @content = @page.formatted_data do - |doc| - # Insert anchors for table of contents - toc = Gollum::Toc.new doc - if (toc_content = toc.generate) - toc.insert_anchors - @toc_content = toc_content.to_xhtml(:save_with => Nokogiri::XML::Node::SaveOptions::AS_XHTML) - else - @toc_content = nil - end - end + @content = @page.formatted_data + @toc_content = @page.toc_data @editable = false mustache :page end @@ -207,17 +198,9 @@ module Precious @page = page @name = name @editable = true - @content = page.formatted_data do - |doc| - # Insert anchors for table of contents - toc = Gollum::Toc.new doc - if (toc_content = toc.generate) - toc.insert_anchors - @toc_content = toc_content.to_xhtml(:save_with => Nokogiri::XML::Node::SaveOptions::AS_XHTML) - else - @toc_content = nil - end - end + @content = page.formatted_data + @toc_content = page.toc_data + mustache :page elsif file = wiki.file(name) content_type file.mime_type diff --git a/lib/gollum/page.rb b/lib/gollum/page.rb index 55ba9b2e..218a460b 100644 --- a/lib/gollum/page.rb +++ b/lib/gollum/page.rb @@ -164,7 +164,24 @@ module Gollum # # Returns the String data. def formatted_data(encoding = nil, &block) - @blob && markup_class.render(historical?, encoding, &block) + @blob && markup_class.render(historical?, encoding) do |doc| + @doc = doc + yield doc if block_given? + end + end + + # Public: The table of contents of the page. + # + # formatted_data - page already marked up in html. + # + # Returns the String data. + def toc_data() + formatted_data if @doc == nil + toc = Toc.new(@doc) + if (toc_content = toc.generate) + toc.insert_anchors + toc.generate.to_xhtml(:save_with => Nokogiri::XML::Node::SaveOptions::AS_XHTML) + end end # Public: The format of the page. From 61987c85d284ea9af5bdb895a1e37786c9dd3e7d Mon Sep 17 00:00:00 2001 From: kristi Date: Wed, 9 May 2012 16:13:53 -0700 Subject: [PATCH 08/30] Add universal_toc wiki option --- lib/gollum/frontend/app.rb | 4 ++-- lib/gollum/page.rb | 1 + lib/gollum/wiki.rb | 5 +++++ 3 files changed, 8 insertions(+), 2 deletions(-) diff --git a/lib/gollum/frontend/app.rb b/lib/gollum/frontend/app.rb index 73d000c6..810391bc 100644 --- a/lib/gollum/frontend/app.rb +++ b/lib/gollum/frontend/app.rb @@ -113,7 +113,7 @@ module Precious @name = "Preview" @page = wiki.preview_page(@name, params[:content], params[:format]) @content = @page.formatted_data - @toc_content = @page.toc_data + @toc_content = wiki.universal_toc ? @page.toc_data : nil @editable = false mustache :page end @@ -199,7 +199,7 @@ module Precious @name = name @editable = true @content = page.formatted_data - @toc_content = page.toc_data + @toc_content = wiki.universal_toc ? @page.toc_data : nil mustache :page elsif file = wiki.file(name) diff --git a/lib/gollum/page.rb b/lib/gollum/page.rb index 218a460b..10716dd8 100644 --- a/lib/gollum/page.rb +++ b/lib/gollum/page.rb @@ -100,6 +100,7 @@ module Gollum def initialize(wiki) @wiki = wiki @blob = @header = @footer = @sidebar = nil + @doc = nil end # Public: The on-disk filename of the page including extension. diff --git a/lib/gollum/wiki.rb b/lib/gollum/wiki.rb index deb97c52..9c065c9a 100644 --- a/lib/gollum/wiki.rb +++ b/lib/gollum/wiki.rb @@ -133,6 +133,7 @@ module Gollum # path - The String path to the Git repository that holds the Gollum # site. # options - Optional Hash: + # :universal_toc - Display table of contents on all pages. Default: false # :base_path - String base path for all Wiki links. # Default: "/" # :page_class - The page Class. Default: Gollum::Page @@ -164,6 +165,7 @@ module Gollum self.class.default_ws_subs @history_sanitization = options[:history_sanitization] || self.class.history_sanitization + @universal_toc = options[:universal_toc] || false end # Public: check whether the wiki's git repo exists on the filesystem. @@ -527,6 +529,9 @@ module Gollum # Gets the markup class used by all instances of this Wiki. attr_reader :markup_classes + # Toggles display of universal table of contents + attr_reader :universal_toc + # Normalize the data. # # data - The String data to be normalized. From ca7489756976e32184237adf0394249f722bfa04 Mon Sep 17 00:00:00 2001 From: kristi Date: Thu, 10 May 2012 00:26:22 -0700 Subject: [PATCH 09/30] Add header_hashtag feature option: headers display a link icon when moused over so you can jump to sections Move anchor processing into markup.rb Use dashes for spaces in the anchor hashtag --- .../frontend/public/gollum/css/template.css | 2 +- lib/gollum/frontend/templates/page.mustache | 2 +- lib/gollum/markup.rb | 11 ++++++++++- lib/gollum/page.rb | 1 - lib/gollum/toc.rb | 17 +---------------- lib/gollum/wiki.rb | 5 +++++ 6 files changed, 18 insertions(+), 20 deletions(-) diff --git a/lib/gollum/frontend/public/gollum/css/template.css b/lib/gollum/frontend/public/gollum/css/template.css index 3ee75697..f77de707 100644 --- a/lib/gollum/frontend/public/gollum/css/template.css +++ b/lib/gollum/frontend/public/gollum/css/template.css @@ -73,7 +73,7 @@ a.absent { .markdown-body h4:hover a.anchor, .markdown-body h5:hover a.anchor, .markdown-body h6:hover a.anchor { - background: url('/images/para.png') no-repeat 10px center; + background: url('/images/para.png') no-repeat center center; text-decoration: none; } .markdown-body h1 tt, diff --git a/lib/gollum/frontend/templates/page.mustache b/lib/gollum/frontend/templates/page.mustache index f43969db..cac436e5 100644 --- a/lib/gollum/frontend/templates/page.mustache +++ b/lib/gollum/frontend/templates/page.mustache @@ -18,7 +18,7 @@
-
+
{{#has_toc}}

Table of contents

diff --git a/lib/gollum/markup.rb b/lib/gollum/markup.rb index 06463be7..f838c550 100644 --- a/lib/gollum/markup.rb +++ b/lib/gollum/markup.rb @@ -53,9 +53,18 @@ module Gollum end data = process_tags(data) data = process_code(data, encoding) - if sanitize || block_given? + if sanitize || block_given? || @wiki.header_anchors || @wiki.universal_toc doc = Nokogiri::HTML::DocumentFragment.parse(data) doc = sanitize.clean_node!(doc) if sanitize + + doc.css('h1,h2,h3,h4,h5,h6').each do |h| + link = CGI::escape(h.content.gsub(' ','-')) + anchor = Nokogiri::XML::Node.new('a', doc) + anchor['class'] = 'anchor' + anchor['id'] = link + anchor['href'] = '#' + link + h.child.before(anchor) + end if @wiki.header_anchors || @wiki.universal_toc yield doc if block_given? data = doc.to_html end diff --git a/lib/gollum/page.rb b/lib/gollum/page.rb index 10716dd8..909eb31b 100644 --- a/lib/gollum/page.rb +++ b/lib/gollum/page.rb @@ -180,7 +180,6 @@ module Gollum formatted_data if @doc == nil toc = Toc.new(@doc) if (toc_content = toc.generate) - toc.insert_anchors toc.generate.to_xhtml(:save_with => Nokogiri::XML::Node::SaveOptions::AS_XHTML) end end diff --git a/lib/gollum/toc.rb b/lib/gollum/toc.rb index 136218e6..0b748377 100644 --- a/lib/gollum/toc.rb +++ b/lib/gollum/toc.rb @@ -35,28 +35,13 @@ module Gollum flatten_to_lvl(lvl, 0) end - # Escape title string for use in ID attribute - # - # title - Title string - # - # Returns string - def insert_anchors - find_headings.each do |h| - rep_h = Nokogiri::XML::Node.new('a', @doc) - rep_h['class'] = 'wiki-toc-anchor' - rep_h['id'] = anchor_id(h.content) - rep_h.add_child(h.clone) - h.replace(rep_h) - end - end - # Escape title string for use in ID attribute # # title - Title string # # Returns string def anchor_id (title) - CGI::escape(title) + CGI::escape(title.gsub(' ','-')) end # Convert heading into list element diff --git a/lib/gollum/wiki.rb b/lib/gollum/wiki.rb index 9c065c9a..8daf4e57 100644 --- a/lib/gollum/wiki.rb +++ b/lib/gollum/wiki.rb @@ -134,6 +134,7 @@ module Gollum # site. # options - Optional Hash: # :universal_toc - Display table of contents on all pages. Default: false + # :header_hashtags - Show links to headers. Default: true # :base_path - String base path for all Wiki links. # Default: "/" # :page_class - The page Class. Default: Gollum::Page @@ -166,6 +167,7 @@ module Gollum @history_sanitization = options[:history_sanitization] || self.class.history_sanitization @universal_toc = options[:universal_toc] || false + @header_hashtags = options[:header_hashtags] || true end # Public: check whether the wiki's git repo exists on the filesystem. @@ -532,6 +534,9 @@ module Gollum # Toggles display of universal table of contents attr_reader :universal_toc + # Create hashtag link for headers to jump to sections + attr_reader :header_hashtags + # Normalize the data. # # data - The String data to be normalized. From 584641236be5748d64351600edc1f9b852dadd7b Mon Sep 17 00:00:00 2001 From: kristi Date: Thu, 10 May 2012 00:34:35 -0700 Subject: [PATCH 10/30] fixup toc/anchor code in markup.rb --- lib/gollum/markup.rb | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/gollum/markup.rb b/lib/gollum/markup.rb index f838c550..3db0dcf5 100644 --- a/lib/gollum/markup.rb +++ b/lib/gollum/markup.rb @@ -58,13 +58,13 @@ module Gollum doc = sanitize.clean_node!(doc) if sanitize doc.css('h1,h2,h3,h4,h5,h6').each do |h| - link = CGI::escape(h.content.gsub(' ','-')) + id = CGI::escape(h.content.gsub(' ','-')) anchor = Nokogiri::XML::Node.new('a', doc) anchor['class'] = 'anchor' - anchor['id'] = link - anchor['href'] = '#' + link + anchor['id'] = id + anchor['href'] = '#' + id h.child.before(anchor) - end if @wiki.header_anchors || @wiki.universal_toc + end if @wiki.header_hashtags || @wiki.universal_toc yield doc if block_given? data = doc.to_html end From 28b729acdad41a0c7bee928116f6683a84c26026 Mon Sep 17 00:00:00 2001 From: kristi Date: Thu, 10 May 2012 00:38:35 -0700 Subject: [PATCH 11/30] Add in some minimal documentation for wiki options --- lib/gollum/frontend/app.rb | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/lib/gollum/frontend/app.rb b/lib/gollum/frontend/app.rb index 810391bc..9d0a7068 100644 --- a/lib/gollum/frontend/app.rb +++ b/lib/gollum/frontend/app.rb @@ -6,7 +6,18 @@ require 'mustache/sinatra' require 'gollum/frontend/views/layout' require 'gollum/frontend/views/editable' - +# Run the frontend, based on Sinatra +# +# There are a number of wiki options that can be set for the frontend +# +# Example +# require 'gollum/frontend/app' +# Precious::App.set(:wiki_options, { +# :universal_toc => false, +# :header_hashtags => true +# } +# +# See the wiki.rb file for more details on wiki options module Precious class App < Sinatra::Base register Mustache::Sinatra From ec694e4a995abc67bf29c15412d8d7bef70e62a8 Mon Sep 17 00:00:00 2001 From: kristi Date: Fri, 11 May 2012 12:50:34 -0700 Subject: [PATCH 12/30] Fix option setting --- lib/gollum/wiki.rb | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/lib/gollum/wiki.rb b/lib/gollum/wiki.rb index 8daf4e57..fe6183a5 100644 --- a/lib/gollum/wiki.rb +++ b/lib/gollum/wiki.rb @@ -133,8 +133,10 @@ module Gollum # path - The String path to the Git repository that holds the Gollum # site. # options - Optional Hash: - # :universal_toc - Display table of contents on all pages. Default: false + # :universal_toc - Table of contents on all pages. Default: false # :header_hashtags - Show links to headers. Default: true + # (Pages may be rendered slightly faster without + # the toc and hashtags) # :base_path - String base path for all Wiki links. # Default: "/" # :page_class - The page Class. Default: Gollum::Page @@ -166,8 +168,8 @@ module Gollum self.class.default_ws_subs @history_sanitization = options[:history_sanitization] || self.class.history_sanitization - @universal_toc = options[:universal_toc] || false - @header_hashtags = options[:header_hashtags] || true + @universal_toc = options.fetch(:universal_toc, false) + @header_hashtags = options.fetch(:header_hashtags, true) end # Public: check whether the wiki's git repo exists on the filesystem. From f53e1a60d598d908f9212ad7b18a563d22b85d57 Mon Sep 17 00:00:00 2001 From: kristi Date: Fri, 11 May 2012 12:51:04 -0700 Subject: [PATCH 13/30] Fix tests by adding a default_options hash to the wiki --- lib/gollum/wiki.rb | 6 ++++++ test/test_markup.rb | 1 + test/test_wiki.rb | 1 + 3 files changed, 8 insertions(+) diff --git a/lib/gollum/wiki.rb b/lib/gollum/wiki.rb index fe6183a5..a77d8c7c 100644 --- a/lib/gollum/wiki.rb +++ b/lib/gollum/wiki.rb @@ -32,6 +32,10 @@ module Gollum # sanitization altogether. attr_writer :history_sanitization + # Hash for setting different default wiki options + # These defaults can be overridden by options passed directly to initialize() + attr_accessor :default_options + # Gets the page class used by all instances of this Wiki. # Default: Gollum::Page. def page_class @@ -107,6 +111,7 @@ module Gollum self.default_committer_email = 'anon@anon.com' self.default_ws_subs = ['_','-'] + self.default_options = {} # The String base path to prefix to internal links. For example, when set # to "/wiki", the page "Hobbit" will be linked as "/wiki/Hobbit". Defaults @@ -150,6 +155,7 @@ module Gollum # # Returns a fresh Gollum::Repo. def initialize(path, options = {}) + options = self.class.default_options.merge(options) if path.is_a?(GitAccess) options[:access] = path path = path.path diff --git a/test/test_markup.rb b/test/test_markup.rb index 5a47a8f7..bf4e64c9 100644 --- a/test/test_markup.rb +++ b/test/test_markup.rb @@ -6,6 +6,7 @@ context "Markup" do @path = testpath("examples/test.git") FileUtils.rm_rf(@path) Grit::Repo.init_bare(@path) + Gollum::Wiki.default_options = {:header_hashtags => false, :universal_toc => false} @wiki = Gollum::Wiki.new(@path) end diff --git a/test/test_wiki.rb b/test/test_wiki.rb index 9fec5275..f866f853 100644 --- a/test/test_wiki.rb +++ b/test/test_wiki.rb @@ -92,6 +92,7 @@ end context "Wiki page previewing" do setup do @path = testpath("examples/lotr.git") + Gollum::Wiki.default_options = {:header_hashtags => false, :universal_toc => false} @wiki = Gollum::Wiki.new(@path) end From cabd0ed85e4a1905fc715e6723ed93a0aa20d8f2 Mon Sep 17 00:00:00 2001 From: kristi Date: Fri, 11 May 2012 13:27:43 -0700 Subject: [PATCH 14/30] Add tests for new universal_toc and header_hashtags wiki options --- test/test_wiki.rb | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/test/test_wiki.rb b/test/test_wiki.rb index f866f853..93e8622a 100644 --- a/test/test_wiki.rb +++ b/test/test_wiki.rb @@ -105,6 +105,35 @@ context "Wiki page previewing" do end end +context "Wiki TOC" do + setup do + @path = testpath("examples/lotr.git") + options = {:header_hashtags => false, :universal_toc => true} + @wiki = Gollum::Wiki.new(@path, options) + end + + test "toc_generation" do + page = @wiki.preview_page("Test", "# Bilbo", :markdown) + assert_equal "# Bilbo", page.raw_data + assert_equal '

Bilbo

', page.formatted_data.gsub(/\n/,"") + assert_equal '', page.toc_data.gsub(/\n */,"") + end +end + +context "Wiki header hashtags" do + setup do + @path = testpath("examples/lotr.git") + options = {:header_hashtags => true, :universal_toc => false} + @wiki = Gollum::Wiki.new(@path, options) + end + + test "header_hashtags" do + page = @wiki.preview_page("Test", "# Bilbo", :markdown) + assert_equal "# Bilbo", page.raw_data + assert_equal '

Bilbo

', page.formatted_data.gsub(/\n/,"") + end +end + context "Wiki page writing" do setup do @path = testpath("examples/test.git") From 26486da27be502fb251183c1493aa52c8658795a Mon Sep 17 00:00:00 2001 From: kristi Date: Fri, 11 May 2012 13:41:03 -0700 Subject: [PATCH 15/30] Use correct wiki option --- lib/gollum/markup.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/gollum/markup.rb b/lib/gollum/markup.rb index 3db0dcf5..3b7ea1af 100644 --- a/lib/gollum/markup.rb +++ b/lib/gollum/markup.rb @@ -53,7 +53,7 @@ module Gollum end data = process_tags(data) data = process_code(data, encoding) - if sanitize || block_given? || @wiki.header_anchors || @wiki.universal_toc + if sanitize || block_given? || @wiki.header_hashtags || @wiki.universal_toc doc = Nokogiri::HTML::DocumentFragment.parse(data) doc = sanitize.clean_node!(doc) if sanitize From aa1e845f9a3c1329b9a40f24ec22334420d75557 Mon Sep 17 00:00:00 2001 From: kristi Date: Sun, 13 May 2012 10:21:50 -0700 Subject: [PATCH 16/30] create process_headers function to add anchors and create toc --- lib/gollum/markup.rb | 57 ++++++++++++++++++++++++++++++++------------ 1 file changed, 42 insertions(+), 15 deletions(-) diff --git a/lib/gollum/markup.rb b/lib/gollum/markup.rb index 3b7ea1af..6c1714ad 100644 --- a/lib/gollum/markup.rb +++ b/lib/gollum/markup.rb @@ -23,6 +23,7 @@ module Gollum @texmap = {} @wsdmap = {} @premap = {} + @toc = nil end # Render the content with Gollum wiki syntax on top of the file's own @@ -53,27 +54,53 @@ module Gollum end data = process_tags(data) data = process_code(data, encoding) - if sanitize || block_given? || @wiki.header_hashtags || @wiki.universal_toc - doc = Nokogiri::HTML::DocumentFragment.parse(data) - doc = sanitize.clean_node!(doc) if sanitize - - doc.css('h1,h2,h3,h4,h5,h6').each do |h| - id = CGI::escape(h.content.gsub(' ','-')) - anchor = Nokogiri::XML::Node.new('a', doc) - anchor['class'] = 'anchor' - anchor['id'] = id - anchor['href'] = '#' + id - h.child.before(anchor) - end if @wiki.header_hashtags || @wiki.universal_toc - yield doc if block_given? - data = doc.to_html - end + + doc = Nokogiri::HTML::DocumentFragment.parse(data) + doc = sanitize.clean_node!(doc) if sanitize + doc,@toc = process_headers(doc) if @wiki.header_hashtags || @wiki.universal_toc + yield doc if block_given? + data = doc.to_html + data = process_tex(data) data = process_wsd(data) data.gsub!(/

<\/p>/, '') data end + def process_headers(doc) + toc = nil + doc.css('h1,h2,h3,h4,h5,h6').each do |h| + id = CGI::escape(h.content.gsub(' ','-')) + level = h.name.gsub(/[hH]/,'').to_i + + # Add anchors + anchor = Nokogiri::XML::Node.new('a', doc) + anchor['class'] = 'anchor' + anchor['id'] = id + anchor['href'] = '#' + id + h.child.before(anchor) + + # Build TOC + toc ||= Nokogiri::XML::Node.new('ul', doc) + tail ||= toc + tail_level ||= 1 + + while tail_level < level do + node = Nokogiri::XML::Node.new('ul', doc) + tail = tail.add_child(node) + tail_level += 1 + end + while tail_level > level + tail = tail.parent + tail_level -= 1 + end + node = Nokogiri::XML::Node.new('li', doc) + node.add_child("#{h.content}") + tail.add_child(node) + end + [doc, toc] + end + ######################################################################### # # TeX From 1d3905bb71a16ce10c208c19c59a7dfcc8d86203 Mon Sep 17 00:00:00 2001 From: kristi Date: Sun, 13 May 2012 12:44:20 -0700 Subject: [PATCH 17/30] Use special tag [[_TOC_]] to insert a table of contents --- lib/gollum/markup.rb | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/lib/gollum/markup.rb b/lib/gollum/markup.rb index 6c1714ad..25e7b685 100644 --- a/lib/gollum/markup.rb +++ b/lib/gollum/markup.rb @@ -61,6 +61,7 @@ module Gollum yield doc if block_given? data = doc.to_html + data = process_toc_tags(data) data = process_tex(data) data = process_wsd(data) data.gsub!(/

<\/p>/, '') @@ -201,7 +202,9 @@ module Gollum # # Returns the String HTML version of the tag. def process_tag(tag) - if html = process_image_tag(tag) + if tag =~ /^_TOC_$/ + %{[[#{tag}]]} + elsif html = process_image_tag(tag) html elsif html = process_file_link_tag(tag) html @@ -358,6 +361,17 @@ module Gollum end end + + # Process the special table of contents tag [[_TOC_]] + # + # data - The String data (with placeholders). + # + # Returns the marked up String data. + def process_toc_tags(data) + data.gsub!("[[_TOC_]]", @toc.nil? ? '' : @toc.to_html) + data + end + # Find the given file in the repo. # # name - The String absolute or relative path of the file. From ae30b23d34a3c98895d8ed5e34d1d7041b86ea23 Mon Sep 17 00:00:00 2001 From: kristi Date: Sun, 13 May 2012 18:48:02 -0700 Subject: [PATCH 18/30] insert a comment if no TOC headers found --- lib/gollum/markup.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/gollum/markup.rb b/lib/gollum/markup.rb index 25e7b685..42dcef1f 100644 --- a/lib/gollum/markup.rb +++ b/lib/gollum/markup.rb @@ -69,7 +69,6 @@ module Gollum end def process_headers(doc) - toc = nil doc.css('h1,h2,h3,h4,h5,h6').each do |h| id = CGI::escape(h.content.gsub(' ','-')) level = h.name.gsub(/[hH]/,'').to_i @@ -86,7 +85,7 @@ module Gollum tail ||= toc tail_level ||= 1 - while tail_level < level do + while tail_level < level node = Nokogiri::XML::Node.new('ul', doc) tail = tail.add_child(node) tail_level += 1 @@ -99,6 +98,7 @@ module Gollum node.add_child("#{h.content}") tail.add_child(node) end + toc ||= Nokogiri::XML::DocumentFragment.parse('') [doc, toc] end From 4fa2cdf8d9d0e7c6e542e8390c4140fd3bee3647 Mon Sep 17 00:00:00 2001 From: kristi Date: Sun, 13 May 2012 22:19:55 -0700 Subject: [PATCH 19/30] Allow sub pages to use the [[_TOC_]] tag --- lib/gollum/markup.rb | 11 ++++++++--- lib/gollum/page.rb | 27 +++++++++++++++++++++------ 2 files changed, 29 insertions(+), 9 deletions(-) diff --git a/lib/gollum/markup.rb b/lib/gollum/markup.rb index 42dcef1f..4e05f634 100644 --- a/lib/gollum/markup.rb +++ b/lib/gollum/markup.rb @@ -6,6 +6,7 @@ require 'base64' module Gollum class Markup + attr_accessor :toc # Initialize a new Markup object. # # page - The Gollum::Page. @@ -17,6 +18,8 @@ module Gollum @data = page.text_data @version = page.version.id if page.version @format = page.format + @sub_page = page.sub_page + @parent_page = page.parent_page @dir = ::File.dirname(page.path) @tagmap = {} @codemap = {} @@ -57,7 +60,8 @@ module Gollum doc = Nokogiri::HTML::DocumentFragment.parse(data) doc = sanitize.clean_node!(doc) if sanitize - doc,@toc = process_headers(doc) if @wiki.header_hashtags || @wiki.universal_toc + doc,toc = process_headers(doc) + @toc = @sub_page ? @parent_page.toc_data : toc yield doc if block_given? data = doc.to_html @@ -69,6 +73,7 @@ module Gollum end def process_headers(doc) + toc = nil doc.css('h1,h2,h3,h4,h5,h6').each do |h| id = CGI::escape(h.content.gsub(' ','-')) level = h.name.gsub(/[hH]/,'').to_i @@ -98,7 +103,7 @@ module Gollum node.add_child("#{h.content}") tail.add_child(node) end - toc ||= Nokogiri::XML::DocumentFragment.parse('') + toc = toc.to_xhtml if toc != nil [doc, toc] end @@ -368,7 +373,7 @@ module Gollum # # Returns the marked up String data. def process_toc_tags(data) - data.gsub!("[[_TOC_]]", @toc.nil? ? '' : @toc.to_html) + data.gsub!("[[_TOC_]]", @toc.nil? ? '' : @toc) data end diff --git a/lib/gollum/page.rb b/lib/gollum/page.rb index 909eb31b..fadf7946 100644 --- a/lib/gollum/page.rb +++ b/lib/gollum/page.rb @@ -20,6 +20,11 @@ module Gollum # Returns nothing. attr_writer :historical + # Parent page if this is a sub page + # + # Returns a Page + attr_accessor :parent_page + # Checks if a filename has a valid extension understood by GitHub::Markup. # # filename - String filename, like "Home.md". @@ -101,6 +106,7 @@ module Gollum @wiki = wiki @blob = @header = @footer = @sidebar = nil @doc = nil + @parent_page = nil end # Public: The on-disk filename of the page including extension. @@ -134,6 +140,14 @@ module Gollum Sanitize.clean(name).strip end + # Public: Determines if this is a sub-page + # Sub-pages have filenames beginning with an underscore + # + # Returns true or false. + def sub_page + filename =~ /^_/ + end + # Public: The path of the page within the repo. # # Returns the String path. @@ -177,11 +191,9 @@ module Gollum # # Returns the String data. def toc_data() - formatted_data if @doc == nil - toc = Toc.new(@doc) - if (toc_content = toc.generate) - toc.generate.to_xhtml(:save_with => Nokogiri::XML::Node::SaveOptions::AS_XHTML) - end + return @parent_page.toc_data if @parent_page and @sub_page + formatted_data if markup_class.toc == nil + markup_class.toc end # Public: The format of the page. @@ -417,12 +429,15 @@ module Gollum map = @wiki.tree_map_for(self.version.id) while !dirs.empty? if page = find_page_in_tree(map, name, dirs.join('/')) + page.parent_page = self return page end dirs.pop end - find_page_in_tree(map, name, '') + page = find_page_in_tree(map, name, '') + page.parent_page = self + page end def inspect From b0ba205532e98f09a291a249db153bbcab739be5 Mon Sep 17 00:00:00 2001 From: kristi Date: Mon, 14 May 2012 00:38:27 -0700 Subject: [PATCH 20/30] Remove :header_hashtags option and adjust tests --- lib/gollum/frontend/app.rb | 1 - lib/gollum/markup.rb | 2 +- lib/gollum/wiki.rb | 7 ------- test/test_markup.rb | 15 ++++++++------- test/test_page.rb | 2 +- test/test_wiki.rb | 22 ++++------------------ 6 files changed, 14 insertions(+), 35 deletions(-) diff --git a/lib/gollum/frontend/app.rb b/lib/gollum/frontend/app.rb index 9d0a7068..5bc93f3c 100644 --- a/lib/gollum/frontend/app.rb +++ b/lib/gollum/frontend/app.rb @@ -14,7 +14,6 @@ require 'gollum/frontend/views/editable' # require 'gollum/frontend/app' # Precious::App.set(:wiki_options, { # :universal_toc => false, -# :header_hashtags => true # } # # See the wiki.rb file for more details on wiki options diff --git a/lib/gollum/markup.rb b/lib/gollum/markup.rb index 4e05f634..28a53d45 100644 --- a/lib/gollum/markup.rb +++ b/lib/gollum/markup.rb @@ -83,7 +83,7 @@ module Gollum anchor['class'] = 'anchor' anchor['id'] = id anchor['href'] = '#' + id - h.child.before(anchor) + h.add_child(anchor) # Build TOC toc ||= Nokogiri::XML::Node.new('ul', doc) diff --git a/lib/gollum/wiki.rb b/lib/gollum/wiki.rb index a77d8c7c..517ace93 100644 --- a/lib/gollum/wiki.rb +++ b/lib/gollum/wiki.rb @@ -139,9 +139,6 @@ module Gollum # site. # options - Optional Hash: # :universal_toc - Table of contents on all pages. Default: false - # :header_hashtags - Show links to headers. Default: true - # (Pages may be rendered slightly faster without - # the toc and hashtags) # :base_path - String base path for all Wiki links. # Default: "/" # :page_class - The page Class. Default: Gollum::Page @@ -175,7 +172,6 @@ module Gollum @history_sanitization = options[:history_sanitization] || self.class.history_sanitization @universal_toc = options.fetch(:universal_toc, false) - @header_hashtags = options.fetch(:header_hashtags, true) end # Public: check whether the wiki's git repo exists on the filesystem. @@ -542,9 +538,6 @@ module Gollum # Toggles display of universal table of contents attr_reader :universal_toc - # Create hashtag link for headers to jump to sections - attr_reader :header_hashtags - # Normalize the data. # # data - The String data to be normalized. diff --git a/test/test_markup.rb b/test/test_markup.rb index bf4e64c9..41539de9 100644 --- a/test/test_markup.rb +++ b/test/test_markup.rb @@ -6,7 +6,7 @@ context "Markup" do @path = testpath("examples/test.git") FileUtils.rm_rf(@path) Grit::Repo.init_bare(@path) - Gollum::Wiki.default_options = {:header_hashtags => false, :universal_toc => false} + Gollum::Wiki.default_options = {:universal_toc => false} @wiki = Gollum::Wiki.new(@path) end @@ -556,14 +556,15 @@ np.array([[2,2],[1,3]],np.float) test "id with prefix ok" do content = "h2(example#wiki-foo). xxxx" - output = %(

xxxx

) - compare(content, output, :textile) - end +output = %(

xxxx

) +compare(content, output, :textile) +end test "id prefix added" do content = "h2(#foo). xxxx[1]\n\nfn1.footnote" output = "

xxxx" + - "1

" + + "1" + + "" + "\n

1 footnote

" compare(content, output, :textile) end @@ -601,11 +602,11 @@ np.array([[2,2],[1,3]],np.float) ######################################################################### test "asciidoc header" do - compare("= Book Title\n\n== Heading", '

Heading

', 'asciidoc') + compare("= Book Title\n\n== Heading", '

Heading

', 'asciidoc') end test "internal links with asciidoc" do - compare("= Book Title\n\n[[anid]]\n== Heading", '

Heading

', 'asciidoc') + compare("= Book Title\n\n[[anid]]\n== Heading", '

Heading

', 'asciidoc') end diff --git a/test/test_page.rb b/test/test_page.rb index 9adf4660..c81b1187 100644 --- a/test/test_page.rb +++ b/test/test_page.rb @@ -16,7 +16,7 @@ context "Page" do page = @wiki.page('Bilbo Baggins') assert_equal Gollum::Page, page.class assert page.raw_data =~ /^# Bilbo Baggins\n\nBilbo Baggins/ - assert page.formatted_data =~ /

Bilbo Baggins<\/h1>\n\n

Bilbo Baggins/ + assert page.formatted_data =~ %r{

Bilbo Baggins\n

\n\n

Bilbo Baggins} assert_equal 'Bilbo-Baggins.md', page.path assert_equal :markdown, page.format assert_equal @wiki.repo.commits.first.id, page.version.id diff --git a/test/test_wiki.rb b/test/test_wiki.rb index 93e8622a..3ec25a04 100644 --- a/test/test_wiki.rb +++ b/test/test_wiki.rb @@ -92,14 +92,14 @@ end context "Wiki page previewing" do setup do @path = testpath("examples/lotr.git") - Gollum::Wiki.default_options = {:header_hashtags => false, :universal_toc => false} + Gollum::Wiki.default_options = {:universal_toc => false} @wiki = Gollum::Wiki.new(@path) end test "preview_page" do page = @wiki.preview_page("Test", "# Bilbo", :markdown) assert_equal "# Bilbo", page.raw_data - assert_equal "

Bilbo

", page.formatted_data + assert_equal %Q{

Bilbo\n

}, page.formatted_data assert_equal "Test.md", page.filename assert_equal "Test", page.name end @@ -108,32 +108,18 @@ end context "Wiki TOC" do setup do @path = testpath("examples/lotr.git") - options = {:header_hashtags => false, :universal_toc => true} + options = {:universal_toc => true} @wiki = Gollum::Wiki.new(@path, options) end test "toc_generation" do page = @wiki.preview_page("Test", "# Bilbo", :markdown) assert_equal "# Bilbo", page.raw_data - assert_equal '

Bilbo

', page.formatted_data.gsub(/\n/,"") + assert_equal '

Bilbo

', page.formatted_data.gsub(/\n/,"") assert_equal '', page.toc_data.gsub(/\n */,"") end end -context "Wiki header hashtags" do - setup do - @path = testpath("examples/lotr.git") - options = {:header_hashtags => true, :universal_toc => false} - @wiki = Gollum::Wiki.new(@path, options) - end - - test "header_hashtags" do - page = @wiki.preview_page("Test", "# Bilbo", :markdown) - assert_equal "# Bilbo", page.raw_data - assert_equal '

Bilbo

', page.formatted_data.gsub(/\n/,"") - end -end - context "Wiki page writing" do setup do @path = testpath("examples/test.git") From eb92e4413a8dadd2dc7461be7fc3c30289e1c219 Mon Sep 17 00:00:00 2001 From: kristi Date: Mon, 14 May 2012 01:28:03 -0700 Subject: [PATCH 21/30] Add header files and TOC test files --- test/examples/lotr.git/config | 2 +- test/examples/lotr.git/logs/HEAD | 2 ++ test/examples/lotr.git/logs/refs/heads/master | 2 ++ .../0d/c9016ca928c78d5421a99a53b379b53929221e | Bin 0 -> 194 bytes .../45/3b250f979c7bd6dfb62640c944c982ae6721ee | Bin 0 -> 345 bytes .../45/f319ee12f2b551b901b22e72602963c366fff1 | Bin 0 -> 26 bytes .../46/a697caf435815bb07bbce947fc2d58be15f087 | Bin 0 -> 22 bytes .../4c/45c2b4e297a726c3d3f66886f35373e48fe1c5 | 2 ++ .../6e/48abfc56565574859e081ee58eae655d48cf71 | Bin 0 -> 104 bytes .../7b/60c5a20a501a70f2317fa0ef763e1e2ce22d6b | Bin 0 -> 317 bytes .../7d/981cd984ad589e3cf00d8122170c6f7d685979 | Bin 0 -> 23 bytes .../94/9a9cc3119b9c98817f375e976d2bb5e2a42809 | Bin 0 -> 155 bytes .../9b/e95b960ac388d4e7db55f610f828e9c31344e6 | Bin 0 -> 26 bytes .../b0/de6e794dfdc7ef3400e894225bfe23308aae5c | Bin 0 -> 169 bytes .../b1/6b3d9fad9d78e5a669e7f33d94c96da374eccd | Bin 0 -> 154 bytes .../c9/6a7645db5d4c76389e77cd103ef3ed77d81e4c | Bin 0 -> 318 bytes .../ca/7355dc497e9729fbaf0c0e3f424b86afef5614 | Bin 0 -> 193 bytes .../d5/29304506d37f544675244c335d85cab5d29966 | Bin 0 -> 317 bytes test/examples/lotr.git/refs/heads/master | 2 +- 19 files changed, 8 insertions(+), 2 deletions(-) create mode 100644 test/examples/lotr.git/objects/0d/c9016ca928c78d5421a99a53b379b53929221e create mode 100644 test/examples/lotr.git/objects/45/3b250f979c7bd6dfb62640c944c982ae6721ee create mode 100644 test/examples/lotr.git/objects/45/f319ee12f2b551b901b22e72602963c366fff1 create mode 100644 test/examples/lotr.git/objects/46/a697caf435815bb07bbce947fc2d58be15f087 create mode 100644 test/examples/lotr.git/objects/4c/45c2b4e297a726c3d3f66886f35373e48fe1c5 create mode 100644 test/examples/lotr.git/objects/6e/48abfc56565574859e081ee58eae655d48cf71 create mode 100644 test/examples/lotr.git/objects/7b/60c5a20a501a70f2317fa0ef763e1e2ce22d6b create mode 100644 test/examples/lotr.git/objects/7d/981cd984ad589e3cf00d8122170c6f7d685979 create mode 100644 test/examples/lotr.git/objects/94/9a9cc3119b9c98817f375e976d2bb5e2a42809 create mode 100644 test/examples/lotr.git/objects/9b/e95b960ac388d4e7db55f610f828e9c31344e6 create mode 100644 test/examples/lotr.git/objects/b0/de6e794dfdc7ef3400e894225bfe23308aae5c create mode 100644 test/examples/lotr.git/objects/b1/6b3d9fad9d78e5a669e7f33d94c96da374eccd create mode 100644 test/examples/lotr.git/objects/c9/6a7645db5d4c76389e77cd103ef3ed77d81e4c create mode 100644 test/examples/lotr.git/objects/ca/7355dc497e9729fbaf0c0e3f424b86afef5614 create mode 100644 test/examples/lotr.git/objects/d5/29304506d37f544675244c335d85cab5d29966 diff --git a/test/examples/lotr.git/config b/test/examples/lotr.git/config index ec3337a4..693bcc71 100644 --- a/test/examples/lotr.git/config +++ b/test/examples/lotr.git/config @@ -1,7 +1,7 @@ [core] repositoryformatversion = 0 filemode = true - bare = false + bare = true logallrefupdates = true ignorecase = true [remote "origin"] diff --git a/test/examples/lotr.git/logs/HEAD b/test/examples/lotr.git/logs/HEAD index 49e8ffa8..6cba614a 100644 --- a/test/examples/lotr.git/logs/HEAD +++ b/test/examples/lotr.git/logs/HEAD @@ -1,3 +1,5 @@ 0000000000000000000000000000000000000000 60f12f4254f58801b9ee7db7bca5fa8aeefaa56b rick 1291341857 -0800 clone: from /Users/rick/p/gollum/test/examples/lotr.git 60f12f4254f58801b9ee7db7bca5fa8aeefaa56b a8ad3c09dd842a3517085bfadd37718856dee813 rick 1291341922 -0800 commit: add sidebars a8ad3c09dd842a3517085bfadd37718856dee813 1db89ebba7e2c14d93b94ff98cfa3708a4f0d4e3 Arran Cudbard-Bell 1309107565 +0200 commit: Test out whitespace with Sam +1db89ebba7e2c14d93b94ff98cfa3708a4f0d4e3 b16b3d9fad9d78e5a669e7f33d94c96da374eccd kristi 1336983525 -0700 push +b16b3d9fad9d78e5a669e7f33d94c96da374eccd b0de6e794dfdc7ef3400e894225bfe23308aae5c kristi 1336984025 -0700 push diff --git a/test/examples/lotr.git/logs/refs/heads/master b/test/examples/lotr.git/logs/refs/heads/master index 49e8ffa8..6cba614a 100644 --- a/test/examples/lotr.git/logs/refs/heads/master +++ b/test/examples/lotr.git/logs/refs/heads/master @@ -1,3 +1,5 @@ 0000000000000000000000000000000000000000 60f12f4254f58801b9ee7db7bca5fa8aeefaa56b rick 1291341857 -0800 clone: from /Users/rick/p/gollum/test/examples/lotr.git 60f12f4254f58801b9ee7db7bca5fa8aeefaa56b a8ad3c09dd842a3517085bfadd37718856dee813 rick 1291341922 -0800 commit: add sidebars a8ad3c09dd842a3517085bfadd37718856dee813 1db89ebba7e2c14d93b94ff98cfa3708a4f0d4e3 Arran Cudbard-Bell 1309107565 +0200 commit: Test out whitespace with Sam +1db89ebba7e2c14d93b94ff98cfa3708a4f0d4e3 b16b3d9fad9d78e5a669e7f33d94c96da374eccd kristi 1336983525 -0700 push +b16b3d9fad9d78e5a669e7f33d94c96da374eccd b0de6e794dfdc7ef3400e894225bfe23308aae5c kristi 1336984025 -0700 push diff --git a/test/examples/lotr.git/objects/0d/c9016ca928c78d5421a99a53b379b53929221e b/test/examples/lotr.git/objects/0d/c9016ca928c78d5421a99a53b379b53929221e new file mode 100644 index 0000000000000000000000000000000000000000..2359d207d8e1390cf630eeacb5c54673e836e1b1 GIT binary patch literal 194 zcmV;z06qVB0V^p=O;s>5HefI`FfcPQQE;tH)%8!)4NfdA%FolwO<|av-TaRCMswBe zra(D|t504(oxQCTsy5y&Kfffk2&8J-^gF2!rlxl9mF{b+c+k=KBG>36OqEA!VhTi+ z+p_7WzL+*fZ>Zk$(*2Ka#6Hmv?J!lrnJKABiG&PGtxVO+DoAH2bXGpdqCCZ6>9MSh wTIp}uSJ*iCLrp5lPs!ISsVHIKx+kY8W|He8ufNT@&HnPi432*;0L1uT2YF!db67`ac%NP!Cv765^Et{jSigD5tv+XNdLiAWo41hqvJwGoc zzlb5vWA&e~u+Wm$c^q<2`_`q#dYmtW8sd?ko2plmT2YdjlgjYx`TJlO1?^pqnyc>! zv++)vesfAH#30}NB9KA6CmC~AY8>wkQCvAIcyr}eOHCy?s6oD!x&cM0$(i}3V0W+D zCjVk?*pEaXuExMyCO<9jy#18{RT-R^Tb@~*s^FfOo1U7gmz$cBnOL5goyo8)a&wt= zlkUw@mn8WM``(M`Ev^=U>WO#D&o4lAD2dV%7 literal 0 HcmV?d00001 diff --git a/test/examples/lotr.git/objects/4c/45c2b4e297a726c3d3f66886f35373e48fe1c5 b/test/examples/lotr.git/objects/4c/45c2b4e297a726c3d3f66886f35373e48fe1c5 new file mode 100644 index 00000000..6372e3c7 --- /dev/null +++ b/test/examples/lotr.git/objects/4c/45c2b4e297a726c3d3f66886f35373e48fe1c5 @@ -0,0 +1,2 @@ +xQ +0)Jm7 xn~=楲mKîUU34̎fYIG&2v6HMI ۭT8 9_7^C* " iZioѰܔT\K \ No newline at end of file diff --git a/test/examples/lotr.git/objects/6e/48abfc56565574859e081ee58eae655d48cf71 b/test/examples/lotr.git/objects/6e/48abfc56565574859e081ee58eae655d48cf71 new file mode 100644 index 0000000000000000000000000000000000000000..fa18740191adee2a1e0394f9b6be0648d81c8f4a GIT binary patch literal 104 zcmV-u0GI!G0V^p=O;s>7HD)k0FfcPQQE9Gh#3_FfcPQQEYF!db67`ac%NP!Cv765^Et{jSigD5tv+XNdLiAXnYCQ6DQ}s$x zD@rnRQW<_de;@3kpuNjcbM+lzHr`3oZ%#=yF#rMu-~6JK{2~V4lZ-hlHIDa&D6X6p zyt#6#rKXY`)F9tV-GHLh_?&xS7YEUlb@D%-u}vfstiudEzc}Y zRd7$tO;1hL%S}zmOf1jL&SY2?xw*``N%v-{OOpJBeecEe7FUZv^~Ag7=a-}wfjs=? zmJ#c|hpq~%wl3doP&|pvdvaehOqEA!VhTi6?F^ZlEo&p@*?iz_R1)XOug!?8gsBS7 POi4{j#Az4+wV{f!10S4k literal 0 HcmV?d00001 diff --git a/test/examples/lotr.git/objects/7d/981cd984ad589e3cf00d8122170c6f7d685979 b/test/examples/lotr.git/objects/7d/981cd984ad589e3cf00d8122170c6f7d685979 new file mode 100644 index 0000000000000000000000000000000000000000..9cf953b12f9fd4be747cff632f05dcaf809552cf GIT binary patch literal 23 fcmbasf+{-Mm0VkCJ3JHfXJ+(eqpI1bz(+3`|*CL$(jfXt#SmuT14lqK`a24f-NaqGBG+QUa9kQNKH9J&N+EDMI%MX5o?X1)C69I zgjEqTi1Z%w+U32sZ8UlMaU%X)ZcA#9sjSOcY5*65(ca6W@=A%_?t6p(4#ky7&YXz* JCcbs8M4kHrM;ZVC literal 0 HcmV?d00001 diff --git a/test/examples/lotr.git/objects/9b/e95b960ac388d4e7db55f610f828e9c31344e6 b/test/examples/lotr.git/objects/9b/e95b960ac388d4e7db55f610f828e9c31344e6 new file mode 100644 index 0000000000000000000000000000000000000000..0ea0af857c49331ca486919617f0c3501deb5d1f GIT binary patch literal 26 icmbal>VvnXLTMiF&NHZ^#A~nV+vRR literal 0 HcmV?d00001 diff --git a/test/examples/lotr.git/objects/b0/de6e794dfdc7ef3400e894225bfe23308aae5c b/test/examples/lotr.git/objects/b0/de6e794dfdc7ef3400e894225bfe23308aae5c new file mode 100644 index 0000000000000000000000000000000000000000..47997d753706b06b9809298a0d2dc8b0167184f7 GIT binary patch literal 169 zcmV;a09OBa0hNwHY6CG00DJZ;^nnDgEXy{OlF$eAk`H)gxi!gl%dXP*H;@3l4?Sh&_ZX< znR|#K1*P0|lIZH)zSa${+t_Wu>yyW(zo*Zoj@wbzGp0hNwn3IZVzM*Hn4yg-YtuA>mqRmPdIm9h=9&fh{O=+_62_u!+gwL0`{ z;V`<0rW6o@UpO!934)7B0En$|Qk*aVM=PGx6T3Wyww!k(X9StadQL7UUrLHp(1D5Q zi(xNL;d`uG*SB6@qw3RdCzj9U+OXay+S*xL=R%6JUxGdwFh=ckzc=LXP$9Ek1zEcK I0ynWmq;B_1K>z>% literal 0 HcmV?d00001 diff --git a/test/examples/lotr.git/objects/c9/6a7645db5d4c76389e77cd103ef3ed77d81e4c b/test/examples/lotr.git/objects/c9/6a7645db5d4c76389e77cd103ef3ed77d81e4c new file mode 100644 index 0000000000000000000000000000000000000000..a6e4854db3900f035e86f6c7ec6fccde0e4bc7cf GIT binary patch literal 318 zcmV-E0m1%w0V^p=O;s>9Gh#3_FfcPQQEYF!db67`ac%NP!Cv765^Et{jSigD5tv+XNdLiAXnYCQ6DQ}s$x zD@rnRQW<_de;@3kpuNjcbM+lzHr`3oZ%#=yF#rMu-~6JK{33?MGK-cU4mzo7xMJrF z(Tfqzn<8I`Kn?P()D0*~P0q|O1v_iiHu)EG!+s?Ca5V`aDbk(5HefI`FfcPQQE;tH)%8!)4NfdA%FolwO<|av-TaRCMswBe zra(D|t504(oxQCTsy5y&Kfffk2&8J-^gF2!rlxl9mF{b+c+k=KBG>36OqEA!VhTi+ z>u1S#LZ7w9Gh#3_FfcPQQEYF!db67`ac%NP!Cv765^Et{jSigD5tv+XNdLiAXnYCQ6DQ}s$x zD@rnRQW<_de;@3kpuNjcbM+lzHr`3oZ%#=yF#rMu-~6JK{33=^#i4gR>!xe|UeCj4 z@8sRK{(YDT)F9tV-GHLh_?&xS7YEUlb@D%-u}vfstiudEzc}Y zRd7$tO;1hL%S}zmOf1jL&SY2?xw*``N%v-{OOpJBeecEe7FWYek9W(@FG(!|dHBsO zBi4NnT@_YsUB26(coLiU Date: Mon, 14 May 2012 02:01:06 -0700 Subject: [PATCH 22/30] add documentation comment --- lib/gollum/markup.rb | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/lib/gollum/markup.rb b/lib/gollum/markup.rb index 28a53d45..ce3003d6 100644 --- a/lib/gollum/markup.rb +++ b/lib/gollum/markup.rb @@ -72,6 +72,11 @@ module Gollum data end + # Inserts header anchors and creates TOC + # + # doc - Nokogiri parsed document + # + # Returns doc Document and toc String def process_headers(doc) toc = nil doc.css('h1,h2,h3,h4,h5,h6').each do |h| From 6191f6002558b0e29bc6d13ad451d5e099db11bd Mon Sep 17 00:00:00 2001 From: kristi Date: Mon, 14 May 2012 02:01:33 -0700 Subject: [PATCH 23/30] Fix tests for added example repo pages --- test/test_committer.rb | 2 +- test/test_git_access.rb | 5 +++-- test/test_page.rb | 21 +++++++++++++++++++++ test/test_wiki.rb | 4 ++-- 4 files changed, 27 insertions(+), 5 deletions(-) diff --git a/test/test_committer.rb b/test/test_committer.rb index 0b65736b..494b12f5 100644 --- a/test/test_committer.rb +++ b/test/test_committer.rb @@ -50,7 +50,7 @@ context "Wiki" do end test "parents with default master ref" do - ref = '1db89ebba7e2c14d93b94ff98cfa3708a4f0d4e3' + ref = 'b0de6e794dfdc7ef3400e894225bfe23308aae5c' committer = Gollum::Committer.new(@wiki) assert_equal ref, committer.parents.first.sha end diff --git a/test/test_git_access.rb b/test/test_git_access.rb index 3f94a3df..3cd8d0ac 100644 --- a/test/test_git_access.rb +++ b/test/test_git_access.rb @@ -18,8 +18,9 @@ context "GitAccess" do assert @access.ref_map.empty? assert @access.tree_map.empty? @access.tree 'master' - assert_equal({"master"=>"1db89ebba7e2c14d93b94ff98cfa3708a4f0d4e3"}, @access.ref_map) + assert_equal({"master"=>"b0de6e794dfdc7ef3400e894225bfe23308aae5c"}, @access.ref_map) + @access.tree '1db89ebba7e2c14d93b94ff98cfa3708a4f0d4e3' map = @access.tree_map['1db89ebba7e2c14d93b94ff98cfa3708a4f0d4e3'] assert_equal 'Bilbo-Baggins.md', map[0].path assert_equal '', map[0].dir @@ -49,4 +50,4 @@ context "GitAccess" do test "cannot access tree from invalid ref" do assert_equal [], @access.tree('foo') end -end \ No newline at end of file +end diff --git a/test/test_page.rb b/test/test_page.rb index c81b1187..020dc106 100644 --- a/test/test_page.rb +++ b/test/test_page.rb @@ -114,6 +114,25 @@ context "Page" do assert_equal "Eye Of Sauron", page.title end + test "top level header" do + header = @wiki.page('Home').header + assert_equal "Hobbits\n", header.raw_data + assert_equal "_Header.md", header.path + end + + test "nested header" do + header = @wiki.page('Eye Of Sauron').header + assert_equal "Sauron\n", header.raw_data + assert_equal "Mordor/_Header.md", header.path + end + + test "header itself" do + header = @wiki.page("_Header") + assert_nil header.header + assert_nil header.footer + assert_nil header.sidebar + end + test "top level footer" do footer = @wiki.page('Home').footer assert_equal 'Lord of the Rings wiki', footer.raw_data @@ -128,6 +147,7 @@ context "Page" do test "footer itself" do footer = @wiki.page("_Footer") + assert_nil footer.header assert_nil footer.footer assert_nil footer.sidebar end @@ -146,6 +166,7 @@ context "Page" do test "sidebar itself" do sidebar = @wiki.page("_Sidebar") + assert_nil sidebar.header assert_nil sidebar.footer assert_nil sidebar.sidebar end diff --git a/test/test_wiki.rb b/test/test_wiki.rb index 3ec25a04..c3d18e5b 100644 --- a/test/test_wiki.rb +++ b/test/test_wiki.rb @@ -54,12 +54,12 @@ context "Wiki" do test "list pages" do pages = @wiki.pages assert_equal \ - ['Bilbo-Baggins.md', 'Eye-Of-Sauron.md', 'Home.textile', 'My-Precious.md', 'Samwise Gamgee.mediawiki'], + ['Bilbo-Baggins.md', 'Boromir.md', 'Eye-Of-Sauron.md', 'Home.textile', 'My-Precious.md', 'Samwise Gamgee.mediawiki'], pages.map { |p| p.filename }.sort end test "counts pages" do - assert_equal 5, @wiki.size + assert_equal 6, @wiki.size end test "text_data" do From be93fa747b07d7b8c205d31ad1b546da81a4d028 Mon Sep 17 00:00:00 2001 From: kristi Date: Mon, 14 May 2012 10:23:12 -0700 Subject: [PATCH 24/30] Make TOC pretty. Also put in "[[_TOC_]]" stub for viewing sub-page directly --- .../frontend/public/gollum/css/template.css | 29 +++++++++++++++++++ lib/gollum/markup.rb | 8 ++--- 2 files changed, 33 insertions(+), 4 deletions(-) diff --git a/lib/gollum/frontend/public/gollum/css/template.css b/lib/gollum/frontend/public/gollum/css/template.css index f8f24566..93c71205 100644 --- a/lib/gollum/frontend/public/gollum/css/template.css +++ b/lib/gollum/frontend/public/gollum/css/template.css @@ -367,6 +367,35 @@ a.absent { margin: 0; padding: 0; } +.markdown-body .toc { + border: 1px solid #ddd; + padding: 5px 10px; + margin: 0; + border-radius: 3px; +} +.markdown-body .toc-title { + color: #888; + padding: 2px; + border-bottom: 1px solid #ddd; + margin-bottom: 3px; +} +.markdown-body .toc ul { + padding-left: 10px; + margin: 0; +} +.markdown-body .toc>ul { + margin-left: 10px; + font-size: 17px; +} +.markdown-body .toc ul ul { + font-size: 15px; +} +.markdown-body .toc ul ul ul { + font-size: 14px; +} +.markdown-body .toc ul li{ + margin: 0; +} .highlight { background: #fff; } diff --git a/lib/gollum/markup.rb b/lib/gollum/markup.rb index f07f070b..bcc58906 100644 --- a/lib/gollum/markup.rb +++ b/lib/gollum/markup.rb @@ -61,7 +61,7 @@ module Gollum doc = Nokogiri::HTML::DocumentFragment.parse(data) doc = sanitize.clean_node!(doc) if sanitize doc,toc = process_headers(doc) - @toc = @sub_page ? @parent_page.toc_data : toc + @toc = @sub_page ? ( @parent_page ? @parent_page.toc_data : "[[_TOC_]]" ) : toc yield doc if block_given? data = doc.to_html @@ -91,9 +91,9 @@ module Gollum h.add_child(anchor) # Build TOC - toc ||= Nokogiri::XML::Node.new('ul', doc) - tail ||= toc - tail_level ||= 1 + toc ||= Nokogiri::XML::DocumentFragment.parse('
Table of Contents
') + tail ||= toc.child + tail_level ||= 0 while tail_level < level node = Nokogiri::XML::Node.new('ul', doc) From a3a946ccd66661a132cc9bdc8f5f017edfc21fe5 Mon Sep 17 00:00:00 2001 From: kristi Date: Mon, 14 May 2012 13:06:46 -0700 Subject: [PATCH 25/30] Remove toc.rb; markup.rb handles toc processing --- lib/gollum.rb | 1 - lib/gollum/toc.rb | 118 ---------------------------------------------- 2 files changed, 119 deletions(-) delete mode 100644 lib/gollum/toc.rb diff --git a/lib/gollum.rb b/lib/gollum.rb index d1b98c75..5cc1e40f 100644 --- a/lib/gollum.rb +++ b/lib/gollum.rb @@ -14,7 +14,6 @@ require File.expand_path('../gollum/pagination', __FILE__) require File.expand_path('../gollum/blob_entry', __FILE__) require File.expand_path('../gollum/wiki', __FILE__) require File.expand_path('../gollum/page', __FILE__) -require File.expand_path('../gollum/toc', __FILE__) require File.expand_path('../gollum/file', __FILE__) require File.expand_path('../gollum/markup', __FILE__) require File.expand_path('../gollum/sanitization', __FILE__) diff --git a/lib/gollum/toc.rb b/lib/gollum/toc.rb deleted file mode 100644 index 0b748377..00000000 --- a/lib/gollum/toc.rb +++ /dev/null @@ -1,118 +0,0 @@ -module Gollum - class Toc - attr_accessor :header_tags - - NODE_CONTENT = 0 - NODE_ORDER = 1 - - def initialize (doc, settings = {}) - @doc = doc - @header_tags = ['title','h1','h2','h3','h4','h5','h6'] - end - - # Generates a table of contents for @doc using headers - # - # Returns Nokogiri::XML::Node if there were headers to parse, or nil if none were found - def generate - return unless (headings = find_headings).count > 0 - - node_count = 0 - lvl = 0 - @lvls = [].fill(0..@header_tags.count) {[]} - - headings.each do |h| - node_count += 1 - lvl_new = heading_to_lvl h - - @lvls[lvl_new].push [build_toc_node(h), node_count] - - # Pass in the highest level prior to flattening for efficiency - flatten_to_lvl(lvl, lvl_new) if lvl_new < lvl - - lvl = lvl_new - end - - flatten_to_lvl(lvl, 0) - end - - # Escape title string for use in ID attribute - # - # title - Title string - # - # Returns string - def anchor_id (title) - CGI::escape(title.gsub(' ','-')) - end - - # Convert heading into list element - # - # heading - Nokogiri::XML::Node representing a single heading - # - # Returns string - def build_toc_node(heading) - xml_node = Nokogiri::XML::Node.new('li', @doc) - xml_node.add_child("" + heading.content + "") - xml_node - end - - # Search the current @doc for headings - # - # Returns Nokogiri::XML::NodeSet - def find_headings - @doc.css(@header_tags.join ' ,') - end - - # Convert specified heading to integer level - # - # heading - Nokogiri::XML::Node representing a single heading - # - # Returns int - def heading_to_lvl(heading) - heading.name.gsub('h','').to_i - end - - # Convert Nokogiri::XML:Nodes higher in the level array than the specified low_idx - # into a node tree, and either append or prepend the tree to the level specified - # by low_idx. - # - # low_idx - The level in the array to flatten to - # high - The highest level to flatten from - # - # Returns Nokogiri::XML::Nodes if low_idx is 0, else nil - def flatten_to_lvl(high_idx, low_idx = 0) - lvl = high_idx + 1 - lvl_up = nil - - @lvls[low_idx..high_idx].reverse_each do |lvl_children| - lvl -= 1 - next if lvl_children.count() == 0 || !lvl_up && (lvl_up = lvl) - - flatten_lvl(lvl_up,lvl) - lvl_up = lvl - end - - # Level 0 flattens all levels, and returns an XML node containing the TOC data - flatten_lvl(lvl_up, 0).first[NODE_CONTENT] if lvl == 0 && lvl_up - end - - # Insert all Nokogiri::XML::Nodes at lvl_src into a new ul XML::Node as children. - # Then either append or prepend the ul node, depending on whether the first child - # at the src_level appeared before or after the node in the dst_level in @doc - # - # lvl_src - The level in the array to src li XML::Nodes from - # lvl_dst - The level in the array to insert resulting ul XML::Node - # - # Returns array of Nokogiri::XML::Nodes @ lvl_dst - def flatten_lvl(lvl_src, lvl_dst) - lvl_sib = Nokogiri::XML::Node.new('ul', @doc) - src_pos = @lvls[lvl_src].first[NODE_ORDER] - @lvls[lvl_src].each {|lvl_child| lvl_sib.add_child(lvl_child[NODE_CONTENT])} - @lvls[lvl_src] = [] - - lvl_dst > 0 && src_pos < @lvls[lvl_dst].last[NODE_ORDER] ? - @lvls[lvl_dst].insert(-2,[lvl_sib, src_pos]) : - @lvls[lvl_dst].push([lvl_sib, src_pos]) - @lvls[lvl_dst] - end - end -end From c9203047fcaf18c9269e8e767680dd2ea04882ee Mon Sep 17 00:00:00 2001 From: kristi Date: Mon, 14 May 2012 13:07:57 -0700 Subject: [PATCH 26/30] Make universal toc pretty too --- .../frontend/public/gollum/css/gollum.css | 26 +++---------------- .../frontend/public/gollum/css/template.css | 22 +++++++++++----- lib/gollum/frontend/templates/page.mustache | 3 +-- 3 files changed, 20 insertions(+), 31 deletions(-) diff --git a/lib/gollum/frontend/public/gollum/css/gollum.css b/lib/gollum/frontend/public/gollum/css/gollum.css index 57fe3b95..687b6ffd 100755 --- a/lib/gollum/frontend/public/gollum/css/gollum.css +++ b/lib/gollum/frontend/public/gollum/css/gollum.css @@ -90,35 +90,17 @@ a:hover, a:visited { background-color: #F7F7F7; border: 1px solid #DDD; font-size: 13px; - padding: 7px; + padding: 0px 5px; float:left; margin-bottom: 20px; + min-width: 33%; border-radius: 0.5em; -moz-border-radius: 0.5em; -webkit-border-radius: 0.5em; } - -#wiki-toc-main > h2 { - font-size: 24px; - border-bottom: 1px solid #CCC; - color: black; - margin-top: 5px; - margin-bottom: 20px; -} - -#wiki-toc-main ul { - -webkit-margin-before: 0px; - -webkit-padding-start: 0px; - margin-left: 1em; - margin-right: 1em; - padding-left: 0; -} - -#wiki-toc-main ul li { - line-height: 1.75em; - list-style-position: inside; - list-style-type: round; +#wiki-toc-main > div { + border: none; } /* @section rightbar */ diff --git a/lib/gollum/frontend/public/gollum/css/template.css b/lib/gollum/frontend/public/gollum/css/template.css index 93c71205..01ca88e2 100644 --- a/lib/gollum/frontend/public/gollum/css/template.css +++ b/lib/gollum/frontend/public/gollum/css/template.css @@ -367,35 +367,43 @@ a.absent { margin: 0; padding: 0; } -.markdown-body .toc { +.toc { + background-color: #F7F7F7; border: 1px solid #ddd; padding: 5px 10px; margin: 0; border-radius: 3px; } -.markdown-body .toc-title { +.toc-title { color: #888; + font-size: 14px; + line-height: 1.6; padding: 2px; border-bottom: 1px solid #ddd; margin-bottom: 3px; } -.markdown-body .toc ul { +.toc ul { padding-left: 10px; margin: 0; } -.markdown-body .toc>ul { +.toc>ul { margin-left: 10px; font-size: 17px; } -.markdown-body .toc ul ul { +.toc ul ul { font-size: 15px; } -.markdown-body .toc ul ul ul { +.toc ul ul ul { font-size: 14px; } -.markdown-body .toc ul li{ +.toc ul li{ margin: 0; } +#header-content .toc, +#footer-content .toc, +#sidebar-content .toc { + border: none; +} .highlight { background: #fff; } diff --git a/lib/gollum/frontend/templates/page.mustache b/lib/gollum/frontend/templates/page.mustache index cac436e5..eb59fe2a 100644 --- a/lib/gollum/frontend/templates/page.mustache +++ b/lib/gollum/frontend/templates/page.mustache @@ -20,8 +20,7 @@
{{#has_toc}} -
-

Table of contents

+
{{{toc_content}}}
{{/has_toc}} From 342e1e22f8df41964be040fd564a1b29d2fecae3 Mon Sep 17 00:00:00 2001 From: kristi Date: Mon, 14 May 2012 15:54:46 -0700 Subject: [PATCH 27/30] Change link icon --- .../frontend/public/gollum/css/template.css | 2 +- .../frontend/public/gollum/images/pin-16.png | Bin 0 -> 2976 bytes .../frontend/public/gollum/images/pin-20.png | Bin 0 -> 3039 bytes .../frontend/public/gollum/images/pin-24.png | Bin 0 -> 3080 bytes .../frontend/public/gollum/images/pin-32.png | Bin 0 -> 3159 bytes 5 files changed, 1 insertion(+), 1 deletion(-) create mode 100644 lib/gollum/frontend/public/gollum/images/pin-16.png create mode 100644 lib/gollum/frontend/public/gollum/images/pin-20.png create mode 100644 lib/gollum/frontend/public/gollum/images/pin-24.png create mode 100644 lib/gollum/frontend/public/gollum/images/pin-32.png diff --git a/lib/gollum/frontend/public/gollum/css/template.css b/lib/gollum/frontend/public/gollum/css/template.css index 01ca88e2..c9ea382b 100644 --- a/lib/gollum/frontend/public/gollum/css/template.css +++ b/lib/gollum/frontend/public/gollum/css/template.css @@ -77,7 +77,7 @@ a.absent { .markdown-body h4:hover a.anchor, .markdown-body h5:hover a.anchor, .markdown-body h6:hover a.anchor { - background: url('/images/para.png') no-repeat center center; + background: url('/images/pin-20.png') no-repeat left center; text-decoration: none; } .markdown-body h1 tt, diff --git a/lib/gollum/frontend/public/gollum/images/pin-16.png b/lib/gollum/frontend/public/gollum/images/pin-16.png new file mode 100644 index 0000000000000000000000000000000000000000..fc5a5f50ace4a0bcacfffb53fde8d35d5f13c817 GIT binary patch literal 2976 zcmV;R3t#k!P)KLZ*U+IBfRsybQWXdwQbLP>6pAqfylh#{fb6;Z(vMMVS~$e@S=j*ftg6;Uhf59&ghTmgWD0l;*T zI709Y^p6lP1rIRMx#05C~cW=H_Aw*bJ-5DT&Z2n+x)QHX^p z00esgV8|mQcmRZ%02D^@S3L16t`O%c004NIvOKvYIYoh62rY33S640`D9%Y2D-rV&neh&#Q1i z007~1e$oCcFS8neI|hJl{-P!B1ZZ9hpmq0)X0i`JwE&>$+E?>%_LC6RbVIkUx0b+_+BaR3cnT7Zv!AJxW zizFb)h!jyGOOZ85F;a?DAXP{m@;!0_IfqH8(HlgRxt7s3}k3K`kFu>>-2Q$QMFfPW!La{h336o>X zu_CMttHv6zR;&ZNiS=X8v3CR#fknUxHUxJ0uoBa_M6WNWeqIg~6QE69c9o#eyhGvpiOA@W-aonk<7r1(?fC{oI5N*U!4 zfg=2N-7=cNnjjOr{yriy6mMFgG#l znCF=fnQv8CDz++o6_Lscl}eQ+l^ZHARH>?_s@|##Rr6KLRFA1%Q+=*RRWnoLsR`7U zt5vFIcfW3@?wFpwUVxrVZ>QdQz32KIeJ}k~{cZZE^+ya? z2D1z#2HOnI7(B%_ac?{wFUQ;QQA1tBKtrWrm0_3Rgps+?Jfqb{jYbcQX~taRB;#$y zZN{S}1|}gUOHJxc?wV3fxuz+mJ4`!F$IZ;mqRrNsHJd##*D~ju=bP7?-?v~|cv>vB zsJ6IeNwVZxrdjT`yl#bBIa#GxRa#xMMy;K#CDyyGyQdMSxlWT#tDe?p!?5wT$+oGt z8L;Kp2HUQ-ZMJ=3XJQv;x5ci*?vuTfeY$;({XGW_huIFR9a(?@3)XSs8O^N5RyOM=TTmp(3=8^+zpz2r)C z^>JO{deZfso3oq3?Wo(Y?l$ge?uXo;%ru`Vo>?<<(8I_>;8Eq#KMS9gFl*neeosSB zfoHYnBQIkwkyowPu(zdms`p{<7e4kra-ZWq<2*OsGTvEV%s0Td$hXT+!*8Bnh2KMe zBmZRodjHV?r+_5^X9J0WL4jKW`}lf%A-|44I@@LTvf1rHjG(ze6+w@Jt%Bvjts!X0 z?2xS?_ve_-kiKB_KiJlZ$9G`c^=E@oNG)mWWaNo-3TIW8)$Hg0Ub-~8?KhvJ>$ z3*&nim@mj(aCxE5!t{lw7O5^0EIO7zOo&c6l<+|iDySBWCGrz@C5{St!X3hAA}`T4 z(TLbXTq+(;@<=L8dXnssyft|w#WSTW<++3>sgS%(4NTpeI-VAqb|7ssJvzNHgOZVu zaYCvgO_R1~>SyL=cFU|~g|hy|Zi}}s9+d~lYqOB71z9Z$wnC=pR9Yz4DhIM>Wmjgu z&56o6maCpC&F##y%G;1PobR9i?GnNg;gYtchD%p19a!eQtZF&3JaKv33gZ<8D~47E ztUS1iwkmDaPpj=$m#%)jCVEY4fnLGNg2A-`YwHVD3gv};>)hAvT~AmqS>Lr``i7kw zJ{5_It`yrBmlc25DBO7E8;5VoznR>Ww5hAaxn$2~(q`%A-YuS64wkBy=9dm`4cXeX z4c}I@?e+FW+b@^RDBHV(wnMq2zdX3SWv9u`%{xC-q*U}&`cyXV(%rRT*Z6MH?i+i& z_B8C(+grT%{XWUQ+f@NoP1R=AW&26{v-dx)iK^-Nmiuj8txj!m?Z*Ss1N{dh4z}01 z)YTo*JycSU)+_5r4#yw9{+;i4Ee$peRgIj+;v;ZGdF1K$3E%e~4LaI(jC-u%2h$&R z9cLXcYC@Xwnns&bn)_Q~Te?roKGD|d-g^8;+aC{{G(1^(O7m37Y1-+6)01cN&y1aw zoqc{T`P^XJqPBbIW6s}d4{z_f5Om?vMgNQEJG?v2T=KYd^0M3I6IZxbny)%vZR&LD zJpPl@Psh8QyPB@KTx+@RdcC!KX7}kEo;S|j^u2lU7XQ}Oo;f|;z4Ll+_r>@1-xl3| zawq-H%e&ckC+@AhPrP6BKT#_XdT7&;F71j}Joy zkC~6lh7E@6o;W@^IpRNZ{ptLtL(gQ-CY~4mqW;US7Zxvm_|@yz&e53Bp_lTPlfP|z zrTyx_>lv@x#=^!PzR7qqF<$gm`|ZJZ+;<)Cqu&ot2z=0000WV@Og>004R=004l4008;_004mL004C`008P>0026e000+nl3&F} z0002XNklt09^A*EES`h}Ma{AD66u^Ir3F)eve3t8p*AOPNLnuh>w zp?P2O=NRAvpFQQKWb)_;V29Ui*s|lz;ia}%m;ORc+~67Gi1-&kUaDC{{4CNb@jU?X WBRd$W6|8Ci0000KLZ*U+IBfRsybQWXdwQbLP>6pAqfylh#{fb6;Z(vMMVS~$e@S=j*ftg6;Uhf59&ghTmgWD0l;*T zI709Y^p6lP1rIRMx#05C~cW=H_Aw*bJ-5DT&Z2n+x)QHX^p z00esgV8|mQcmRZ%02D^@S3L16t`O%c004NIvOKvYIYoh62rY33S640`D9%Y2D-rV&neh&#Q1i z007~1e$oCcFS8neI|hJl{-P!B1ZZ9hpmq0)X0i`JwE&>$+E?>%_LC6RbVIkUx0b+_+BaR3cnT7Zv!AJxW zizFb)h!jyGOOZ85F;a?DAXP{m@;!0_IfqH8(HlgRxt7s3}k3K`kFu>>-2Q$QMFfPW!La{h336o>X zu_CMttHv6zR;&ZNiS=X8v3CR#fknUxHUxJ0uoBa_M6WNWeqIg~6QE69c9o#eyhGvpiOA@W-aonk<7r1(?fC{oI5N*U!4 zfg=2N-7=cNnjjOr{yriy6mMFgG#l znCF=fnQv8CDz++o6_Lscl}eQ+l^ZHARH>?_s@|##Rr6KLRFA1%Q+=*RRWnoLsR`7U zt5vFIcfW3@?wFpwUVxrVZ>QdQz32KIeJ}k~{cZZE^+ya? z2D1z#2HOnI7(B%_ac?{wFUQ;QQA1tBKtrWrm0_3Rgps+?Jfqb{jYbcQX~taRB;#$y zZN{S}1|}gUOHJxc?wV3fxuz+mJ4`!F$IZ;mqRrNsHJd##*D~ju=bP7?-?v~|cv>vB zsJ6IeNwVZxrdjT`yl#bBIa#GxRa#xMMy;K#CDyyGyQdMSxlWT#tDe?p!?5wT$+oGt z8L;Kp2HUQ-ZMJ=3XJQv;x5ci*?vuTfeY$;({XGW_huIFR9a(?@3)XSs8O^N5RyOM=TTmp(3=8^+zpz2r)C z^>JO{deZfso3oq3?Wo(Y?l$ge?uXo;%ru`Vo>?<<(8I_>;8Eq#KMS9gFl*neeosSB zfoHYnBQIkwkyowPu(zdms`p{<7e4kra-ZWq<2*OsGTvEV%s0Td$hXT+!*8Bnh2KMe zBmZRodjHV?r+_5^X9J0WL4jKW`}lf%A-|44I@@LTvf1rHjG(ze6+w@Jt%Bvjts!X0 z?2xS?_ve_-kiKB_KiJlZ$9G`c^=E@oNG)mWWaNo-3TIW8)$Hg0Ub-~8?KhvJ>$ z3*&nim@mj(aCxE5!t{lw7O5^0EIO7zOo&c6l<+|iDySBWCGrz@C5{St!X3hAA}`T4 z(TLbXTq+(;@<=L8dXnssyft|w#WSTW<++3>sgS%(4NTpeI-VAqb|7ssJvzNHgOZVu zaYCvgO_R1~>SyL=cFU|~g|hy|Zi}}s9+d~lYqOB71z9Z$wnC=pR9Yz4DhIM>Wmjgu z&56o6maCpC&F##y%G;1PobR9i?GnNg;gYtchD%p19a!eQtZF&3JaKv33gZ<8D~47E ztUS1iwkmDaPpj=$m#%)jCVEY4fnLGNg2A-`YwHVD3gv};>)hAvT~AmqS>Lr``i7kw zJ{5_It`yrBmlc25DBO7E8;5VoznR>Ww5hAaxn$2~(q`%A-YuS64wkBy=9dm`4cXeX z4c}I@?e+FW+b@^RDBHV(wnMq2zdX3SWv9u`%{xC-q*U}&`cyXV(%rRT*Z6MH?i+i& z_B8C(+grT%{XWUQ+f@NoP1R=AW&26{v-dx)iK^-Nmiuj8txj!m?Z*Ss1N{dh4z}01 z)YTo*JycSU)+_5r4#yw9{+;i4Ee$peRgIj+;v;ZGdF1K$3E%e~4LaI(jC-u%2h$&R z9cLXcYC@Xwnns&bn)_Q~Te?roKGD|d-g^8;+aC{{G(1^(O7m37Y1-+6)01cN&y1aw zoqc{T`P^XJqPBbIW6s}d4{z_f5Om?vMgNQEJG?v2T=KYd^0M3I6IZxbny)%vZR&LD zJpPl@Psh8QyPB@KTx+@RdcC!KX7}kEo;S|j^u2lU7XQ}Oo;f|;z4Ll+_r>@1-xl3| zawq-H%e&ckC+@AhPrP6BKT#_XdT7&;F71j}Joy zkC~6lh7E@6o;W@^IpRNZ{ptLtL(gQ-CY~4mqW;US7Zxvm_|@yz&e53Bp_lTPlfP|z zrTyx_>lv@x#=^!PzR7qqF<$gm`|ZJZ+;<)Cqu&ot2z=0000WV@Og>004R=004l4008;_004mL004C`008P>0026e000+nl3&F} z0003BNklKeurN+WW zyg`H@V>2tmGP|3V{JQyi|KC%D5Uf-g;2I8bhCyG}dTnnD6O7~f9WQ;LsRx_5N?0FSVrIp2te%D%vzmOH(mMF>Gr6ayS!8z(UZbuI85jn8AT9`Tb_ zxdNsSOI$QS>-xkEzAIp^&t|wyEw|{cg5}z#FZ2QTZGD)7PW!+tFKLZ*U+IBfRsybQWXdwQbLP>6pAqfylh#{fb6;Z(vMMVS~$e@S=j*ftg6;Uhf59&ghTmgWD0l;*T zI709Y^p6lP1rIRMx#05C~cW=H_Aw*bJ-5DT&Z2n+x)QHX^p z00esgV8|mQcmRZ%02D^@S3L16t`O%c004NIvOKvYIYoh62rY33S640`D9%Y2D-rV&neh&#Q1i z007~1e$oCcFS8neI|hJl{-P!B1ZZ9hpmq0)X0i`JwE&>$+E?>%_LC6RbVIkUx0b+_+BaR3cnT7Zv!AJxW zizFb)h!jyGOOZ85F;a?DAXP{m@;!0_IfqH8(HlgRxt7s3}k3K`kFu>>-2Q$QMFfPW!La{h336o>X zu_CMttHv6zR;&ZNiS=X8v3CR#fknUxHUxJ0uoBa_M6WNWeqIg~6QE69c9o#eyhGvpiOA@W-aonk<7r1(?fC{oI5N*U!4 zfg=2N-7=cNnjjOr{yriy6mMFgG#l znCF=fnQv8CDz++o6_Lscl}eQ+l^ZHARH>?_s@|##Rr6KLRFA1%Q+=*RRWnoLsR`7U zt5vFIcfW3@?wFpwUVxrVZ>QdQz32KIeJ}k~{cZZE^+ya? z2D1z#2HOnI7(B%_ac?{wFUQ;QQA1tBKtrWrm0_3Rgps+?Jfqb{jYbcQX~taRB;#$y zZN{S}1|}gUOHJxc?wV3fxuz+mJ4`!F$IZ;mqRrNsHJd##*D~ju=bP7?-?v~|cv>vB zsJ6IeNwVZxrdjT`yl#bBIa#GxRa#xMMy;K#CDyyGyQdMSxlWT#tDe?p!?5wT$+oGt z8L;Kp2HUQ-ZMJ=3XJQv;x5ci*?vuTfeY$;({XGW_huIFR9a(?@3)XSs8O^N5RyOM=TTmp(3=8^+zpz2r)C z^>JO{deZfso3oq3?Wo(Y?l$ge?uXo;%ru`Vo>?<<(8I_>;8Eq#KMS9gFl*neeosSB zfoHYnBQIkwkyowPu(zdms`p{<7e4kra-ZWq<2*OsGTvEV%s0Td$hXT+!*8Bnh2KMe zBmZRodjHV?r+_5^X9J0WL4jKW`}lf%A-|44I@@LTvf1rHjG(ze6+w@Jt%Bvjts!X0 z?2xS?_ve_-kiKB_KiJlZ$9G`c^=E@oNG)mWWaNo-3TIW8)$Hg0Ub-~8?KhvJ>$ z3*&nim@mj(aCxE5!t{lw7O5^0EIO7zOo&c6l<+|iDySBWCGrz@C5{St!X3hAA}`T4 z(TLbXTq+(;@<=L8dXnssyft|w#WSTW<++3>sgS%(4NTpeI-VAqb|7ssJvzNHgOZVu zaYCvgO_R1~>SyL=cFU|~g|hy|Zi}}s9+d~lYqOB71z9Z$wnC=pR9Yz4DhIM>Wmjgu z&56o6maCpC&F##y%G;1PobR9i?GnNg;gYtchD%p19a!eQtZF&3JaKv33gZ<8D~47E ztUS1iwkmDaPpj=$m#%)jCVEY4fnLGNg2A-`YwHVD3gv};>)hAvT~AmqS>Lr``i7kw zJ{5_It`yrBmlc25DBO7E8;5VoznR>Ww5hAaxn$2~(q`%A-YuS64wkBy=9dm`4cXeX z4c}I@?e+FW+b@^RDBHV(wnMq2zdX3SWv9u`%{xC-q*U}&`cyXV(%rRT*Z6MH?i+i& z_B8C(+grT%{XWUQ+f@NoP1R=AW&26{v-dx)iK^-Nmiuj8txj!m?Z*Ss1N{dh4z}01 z)YTo*JycSU)+_5r4#yw9{+;i4Ee$peRgIj+;v;ZGdF1K$3E%e~4LaI(jC-u%2h$&R z9cLXcYC@Xwnns&bn)_Q~Te?roKGD|d-g^8;+aC{{G(1^(O7m37Y1-+6)01cN&y1aw zoqc{T`P^XJqPBbIW6s}d4{z_f5Om?vMgNQEJG?v2T=KYd^0M3I6IZxbny)%vZR&LD zJpPl@Psh8QyPB@KTx+@RdcC!KX7}kEo;S|j^u2lU7XQ}Oo;f|;z4Ll+_r>@1-xl3| zawq-H%e&ckC+@AhPrP6BKT#_XdT7&;F71j}Joy zkC~6lh7E@6o;W@^IpRNZ{ptLtL(gQ-CY~4mqW;US7Zxvm_|@yz&e53Bp_lTPlfP|z zrTyx_>lv@x#=^!PzR7qqF<$gm`|ZJZ+;<)Cqu&ot2z=0000WV@Og>004R=004l4008;_004mL004C`008P>0026e000+nl3&F} z0003qNkln*rf@3 z0dHWXh=Pq5$k@CILzsC^CfUDPmR;UA^S}Si7;7!9N&)nMQ($M4+MUR^GhhgmzyNs3 zg@gcCz=ijIyop1_Kg9v|fO;E%^FVQ@NiL-D8hWk#*9E3I5C=GshH9#FAjVpYF{T18 zfg@S1reEMuKt13S_=?5U0aoo;*Yj^+2E3&Jvh4uwfp;HJC^kIEGgXaWJT?cpkOr8i z3|a{Clv_Ln0I;81JQc936n_QAS{PCQKg!BSz@e776u^h%JY>tW^eGza6u?4;Xc6$- zPg)J!tR6YBK?`XR%DFd~w?JPO&@6AuE#AqcoM(5yK^p+4zBIpV3*dHBEf2dk^)~>D WgJ(SB3M>Nv0000KLZ*U+IBfRsybQWXdwQbLP>6pAqfylh#{fb6;Z(vMMVS~$e@S=j*ftg6;Uhf59&ghTmgWD0l;*T zI709Y^p6lP1rIRMx#05C~cW=H_Aw*bJ-5DT&Z2n+x)QHX^p z00esgV8|mQcmRZ%02D^@S3L16t`O%c004NIvOKvYIYoh62rY33S640`D9%Y2D-rV&neh&#Q1i z007~1e$oCcFS8neI|hJl{-P!B1ZZ9hpmq0)X0i`JwE&>$+E?>%_LC6RbVIkUx0b+_+BaR3cnT7Zv!AJxW zizFb)h!jyGOOZ85F;a?DAXP{m@;!0_IfqH8(HlgRxt7s3}k3K`kFu>>-2Q$QMFfPW!La{h336o>X zu_CMttHv6zR;&ZNiS=X8v3CR#fknUxHUxJ0uoBa_M6WNWeqIg~6QE69c9o#eyhGvpiOA@W-aonk<7r1(?fC{oI5N*U!4 zfg=2N-7=cNnjjOr{yriy6mMFgG#l znCF=fnQv8CDz++o6_Lscl}eQ+l^ZHARH>?_s@|##Rr6KLRFA1%Q+=*RRWnoLsR`7U zt5vFIcfW3@?wFpwUVxrVZ>QdQz32KIeJ}k~{cZZE^+ya? z2D1z#2HOnI7(B%_ac?{wFUQ;QQA1tBKtrWrm0_3Rgps+?Jfqb{jYbcQX~taRB;#$y zZN{S}1|}gUOHJxc?wV3fxuz+mJ4`!F$IZ;mqRrNsHJd##*D~ju=bP7?-?v~|cv>vB zsJ6IeNwVZxrdjT`yl#bBIa#GxRa#xMMy;K#CDyyGyQdMSxlWT#tDe?p!?5wT$+oGt z8L;Kp2HUQ-ZMJ=3XJQv;x5ci*?vuTfeY$;({XGW_huIFR9a(?@3)XSs8O^N5RyOM=TTmp(3=8^+zpz2r)C z^>JO{deZfso3oq3?Wo(Y?l$ge?uXo;%ru`Vo>?<<(8I_>;8Eq#KMS9gFl*neeosSB zfoHYnBQIkwkyowPu(zdms`p{<7e4kra-ZWq<2*OsGTvEV%s0Td$hXT+!*8Bnh2KMe zBmZRodjHV?r+_5^X9J0WL4jKW`}lf%A-|44I@@LTvf1rHjG(ze6+w@Jt%Bvjts!X0 z?2xS?_ve_-kiKB_KiJlZ$9G`c^=E@oNG)mWWaNo-3TIW8)$Hg0Ub-~8?KhvJ>$ z3*&nim@mj(aCxE5!t{lw7O5^0EIO7zOo&c6l<+|iDySBWCGrz@C5{St!X3hAA}`T4 z(TLbXTq+(;@<=L8dXnssyft|w#WSTW<++3>sgS%(4NTpeI-VAqb|7ssJvzNHgOZVu zaYCvgO_R1~>SyL=cFU|~g|hy|Zi}}s9+d~lYqOB71z9Z$wnC=pR9Yz4DhIM>Wmjgu z&56o6maCpC&F##y%G;1PobR9i?GnNg;gYtchD%p19a!eQtZF&3JaKv33gZ<8D~47E ztUS1iwkmDaPpj=$m#%)jCVEY4fnLGNg2A-`YwHVD3gv};>)hAvT~AmqS>Lr``i7kw zJ{5_It`yrBmlc25DBO7E8;5VoznR>Ww5hAaxn$2~(q`%A-YuS64wkBy=9dm`4cXeX z4c}I@?e+FW+b@^RDBHV(wnMq2zdX3SWv9u`%{xC-q*U}&`cyXV(%rRT*Z6MH?i+i& z_B8C(+grT%{XWUQ+f@NoP1R=AW&26{v-dx)iK^-Nmiuj8txj!m?Z*Ss1N{dh4z}01 z)YTo*JycSU)+_5r4#yw9{+;i4Ee$peRgIj+;v;ZGdF1K$3E%e~4LaI(jC-u%2h$&R z9cLXcYC@Xwnns&bn)_Q~Te?roKGD|d-g^8;+aC{{G(1^(O7m37Y1-+6)01cN&y1aw zoqc{T`P^XJqPBbIW6s}d4{z_f5Om?vMgNQEJG?v2T=KYd^0M3I6IZxbny)%vZR&LD zJpPl@Psh8QyPB@KTx+@RdcC!KX7}kEo;S|j^u2lU7XQ}Oo;f|;z4Ll+_r>@1-xl3| zawq-H%e&ckC+@AhPrP6BKT#_XdT7&;F71j}Joy zkC~6lh7E@6o;W@^IpRNZ{ptLtL(gQ-CY~4mqW;US7Zxvm_|@yz&e53Bp_lTPlfP|z zrTyx_>lv@x#=^!PzR7qqF<$gm`|ZJZ+;<)Cqu&ot2z=0000WV@Og>004R=004l4008;_004mL004C`008P>0026e000+nl3&F} z0004kNkl5X3{5f?Kt86kG}}I=cFG{044*0O_Wk z9o)`ITwFxKrQ%Q|E=dW;^)AWfu7htna(Vav-OEefi;z;XOp92u#ri=Av1m>Y=mRt0 z2AGBr){&13=CpwkkQigfz+Ej7$k-}y4s2$|w`*Gh!&ZPxpqulqTXzz+fr|p67BHw2 z;4CNXSsR9gFaZvMT}!`U5GFw1(KiT$2{7~UuM8pdfgprf1CCS!ueHxN9q__{jPDpVdfR3g3z;^q_jsR0j@nL2>SOi`y!XCLCWUc@oz-!5xXLm~> zgil*OHY(?$gv*0S%BrCYL=RZE$aeGZzkzGu$E6sBuzlb}HM=Qr+cbdgv`>LO1(43K xgi=ZxydNgO70{XMHVmMnaiDd@zrP*-4FDG9gv=aFrCb02002ovPDHLkV1i3H*k=F$ literal 0 HcmV?d00001 From fe0088d1aeb956695a394fa1c5931213de00e28a Mon Sep 17 00:00:00 2001 From: kristi Date: Mon, 14 May 2012 16:12:20 -0700 Subject: [PATCH 28/30] Add TOC to readme file --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 909a42c8..3fd859d0 100644 --- a/README.md +++ b/README.md @@ -288,6 +288,22 @@ wiki page, simply preface the link with a single quote (like in LISP): This is useful for writing about the link syntax in your wiki pages. +## TABLE OF CONTENTS + +Gollum has a special tag to insert a table of contents (new in v2.1) + + '[[_TOC_]] + +This tag is case sensitive, use all upper case. The TOC tag can be inserted +into the `_Header`, `_Footer` or `_Sidebar` files too. + +There is also a wiki option `:universal_toc` which will display a +table of contents at the top of all your wiki pages if it is enabled. +The `:universal_toc` is not enabled by default. To set the option, +add the option to the `:wiki_options` hash before starting the +frontend app: + + Precious::App.set(:wiki_options, {:universal_toc => true}) ## SYNTAX HIGHLIGHTING @@ -470,6 +486,7 @@ like Rack::Auth, OmniAuth, etc. gollum_path = File.expand_path(File.dirname(__FILE__)) # CHANGE THIS TO POINT TO YOUR OWN WIKI REPO Precious::App.set(:gollum_path, gollum_path) Precious::App.set(:default_markup, :markdown) # set your favorite markup language + Precious::App.set(:wiki_options, {:universal_toc => false}) run Precious::App ## Windows Filename Validation From 97dd1b3b000a8dc9480952335b0b5d923a256735 Mon Sep 17 00:00:00 2001 From: kristi Date: Mon, 14 May 2012 17:01:39 -0700 Subject: [PATCH 29/30] Fix toc test --- test/test_wiki.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/test_wiki.rb b/test/test_wiki.rb index c3d18e5b..8012494b 100644 --- a/test/test_wiki.rb +++ b/test/test_wiki.rb @@ -116,7 +116,7 @@ context "Wiki TOC" do page = @wiki.preview_page("Test", "# Bilbo", :markdown) assert_equal "# Bilbo", page.raw_data assert_equal '

Bilbo

', page.formatted_data.gsub(/\n/,"") - assert_equal '', page.toc_data.gsub(/\n */,"") + assert_equal %{
Table of Contents
}, page.toc_data.gsub(/\n */,"") end end From 5f5187e05cbbb66b05a40eff1c062337323da84c Mon Sep 17 00:00:00 2001 From: kristi Date: Tue, 22 May 2012 11:55:02 -0700 Subject: [PATCH 30/30] Only set parentpage if a subpage was found Fixes error if there's no header or footer --- lib/gollum/page.rb | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/lib/gollum/page.rb b/lib/gollum/page.rb index bdcc2d22..adb8088c 100644 --- a/lib/gollum/page.rb +++ b/lib/gollum/page.rb @@ -435,8 +435,9 @@ module Gollum dirs.pop end - page = find_page_in_tree(map, name, '') - page.parent_page = self + if page = find_page_in_tree(map, name, '') + page.parent_page = self + end page end