Register a few more examples.

zopefoundation · Apr 15, 2007 · e8647b4 · e8647b4
1 parent 15f5477
commit e8647b4
Show file tree

Hide file tree

Showing 13 changed files with 62 additions and 34 deletions.
diff --git a/src/z3c/rml/rml-reference.py b/src/z3c/rml/rml-reference.py
@@ -132,17 +132,17 @@ def processSignature(name, signature, examples, directives=None):
 
 def extractExamples(directory):
     EXAMPLE_NS = 'http://namespaces.zope.org/rml/doc'
-    EXAMPLE_ATTR_NAME = '{%s}exampleFor' %EXAMPLE_NS
+    EXAMPLE_ATTR_NAME = '{%s}example' %EXAMPLE_NS
     examples = {}
     for filename in os.listdir(directory):
         if not filename.endswith('.rml'):
             continue
         rmlFile = open(os.path.join(directory, filename), 'r')
         root = etree.parse(rmlFile).getroot()
-        elements = root.xpath('//@doc:exampleFor/parent::*',
+        elements = root.xpath('//@doc:example/parent::*',
                               {'doc': EXAMPLE_NS})
         for elem in elements:
-            demoTag = elem.get(EXAMPLE_ATTR_NAME)
+            demoTag = elem.get(EXAMPLE_ATTR_NAME) or elem.tag
             del elem.attrib[EXAMPLE_ATTR_NAME]
             xml = highlightRML(etree.tounicode(elem).strip())
             elemExamples = examples.setdefault(demoTag, [])

diff --git a/src/z3c/rml/tests/input/tag-circle.rml b/src/z3c/rml/tests/input/tag-circle.rml
@@ -7,8 +7,7 @@
   <pageDrawing>
 
     <circle x="10cm" y="25cm" radius="2cm"
-            fill="false" stroke="false"
-            doc:exampleFor="circle" />
+            fill="false" stroke="false" doc:example="" />
 
     <circle x="10cm" y="20cm" radius="2cm"
             fill="true" stroke="false" />

diff --git a/src/z3c/rml/tests/input/tag-curves.rml b/src/z3c/rml/tests/input/tag-curves.rml
@@ -1,10 +1,12 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <!DOCTYPE document SYSTEM "rml.dtd">
 
-<document filename="grid.pdf">
+<document
+    filename="grid.pdf"
+    xmlns:doc="http://namespaces.zope.org/rml/doc">
   <pageDrawing>
 
-    <curves>
+    <curves doc:example="">
       1in 1in 2in 2in 2in 3in 1in 3in
       1in 2in 2in 3in 2in 4in 1in 4in
       1in 3in 2in 4in 2in 5in 1in 5in

diff --git a/src/z3c/rml/tests/input/tag-drawAlignedString.rml b/src/z3c/rml/tests/input/tag-drawAlignedString.rml
@@ -1,12 +1,14 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <!DOCTYPE document SYSTEM "rml.dtd">
 
-<document filename="drawString.pdf">
+<document
+    filename="drawString.pdf"
+    xmlns:doc="http://namespaces.zope.org/rml/doc">
   <pageDrawing>
 
-    <drawAlignedString x="4.1in" y="9.8in">
-      $ 13.63
-    </drawAlignedString>
+    <drawAlignedString
+        x="4.1in" y="9.8in" doc:example=""
+        >$ 13.63</drawAlignedString>
     <drawAlignedString x="4.1in" y="9.6in">
       $ 121.01
     </drawAlignedString>

diff --git a/src/z3c/rml/tests/input/tag-drawCenteredString.rml b/src/z3c/rml/tests/input/tag-drawCenteredString.rml
@@ -1,12 +1,14 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <!DOCTYPE document SYSTEM "rml.dtd">
 
-<document filename="drawCenteredString.pdf">
+<document
+    filename="drawCenteredString.pdf"
+    xmlns:doc="http://namespaces.zope.org/rml/doc">
   <pageDrawing>
 
-    <drawCenteredString x="4.1in" y="5.8in">
-      Hello World.
-    </drawCenteredString>
+    <drawCenteredString
+        x="4.1in" y="5.8in" dox:example=""
+        >Hello World.</drawCenteredString>
 
   </pageDrawing>
 </document>
diff --git a/src/z3c/rml/tests/input/tag-drawRightString.rml b/src/z3c/rml/tests/input/tag-drawRightString.rml
@@ -1,12 +1,15 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <!DOCTYPE document SYSTEM "rml.dtd">
 
-<document filename="drawRightString.pdf">
+<document
+    filename="drawRightString.pdf"
+    xmlns:doc="http://namespaces.zope.org/rml/doc">
+
   <pageDrawing>
 
-    <drawRightString x="4.1in" y="5.8in">
-      Hello World.
-    </drawRightString>
+    <drawRightString
+        x="4.1in" y="5.8in" doc:example=""
+        >Hello World.</drawRightString>
 
   </pageDrawing>
 </document>
diff --git a/src/z3c/rml/tests/input/tag-drawString.rml b/src/z3c/rml/tests/input/tag-drawString.rml
@@ -1,12 +1,12 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <!DOCTYPE document SYSTEM "rml.dtd">
 
-<document filename="drawString.pdf">
+<document
+    filename="drawString.pdf"
+    xmlns:doc="http://namespaces.zope.org/rml/doc">
   <pageDrawing>
 
-    <drawString x="4.1in" y="5.8in">
-      Hello World.
-    </drawString>
+    <drawString x="4.1in" y="5.8in" doc:example="">Hello World.</drawString>
 
   </pageDrawing>
 </document>
diff --git a/src/z3c/rml/tests/input/tag-ellipse.rml b/src/z3c/rml/tests/input/tag-ellipse.rml
@@ -1,11 +1,13 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <!DOCTYPE document SYSTEM "rml.dtd">
 
-<document filename="ellipse.pdf">
+<document
+    filename="ellipse.pdf"
+    xmlns:doc="http://namespaces.zope.org/rml/doc">
   <pageDrawing>
 
     <ellipse x="10cm" y="25cm" width="5cm" height="3cm"
-             fill="false" stroke="false" />
+             fill="false" stroke="false" doc:example="" />
 
     <ellipse x="10cm" y="20cm" width="5cm" height="3cm"
              fill="true" stroke="false" />

diff --git a/src/z3c/rml/tests/input/tag-grid.rml b/src/z3c/rml/tests/input/tag-grid.rml
@@ -1,12 +1,15 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <!DOCTYPE document SYSTEM "rml.dtd">
 
-<document filename="grid.pdf">
+<document
+    filename="grid.pdf"
+    xmlns:doc="http://namespaces.zope.org/rml/doc">
   <pageDrawing>
 
     <grid
         xs="1in 2in 3in 4in 5in 6in"
         ys="7in 7.2in 7.4in 7.6in 7.8in 8.0in"
+        doc:example=""
         />
 
   </pageDrawing>

diff --git a/src/z3c/rml/tests/input/tag-image.rml b/src/z3c/rml/tests/input/tag-image.rml
@@ -1,6 +1,9 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <!DOCTYPE document SYSTEM "rml.dtd">
-<document filename="tag-image.pdf">
+
+<document
+    filename="tag-image.pdf"
+    xmlns:doc="http://namespaces.zope.org/rml/doc">
   <pageDrawing>
 
     <image file="[z3c.rml.tests]/input/zope3logo.gif"
@@ -13,7 +16,8 @@
            x="2in" y="4in" height="3in" />
 
     <image file="[z3c.rml.tests]/input/zope3logo.gif"
-           x="2in" y="2in" width="0.5in" height="3in" />
+           x="2in" y="2in" width="0.5in" height="3in"
+           doc:example=""/>
 
   </pageDrawing>
 </document>
diff --git a/src/z3c/rml/tests/input/tag-lines.rml b/src/z3c/rml/tests/input/tag-lines.rml
@@ -1,10 +1,12 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <!DOCTYPE document SYSTEM "rml.dtd">
 
-<document filename="grid.pdf">
+<document
+    filename="grid.pdf"
+    xmlns:doc="http://namespaces.zope.org/rml/doc">
   <pageDrawing>
 
-    <lines>
+    <lines doc:example="">
       1in 7in 6in 7in
       1in 5in 6in 4in
       1in 3in 1in 1in

diff --git a/src/z3c/rml/tests/input/tag-place.rml b/src/z3c/rml/tests/input/tag-place.rml
@@ -1,8 +1,9 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <!DOCTYPE document SYSTEM "rml.dtd">
 
-<document filename="tag-place.pdf">
-
+<document
+    filename="tag-place.pdf"
+    xmlns:doc="http://namespaces.zope.org/rml/doc">
   <stylesheet>
     <paraStyle
       name="big"
@@ -46,5 +47,11 @@
       This is a string drawn using ``drawString``.
     </drawString>
 
+    <place
+        x="1cm" y="10cm" width="13cm" height="4cm"
+        doc:example="">
+      <para>A paragraph within the place.</para>
+    </place>
+
   </pageDrawing>
 </document>
diff --git a/src/z3c/rml/tests/input/tag-rectange.rml b/src/z3c/rml/tests/input/tag-rectange.rml
@@ -1,10 +1,12 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <!DOCTYPE document SYSTEM "rml.dtd">
 
-<document filename="rectangle.pdf">
+<document
+    filename="rectangle.pdf"
+    xmlns:doc="http://namespaces.zope.org/rml/doc">
   <pageDrawing>
 
-    <rect x="8cm" y="20cm" width="5cm" height="3cm" />
+    <rect x="8cm" y="20cm" width="5cm" height="3cm" doc:example="" />
 
     <rect x="8cm" y="15cm" width="5cm" height="3cm"
           round="1cm" />