Adds Trac-Like anchors on wiki headings (#1647).

git-svn-id: http://redmine.rubyforge.org/svn/trunk@1705 e93f8b46-1217-0410-a6f0-8f06a7374b81

Adds Trac-Like anchors on wiki headings (#1647).
git-svn-id: http://redmine.rubyforge.org/svn/trunk@1705 e93f8b46-1217-0410-a6f0-8f06a7374b81
2dbc3d29 · Jean-Philippe Lang · b20281f1 · 2dbc3d29 · 2dbc3d29 · 2dbc3d29
Commit 2dbc3d29 authored Jul 28, 2008 by Jean-Philippe Lang
Showing with 26 additions and 14 deletions

wiki_formatting.rb lib/redmine/wiki_formatting.rb +18 -10

application.css public/stylesheets/application.css +4 -0

application_helper_test.rb test/unit/helpers/application_helper_test.rb +4 -4

No files found.
--- a/lib/redmine/wiki_formatting.rb
+++ b/lib/redmine/wiki_formatting.rb
@@ -65,10 +65,22 @@ module Redmine
      
      # Patch to add 'table of content' support to RedCloth
      def textile_p_withtoc(tag, atts, cite, content)
-        if tag =~ /^h(\d)$/
-          @toc << [$1.to_i, content]
+        # removes wiki links from the item
+        toc_item = content.gsub(/(\[\[|\]\])/, '')
+        # removes styles
+        # eg. %{color:red}Triggers% => Triggers
+        toc_item.gsub! %r[%\{[^\}]*\}([^%]+)%], '\\1'
+        
+        # replaces non word caracters by dashes
+        anchor = toc_item.gsub(%r{[^\w\s\-]}, '').gsub(%r{\s+(\-+\s*)?}, '-')
+
+        unless anchor.blank?
+          if tag =~ /^h(\d)$/
+            @toc << [$1.to_i, anchor, toc_item]
+          end
+          atts << " id=\"#{anchor}\""
+          content = content + "<a href=\"##{anchor}\" class=\"wiki-anchor\">&para;</a>"
        end
-        content = "<a name=\"#{@toc.length}\" class=\"wiki-page\"></a>" + content
        textile_p(tag, atts, cite, content)
      end

@@ -82,13 +94,9 @@ module Redmine
          div_class << ' right' if $1 == '>'
          div_class << ' left' if $1 == '<'
          out = "<ul class=\"#{div_class}\">"
-          @toc.each_with_index do |heading, index|
-            # remove wiki links from the item
-            toc_item = heading.last.gsub(/(\[\[|\]\])/, '')
-            # remove styles
-            # eg. %{color:red}Triggers% => Triggers
-            toc_item.gsub! %r[%\{[^\}]*\}([^%]+)%], '\\1'
-            out << "<li class=\"heading#{heading.first}\"><a href=\"##{index+1}\">#{toc_item}</a></li>\n"
+          @toc.each do |heading|
+            level, anchor, toc_item = heading
+            out << "<li class=\"heading#{level}\"><a href=\"##{anchor}\">#{toc_item}</a></li>\n"
          end
          out << '</ul>'
          out

--- a/public/stylesheets/application.css
+++ b/public/stylesheets/application.css
@@ -487,6 +487,10 @@ div.wiki ul.toc a {
 }
 div.wiki ul.toc a:hover { color: #c61a1a; text-decoration: underline;}

+a.wiki-anchor { display: none; margin-left: 6px; text-decoration: none; }
+a.wiki-anchor:hover { color: #aaa !important; text-decoration: none; }
+h1:hover a.wiki-anchor, h2:hover a.wiki-anchor, h3:hover a.wiki-anchor { display: inline; color: #ddd; }
+
 /***** My page layout *****/
 .block-receiver {
 border:1px dashed #c0c0c0;

--- a/test/unit/helpers/application_helper_test.rb
+++ b/test/unit/helpers/application_helper_test.rb
@@ -215,10 +215,10 @@ h1. Another title
 RAW

    expected = '<ul class="toc">' +
-               '<li class="heading1"><a href="#1">Title</a></li>' +
-               '<li class="heading2"><a href="#2">Subtitle</a></li>' + 
-               '<li class="heading2"><a href="#3">Subtitle with red text</a></li>' +
-               '<li class="heading1"><a href="#4">Another title</a></li>' +
+               '<li class="heading1"><a href="#Title">Title</a></li>' +
+               '<li class="heading2"><a href="#Subtitle">Subtitle</a></li>' + 
+               '<li class="heading2"><a href="#Subtitle-with-red-text">Subtitle with red text</a></li>' +
+               '<li class="heading1"><a href="#Another-title">Another title</a></li>' +
               '</ul>'
               
    assert textilizable(raw).gsub("\n", "").include?(expected)