Changeset 1503 for trunk/pylucid/PyLucid/tools/shortcuts.py

Timestamp:

03/25/08 09:24:47 (8 months ago)

Author:

JensDiemer

Message:

move the automatic headline anchor function from tinyTextile markup ( changeset:1500 ) into a middleware. So every markups becomes headline anchors. See also: ticket:46

Files:

• trunk/pylucid/PyLucid/tools/shortcuts.py (modified) (4 diffs)

trunk/pylucid/PyLucid/tools/shortcuts.py

@@ -11 +11 @@
     $Author$
 
-    :copyright: 2007 by Jens Diemer.
+    :copyleft: 2007-2008 by Jens Diemer.
     :license: GNU GPL v3, see LICENSE.txt for more details.
 """
 
 import string
+
 ALLOW_CHARS = string.ascii_letters + string.digits + "_"
+
 
 def makeUnique(item_name, name_list):
     """
-    returns a unique shortcut.
+    returns a URL safe, unique shortcut.
     - delete all non-ALLOW_CHARS characters.
     - if the shotcut already exists in name_list -> add a sequential number
     Note:
-    Not only used for making page shortcuts unique.
-    Also used in PyLucid.defaulttags.lucidTag.lucidTagNode._add_unique_div()
+    Not only used for making page shortcuts unique with getUniqueShortcut(),
+    also used in:
+        -PyLucid.defaulttags.lucidTag.lucidTagNode._add_unique_div()
+        -PyLucid.middlewares.headline_anchor.HeadlineAnchor()
     """
     # delete all non-ALLOW_CHARS characters and separate in parts
@@ -32 +36 @@
         if not char in ALLOW_CHARS:
             if parts[-1] != "":
-                # No double "-" e.g.: "foo - bar" -> "foo-bar" not "foo---bar"   
+                # No double "-" e.g.: "foo - bar" -> "foo-bar" not "foo---bar"
                 parts.append("")
         else:
@@ -56 +60 @@
     return item_name
 
+
 def getUniqueShortcut(shortcut, exclude_shortcut=None):
     from PyLucid.models import Page
@@ -67 +72 @@
 #    print "existing_shortcuts:", existing_shortcuts
     return makeUnique(shortcut, existing_shortcuts)
+