adding xmlbuilder

[sfa.git] / xmlbuilder-0.9 / xmlbuilder / docs / long_descr.rst

diff --git a/xmlbuilder-0.9/xmlbuilder/docs/long_descr.rst b/xmlbuilder-0.9/xmlbuilder/docs/long_descr.rst
new file mode 100644 (file)
index 0000000..4e82bc8
--- /dev/null
+++ b/xmlbuilder-0.9/xmlbuilder/docs/long_descr.rst
@@ -0,0 +1,68 @@
+Example of usage:\r
+-----------------\r
+\r
+\r
+from __future__ import with_statement\r
+from xmlbuilder import XMLBuilder\r
+x = XMLBuilder(format=True)\r
+with x.root(a = 1):\r
+    with x.data:\r
+        [x << ('node',{'val':i}) for i in range(10)]\r
+\r
+print str(x)\r
+\r
+will print\r
+\r
+<root a="1">\r
+    <data>\r
+        <node val="0" />\r
+        <node val="1" />\r
+        <node val="2" />\r
+        <node val="3" />\r
+        <node val="4" />\r
+        <node val="5" />\r
+        <node val="6" />\r
+        <node val="7" />\r
+        <node val="8" />\r
+        <node val="9" />\r
+    </data>\r
+</root>\r
+\r
+Mercurial repo:http://hg.assembla.com/MyPackages/\r
+\r
+Documentations\r
+--------------\r
+`XMLBuilder` is simple library build on top of `ElementTree.TreeBuilder` to\r
+simplify xml files creation as much as possible. Althow it can produce\r
+structured result with identated child tags. `XMLBuilder` use python `with`\r
+statement to define xml tag levels and `<<` operator for simple cases -\r
+text and tag without childs.\r
+\r
+First we need to create xmlbuilder\r
+\r
+    from xmlbuilder import XMLBuilder\r
+    # params - encoding = 'utf8',\r
+    # builder = None, - ElementTree.TreeBuilder \r
+    # tab_level = None, - current tab l;evel - for formatted output only\r
+    # format = False, - create formatted output\r
+    # tab_step = " " * 4 - indentation step\r
+    xml = XMLBuilder()\r
+\r
+\r
+Use `with` statement to make document structure\r
+    #create and open tag 'root_tag' with text 'text' and attributes\r
+    with xml.root_tag(text,attr1=val1,attr2=val2):\r
+        #create and open tag 'sub_tag'\r
+        with xml.sub_tag(text,attr3=val3):\r
+            #create tag which are not valid python identificator\r
+            with xml('one-more-sub-tag',attr7=val37):\r
+                xml << "Some textual data"\r
+            #here tag 'one-more-sub-tag' are closed\r
+                       #Tags without children can be created using `<<` operator\r
+            for val in range(15):\r
+                xml << ('message',"python rocks!"[:i])\r
+            #create 15 child tag like <message> python r</message>\r
+    #all tags closed\r
+    node = ~x # get etree.ElementTree object\r
+    xml_data = str(x)\r
+    unicode_xml_data = unicode(x)\r