Changeset 1250

Timestamp:

02/21/2005 09:58:03 PM (3 years ago)

Author:

cmlenz

Message:

• Add id attributes to headings in wiki pages, so that they can be directly referenced as anchors in the page. Closes #847.
• Make the links to headings available through the UI when hovering over the heading (using JavaScript).

Location:

trunk

Files:

• htdocs/css/wiki.css (modified) (1 diff)
• htdocs/js/trac.js (modified) (1 diff)
• templates/wiki.cs (modified) (1 diff)
• trac/Href.py (modified) (1 diff)
• trac/tests/wiki-tests.txt (modified) (2 diffs)
• trac/WikiFormatter.py (modified) (4 diffs)

trunk/htdocs/css/wiki.css

@@ -13 +13 @@
 #delete { margin-left: 6em }
 #preview { background: #f4f4f4 url(../draft.png); margin: 1em 0 2em }
+
+/* Heading anchors */
+.anchor:link, .anchor:visited {
+ border: none;
+ color: #d7d7d7;
+ font-size: .8em;
+ vertical-align: text-top;
+ visibility: hidden;
+}
+h1:hover .anchor, h2:hover .anchor, h3:hover .anchor,
+h4:hover .anchor, h5:hover .anchor, h6:hover .anchor {
+ visibility: visible;
+}
 
 /* Styles for the page history table

trunk/htdocs/js/trac.js

@@ -99 +99 @@
   }
 }
+
+function addHeadingLinks(container) {
+  var base = document.location.pathname;
+  function addLinks(elems) {
+    for (var i = 0; i < elems.length; i++) {
+      var hn = elems[i];
+      if (hn.id) {
+        var link = document.createElement('a');
+        link.href = base + '#' + hn.id;
+        link.className = 'anchor';
+        link.title = "Link to this section";
+        link.appendChild(document.createTextNode(" \u00B6"));
+        hn.appendChild(link);
+      }
+    }
+  }
+  for (var lvl = 0; lvl <= 6; lvl++) {
+    addLinks(container.getElementsByTagName('h' + lvl));
+  }
+}

trunk/templates/wiki.cs

@@ -245 +245 @@
  <?cs /if ?>
 </div>
+<script type="text/javascript">
+  addHeadingLinks(document.getElementById("searchable"));
+</script>
 
 <?cs include "footer.cs" ?>

trunk/trac/Href.py

@@ -144 +144 @@
 
     def wiki(self, page=None, version=None, action=None):
+        anchor = ''
+        if page and page.find("#") != -1:
+            anchor = page[page.find('#'):]
+            page = page[:page.find('#')]
         params = []
         if page:
-            href = href_join(self.base, 'wiki', page)
+            href = href_join(self.base, 'wiki', page) + anchor
         else:
-            href = href_join(self.base, 'wiki')
+            href = href_join(self.base, 'wiki') + anchor
         if action:
             params.append(('action', action))

trunk/trac/tests/wiki-tests.txt

@@ -5 +5 @@
 Another paragraph
 ------------------------------
-<h1>Heading 1</h1>
+<h1 id="Heading1">Heading 1</h1>
 <p>
 Paragraph
@@ -132 +132 @@
 == Heading with trailing white-space == 
 ------------------------------
-<h2>Heading with trailing white-space</h2>
+<h2 id="Headingwithtrailingwhitespace">Heading with trailing white-space</h2>
 ==============================
 A0B1, ST62T53C6, IR32V1H000

trunk/trac/WikiFormatter.py

@@ -46 +46 @@
               r"(?P<reporthref>!?\{\d+\})",
               r"(?P<modulehref>!?((?P<modulename>bug|ticket|browser|source|repos|report|changeset|wiki|milestone|search):(?P<moduleargs>(&#34;(.*?)&#34;|'(.*?)')|([^ ]*[^'~_\., \)]))))",
-              r"(?P<wikihref>!?(^|(?<=[^A-Za-z]))[A-Z][a-z]+(?:[A-Z][a-z]*[a-z/])+(?=\Z|\s|[.,;:!?\)}\]]))",
+              r"(?P<wikihref>!?(^|(?<=[^A-Za-z]))[A-Z][a-z]+(?:[A-Z][a-z]*[a-z/])+(?:#[A-Za-z0-9]+)?(?=\Z|\s|[.,;:!?\)}\]]))",
               r"(?P<fancylink>!?\[(?P<fancyurl>([a-z]+:[^ ]+)) (?P<linkname>.*?)\])"]
 
@@ -157 +157 @@
 
     def _make_wiki_link(self, page, text):
+        anchor = ''
+        if page.find('#') != -1:
+            anchor = page[page.find('#'):]
+            page = page[:page.find('#')]
         if not self.env._wiki_pages.has_key(page):
             return '<a class="missing wiki" href="%s" rel="nofollow">%s?</a>' \
-                   % (self._href.wiki(page), text)
+                   % (self._href.wiki(page + anchor), text)
         else:
             return '<a class="wiki" href="%s">%s</a>' \
-                   % (self._href.wiki(page), text)
+                   % (self._href.wiki(page + anchor), text)
 
     def _make_changeset_link(self, rev, text):
@@ -264 +268 @@
     _compiled_rules = re.compile('(?:' + string.join(_rules, '|') + ')')
     _processor_re = re.compile('#\!([a-zA-Z0-9/+-]+)')
+    _anchor_re = re.compile('[^\w\d]+')
     mime_type = ""
+    anchors = []
 
     hdf = None
@@ -369 +375 @@
     def _heading_formatter(self, match, fullmatch):
         match = match.strip()
-        depth = min(len(fullmatch.group('hdepth')), 5)
         self.close_table()
         self.close_paragraph()
         self.close_indentation()
         self.close_list()
-        self.out.write('<h%d>%s</h%d>' % (depth, match[depth + 1:len(match) - depth - 1], depth))
+
+        depth = min(len(fullmatch.group('hdepth')), 5)
+        heading = match[depth + 1:len(match) - depth - 1]
+        anchor = anchor_base = self._anchor_re.sub('', heading)
+        if anchor[0].isdigit():
+            anchor = '_' + anchor
+        i = 1
+        while anchor in self.anchors:
+            anchor = anchor_base + str(i)
+            i += 1
+        self.anchors.append(anchor)
+        self.out.write('<h%d id="%s">%s</h%d>' % (depth, anchor, heading, depth))
         return ''