Changeset 4218

Timestamp:

12/18/07 07:36:23 (1 year ago)

Author:

davidserduke

Message:

Added a 'forlinksurl' parameter to prepend to any wiki link.

Location:

trunk/tools/wikiapi2xml

Files:

• createjQueryXMLDocs.py (modified) (14 diffs)
• README (modified) (1 diff)

trunk/tools/wikiapi2xml/createjQueryXMLDocs.py

@@ -4 +4 @@
 createjQueryXMLDocs.py
 David Serduke
-Version 0.1.4
-Last Modified: Dec. 15, 2007
+Version 0.1.5
+Last Modified: Dec. 18, 2007
 
 Python script to convert the jQuery wiki documentation to an XML doc
@@ -21 +21 @@
 #   if data != "":
 #     print data
-#   raw_input(msg);
+#   raw_input(msg)
 
 def printdebug(msg):
@@ -36 +36 @@
 class Callable:
   def __init__(self, func):
-    self.__call__ = func;
+    self.__call__ = func
 
 # handle passed in parameters
@@ -43 +43 @@
     form = cgi.FieldStorage()
 
-    self.help = "false";
+    self.help = "false"
     self.supressContentType = "false" 
     self.startingUrl = "API"
-    self.exporterUrl = "http://docs.jquery.com/Special:Export";
+    self.exporterUrl = "http://docs.jquery.com/Special:Export"
+    self.forLinksUrl = ""
     self.version = ""
     self.convertLinks = "html"
@@ -60 +61 @@
     for key in keys:
       if key == "help":
-        self.help = form.getvalue(key);
+        self.help = form.getvalue(key)
       elif key == "supresscontenttype":
-        self.supressContentType = form.getvalue(key);
+        self.supressContentType = form.getvalue(key)
       elif key == "start":
-        self.startingUrl = form.getvalue(key);
+        self.startingUrl = form.getvalue(key)
       elif key == "exporter":
-        self.exporterUrl = form.getvalue(key);
+        self.exporterUrl = form.getvalue(key)
+      elif key == "forlinksurl":
+        self.forLinksUrl = form.getvalue(key)
       elif key == "version":
-        self.version = form.getvalue(key);
+        self.version = form.getvalue(key)
       elif key == "convertlinks":
         self.convertLinks = form.getvalue(key)
@@ -108 +111 @@
     # example "#redirect [[API/1.2/Selectors]]
     if re.search(r"\#redirect", self.wiki, re.IGNORECASE):
-      printdebug("Redirected...")
       m = re.search(r"\#redirect \[\[(?P<dir>.*)\]\]", self.wiki, re.IGNORECASE)
+      printdebug("Redirected to... " + m.group("dir"))
       self.load(m.group("dir"))
 
@@ -199 +202 @@
     # new cat so reset subcat
     subcat = { 'name':'', 'node':None }
-    printdebug("Reset subcat to None");
+    printdebug("Reset subcat to None")
     for child in self.children:
       if (child != None):
@@ -250 +253 @@
   def parseParts(self, section):
     i = 0
-    optionNames = [ "name", "type", "desc", "default" ];
+    optionNames = [ "name", "type", "desc", "default" ]
     optionCount = 0
     name = None
@@ -299 +302 @@
           p = re.compile(r" ")
           mlink = p.sub("_", mlink)
+          mlink = opts.forLinksUrl + mlink
           value += "[[" + mlink + "|" + mname + "]]"
           i += m.end()
@@ -378 +382 @@
     # special case for when there was an error retrieving document
     if self.page.wiki == "":
-      return;
+      return
 
     printdebug("Exporting '" + self.page.url + "'") 
@@ -397 +401 @@
             # have left a subcat so reset
             subcat = { 'name':'', 'node':None }
-            printdebug("Reset subcat to 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']:
@@ -406 +410 @@
             n.setAttribute('value', subcat['name'])
             parent.appendChild(n)
-            printdebug("Set subcat to " + subcat['name']);
+            printdebug("Set subcat to " + subcat['name'])
           # if there is a subcat then append to that, otherwise go right to parent
           if subcat['node'] != None:
@@ -502 +506 @@
   doc = impl.createDocument(None, "docs", None)
   if opts.verbose != "false":
-    infoNode = doc.createElement("info");
-    doc.documentElement.appendChild(infoNode);
+    infoNode = doc.createElement("info")
+    doc.documentElement.appendChild(infoNode)
   page = XMLPage(opts.startingUrl)
   nodeTree = Node.factory(page)
@@ -511 +515 @@
     doc.documentElement.setAttribute("version", opts.version)
   if nodeTree == None:
-    errorNode = doc.createElement("error");
+    errorNode = doc.createElement("error")
     errorNode.appendChild(doc.createTextNode("Error parsing initial page."))
-    doc.documentElement.appendChild(errorNode);
+    doc.documentElement.appendChild(errorNode)
   else:
     nodeTree.exportXML(doc.documentElement)

trunk/tools/wikiapi2xml/README

@@ -26 +26 @@
     convert to a string like "<a href='Ajax_Events'>Ajax Events</a>", 
     or create an XML node named 'a' with the same information. (defaults to 'html')
+
+  forlinksurl:
+    Value to prepend to any wiki link like 'http://docs.jquery.com/' (defaults to '')
 
   verbose: