toc.py, hierarchy.py: add new "Hide: true" page attribute

[webber.git] / plugins / toc.py

diff --git a/plugins/toc.py b/plugins/toc.py
index ffd6c25c1b1cf0995704913ddcb2375f2564be11..41d31dc7947e3a8d51ad85678d75b380b1edafdb 100644 (file)
--- a/plugins/toc.py
+++ b/plugins/toc.py
@@ -4,9 +4,9 @@ import htmlentitydefs, re
 
 
 reHeader = re.compile(r'<h(\d)(.*)>(.*)</h\1>', re.IGNORECASE | re.MULTILINE)
-toc = []
-labels = {}
-
+_toc = []
+_labels = {}
+_first = -1
 
 toc_min_lines = 30
 
@@ -19,70 +19,81 @@ def checkconfig(params):
 
 
 def slugify(text, separator):
-    """Based on http://snipplr.com/view/26266/create-slugs-in-python/"""
+       """
+       This function converts a normal text string into a string, that
+       can be safely used for HTML links and anchors.
+
+       Based on http://snipplr.com/view/26266/create-slugs-in-python/
+       """
 
-    ret = ""
-    for c in text.lower():
-        try:
-            ret += htmlentitydefs.codepoint2name[ord(c)]
-        except:
-            ret += c
-    ret = re.sub("([a-zA-Z])(uml|acute|grave|circ|tilde|cedil)", r"\1", ret)
-    ret = re.sub("\W", " ", ret)
-    ret = re.sub(" +", separator, ret)
-    return ret.strip()
+       ret = ""
+       for c in text.lower():
+               try:
+                       ret += htmlentitydefs.codepoint2name[ord(c)]
+               except:
+                       ret += c
+       ret = re.sub("([a-zA-Z])(uml|acute|grave|circ|tilde|cedil)", r"\1", ret)
+       ret = re.sub("\W", " ", ret)
+       ret = re.sub(" +", separator, ret)
+       return ret.strip()
 
 
 def repl(m):
-    global toc
-    label = slugify(m.group(3), "_")
-    if labels.has_key(label):
-        n = 0
-        while True:
-            l = "%s_%d" % (label, n)
-            if not labels.has_key(l):
-                label = l
-                break
-            n += 1
-
-    toc.append( (label, int(m.group(1))-1, m.group(3)) )
-    return '<h%s%s>%s<a name="%s">&nbsp;</a></h%s>' % (
-        m.group(1),
-        m.group(2),
-        m.group(3),
-        label,
-        m.group(1))
+       """
+       Function used for re.sub() to find all header elements (h1, h2, ...).
+       Data from those elements (level, headline) are stored in the global
+       array `toc`.
+
+       This function also modifies the text by adding a anchor to the
+       header.
+       """
+       global _toc
+       global _first
+       label = slugify(m.group(3), "_")
+       if _labels.has_key(label):
+               n = 0
+               while True:
+                       l = "%s_%d" % (label, n)
+                       if not _labels.has_key(l):
+                               label = l
+                               break
+                       n += 1
+
+       level = int(m.group(1))
+       if _first == -1:
+               _first = level
+       _toc.append( (level - _first, m.group(3), label) )
+       _labels[label] = 1
+       return '<h%s%s>%s<a name="%s">&nbsp;</a></h%s>' % (
+               m.group(1),
+               m.group(2),
+               m.group(3),
+               label,
+               m.group(1))
+
 
 
 @set_hook("linkify")
 def linkify(params):
-    global toc
-    global labels
-    toc = []
-    labels = {}
+       global _toc
+       global _labels
+       global _first
+       _toc = []
+       _labels = {}
+       _first = -1
+
+       # Ignore hidden pages
+       if params.file.has_key("hide") and params.file.hide:
+               return
 
-    # Very small pages don't need a table-of-contents
-    if params.file.contents.count("\n") < toc_min_lines:
-        return
+       # Very small pages don't need a table-of-contents
+       if params.file.contents.count("\n") < toc_min_lines:
+               return
 
-    params.file.contents = reHeader.sub(repl, params.file.contents)
+       params.file.contents = reHeader.sub(repl, params.file.contents)
 
 
 
 @set_function("get_toc")
 def get_toc():
-    level = 1
-    res = []
-    res.append('<ul id="toc">')
-    for (label, lvl, txt) in toc:
-        while lvl > level:
-            res.append("%s<ul>" % ("  "*level))
-            level += 1
-        while lvl < level:
-            level -= 1
-            res.append("%s</ul>" % ("  "*level))
-        res.append('%s<li><a href="#%s">%s</a></li>' % ("  " * level, label, txt))
-    while level:
-        level -= 1
-        res.append("%s</ul>" % ("  "*level))
-    return "\n".join(res)
+       return _toc