Changeset 4190

Timestamp:

12/16/07 22:08:02 (1 year ago)

Author:

davidserduke

Message:

Fixed a bug and added a new parameter 'debug' to help when the xml portion can't be output correctly.

Location:

trunk/tools/wikiapi2xml

Files:

• createjQueryXMLDocs.py (modified) (10 diffs)
• README (modified) (2 diffs)

trunk/tools/wikiapi2xml/createjQueryXMLDocs.py

@@ -25 +25 @@
 def printdebug(msg):
   if opts.verbose != "false" and infoNode != None:
-    msgNode = doc.createElement("msg")
-    msgNode.appendChild(doc.createTextNode(msg))
-    infoNode.appendChild(msgNode)
-    # print msg
-    # print >>sys.stderr, msg
+    if opts.debug == "false":
+      msgNode = doc.createElement("msg")
+      msgNode.appendChild(doc.createTextNode(msg))
+      infoNode.appendChild(msgNode)
+    else:
+      print msg
+      # print >>sys.stderr, msg
 
 # class to create static functions
@@ -45 +47 @@
     self.startingUrl = "API"
     self.exporterUrl = "http://docs.jquery.com/Special:Export";
-    self.version = "Unknown"
+    self.version = ""
     self.convertLinks = "html"
     self.verbose = "false" 
+    self.debug = "false"
     self.timestamp = "0"
     self.parseOptions(form)
@@ -70 +73 @@
       elif key == "verbose":
         self.verbose = form.getvalue(key)
+      elif key == "debug":
+        self.debug = form.getvalue(key)
 
   def url(self, url):
@@ -171 +176 @@
 
   def exportXML(self, parent):
+    printdebug("Exporting '" + self.page.url + "'") 
     for child in self.children:
       if (child != None):
@@ -185 +191 @@
 
   def exportXML(self, parent):
+    global subcat
+
+    printdebug("Exporting '" + self.page.url + "'") 
     node = doc.createElement("cat")
     node.setAttribute("value", self.page.url) 
     parent.appendChild(node)
+    # new cat so reset subcat
+    subcat = { 'name':'', 'node':None }
+    printdebug("Reset subcat to None");
     for child in self.children:
       if (child != None):
@@ -379 +391 @@
           arg['num'] = 0
           arg['index'] = None
+          # create element as 'entry' initially till get a 'type' part then change it
           node = doc.createElement("entry")
           node.setAttribute("timestamp", self.page.timestamp)
@@ -384 +397 @@
             # have left a subcat so reset
             subcat = { 'name':'', 'node':None }
+            printdebug("Reset subcat to None");
           ## != "Documentation" because in the wiki some people are using it as a general header
           elif self.page.header != "Unheadered" and self.page.header != "Documentation" and self.page.header != subcat['name']:
@@ -392 +406 @@
             n.setAttribute('value', subcat['name'])
             parent.appendChild(n)
+            printdebug("Set subcat to " + subcat['name']);
           # if there is a subcat then append to that, otherwise go right to parent
           if subcat['node'] != None:
@@ -479 +494 @@
     return
   if opts.supressContentType == "false":
-    print "Content-Type: text/xml\n"
+    if opts.debug == "false":
+      print "Content-Type: text/xml\n"
+    else:
+      print "Content-Type: text/plain\n"
 
   impl = minidom.getDOMImplementation()
@@ -488 +506 @@
   page = XMLPage(opts.startingUrl)
   nodeTree = Node.factory(page)
-  doc.documentElement.setAttribute("version", opts.version)
+  doc.documentElement.setAttribute("startdoc", opts.startingUrl)
   doc.documentElement.setAttribute("timestamp", opts.timestamp)
+  if opts.version != "":
+    doc.documentElement.setAttribute("version", opts.version)
   if nodeTree == None:
     errorNode = doc.createElement("error");

trunk/tools/wikiapi2xml/README

@@ -31 +31 @@
     mostly for debugging purposes. It will also create "pretty" xml when not set to
     false.  Can have the value of 'false', 'true', or 'super'.  (defaults to 'false')
+
+  debug:
+    Will force the output to be text/plain instead of text/xml and put verbose messages
+    to normal print instead of sticking them in the xml tree.  (defaults to 'false')
   
 The basic XML format is as follows:
 
-<docs timestamp="[last time anything was modified]" version="[version parameter]">
+<docs timestamp="[last time anything was modified]" version="[version parameter]" startdoc='[start param]'>
   <info> - this node is here if 'verbose' parameter was set to other than 'false'
     <msg>Loading...</msg>
@@ -68 +72 @@
 
 To get a debug a problem:
-http://[location of script]/createjQueryXMLDocs.py?start=Selectors&verbose=super
+http://[location of script]/createjQueryXMLDocs.py?start=Selectors&verbose=super&debug=true