diff data/plugin/macro/span.py @ 534:7bcfe0b3823a

span macro: reformat docstring
author Thomas Waldmann <tw AT waldmann-edv DOT de>
date Tue, 22 Jun 2010 16:56:31 +0200
parents 1f9926e7f5b5
children 4599602f00e5
line wrap: on
line diff
--- a/data/plugin/macro/span.py	Tue Jun 22 16:49:38 2010 +0200
+++ b/data/plugin/macro/span.py	Tue Jun 22 16:56:31 2010 +0200
@@ -2,16 +2,25 @@
 """
     MoinMoin - span generating macro
 
-    Supported attrs: css_class, id, lang, dir, title
+    Supported span attrs:
+        class (use css_class param)
+        id
+        lang
+        dir
+        title
     
-    Partially supported attrs: style - only safe stuff on whitelist (with
-                               SUPPORT_STYLE_ATTR = True), other stuff
-                               can contain javascript, XSS danger!
-                               If you don't need style, consider using
-                               SUPPORT_STYLE_ATTR = False for better safety.
+    Partially supported attrs:
+        if SUPPORT_STYLE_ATTR is True:
+        style - only support safe properties that are on whitelist,  others
+                could contain javascript and thus, be dangerous (XSS etc.)!
+        
+        if SUPPORT_STYLE_ATTR is False:
+        style - macro argument is accepted, but will be silently ignored, it
+                won't create style attribute output.
 
-    Unsupported attrs: event attrs - unsafe, can contain javascript, XSS danger
-                       align - deprecated by the W3C (use css classes)
+    Unsupported attrs:
+        event attrs - unsafe, can contain javascript, XSS danger
+        align - deprecated by the W3C (use css classes)
 
     Usage:
     <<span(red)>>some text contained in a span with css class red<<span>>
@@ -57,7 +66,7 @@
         remove all surrounding whitespace
         """
         decls = [decl.split(u':', 1) for decl in style.split(u';')]
-        # remove spaces from propery and value
+        # remove spaces from property and value
         result = []
         for decl in decls:
             if len(decl) == 2: