Classes | Functions | Variables
webdoc Namespace Reference

Classes

class  DocBareNode
class  DocCDATA
class  DocCDATAText
class  DocCode
class  DocCodeText
class  DocDir
class  DocError
class  DocGroup
class  DocHandler
class  DocHtmlElement
class  DocHtmlText
class  DocInclude
class  DocLocation
class  DocNode
class  DocPage
class  DocPageScript
class  DocPageStyle
class  DocSite
class  DocTemplate
class  Generator
class  makeGuard

Functions

def __call__
def __get__
def __init__
def __init__
def __init__
def __init__
def __str__
def adopt
def appendLocation
def calcRelURL
def changeDir
def characters
def close
def comment
def dump
def dumpIndex
def endCDATA
def endDocument
def endDTD
def endElement
def endEntity
def ensureDir
def expand
def expandAttr
def findAncestors
def findChildren
def getAttributes
def getChildren
def getCurrentFileName
def getCurrentLocator
def getDepth
def getDoxygenURL
def getID
def getLocation
def getOutDir
def getParent
def getPublishDirName
def getPublishDirName
def getPublishFileName
def getPublishFileName
def getPublishURL
def getPublishURL
def getUniqueNodeID
def ignorableWhitespace
def isA
def load
def lookupFile
def makeError
def open
def parentDir
def publish
def publish
def publish
def publishIndex
def publishIndex
def publishTableOfContents
def putString
def putXMLAttr
def putXMLString
def resolveEntity
def seek
def setDocumentLocator
def setOutDir
def setParent
def setPublishURL
def start
def startCDATA
def startDTD
def startElement
def startEntity
def tell
def visit
def visit
def walkAncestors
def walkNodes

Variables

string action = "count"
 attrs
tuple c = unichr(v)
 children
 column
int counter = 0
int default = 0
string dest = "verb"
 dirName
 dirStack
 DOCTYPE_XHTML_TRANSITIONAL = \
string doxygenDir = ''
 doxygenIndex = None
tuple expand = makeGuard(expand)
 filePath
 filePathStack
 fileStack
 func
 has_pygments = True
string help = "print more debuging information"
 hide
 id
 inDTD
 locations
 locatorStack
dictionary mapUnicodeToHtmlEntity = { }
 name
dictionary nodeIndex = { }
int nodeUniqueCount = 0
 outDir
 parent
tuple parser = OptionParser(usage=usage)
tuple publish = makeGuard(publish)
 rootNode
 row
 siteURL
 sourceColumn
 sourceRow
 sourceURL
 stack
 tag
 templateID
 text
 title
 type
 URL
string usage

Function Documentation

def webdoc.__call__ (   self,
  obj,
  args,
  keys 
)

Definition at line 208 of file webdoc.py.

def webdoc.__get__ (   self,
  obj,
  type = None 
)

Definition at line 218 of file webdoc.py.

def webdoc::__init__ (   self,
  attrs,
  URL = None,
  locator = None 
)
A location consisting of a URL (file), a row number, and a column number.
A node of the document with a parent, childern, attributes, and
additional meta-information such as the location
of the XML element that caused this node to be generated.

Definition at line 163 of file webdoc.py.

def webdoc::__init__ (   self,
  func 
)
An error consisting of a stack of locations and a message.
Decorates the method of a DocNode object so that,
on raising a DocError exception, the location of the node
is appended to it.

Definition at line 179 of file webdoc.py.

def webdoc::__init__ (   self)
A node of the document tree without parent, children, or any
other attribute. It is used to implement common leaf nodes such
as text chunks.

Definition at line 229 of file webdoc.py.

def webdoc.__init__ (   self,
  tag,
  attrs,
  URL = None,
  locator = None 
)

Definition at line 704 of file webdoc.py.

def webdoc::__str__ (   self)

Definition at line 168 of file webdoc.py.

def webdoc.adopt (   self,
  orfan 
)
Adds ORFAN to the node children and make the node the parent
of ORFAN. ORFAN can also be a sequence of orfans.

Definition at line 326 of file webdoc.py.

def webdoc.appendLocation (   self,
  location 
)

Definition at line 192 of file webdoc.py.

def webdoc.calcRelURL (   toURL,
  fromURL 
)
Calculates a relative URL.

Definition at line 102 of file webdoc.py.

def webdoc.changeDir (   self,
  dirName 
)

Definition at line 993 of file webdoc.py.

def webdoc.characters (   self,
  content 
)
SAX interface: characters.

Definition at line 1153 of file webdoc.py.

def webdoc.close (   self)

Definition at line 989 of file webdoc.py.

def webdoc.comment (   self,
  body 
)

Definition at line 1186 of file webdoc.py.

def webdoc.dump (   self)
Recusively dump the tree of nodes, for debugging purposes.

Definition at line 279 of file webdoc.py.

Dump the node index, for debugging purposes.

Definition at line 78 of file webdoc.py.

def webdoc.endCDATA (   self)

Definition at line 1181 of file webdoc.py.

def webdoc.endDocument (   self)

Definition at line 1172 of file webdoc.py.

def webdoc.endDTD (   self)

Definition at line 1197 of file webdoc.py.

def webdoc.endElement (   self,
  name 
)
SAX interface: closing of XML element.

Definition at line 1122 of file webdoc.py.

def webdoc.endEntity (   self,
  name 
)

Definition at line 1192 of file webdoc.py.

def webdoc.ensureDir (   dirName)
Create the directory DIRNAME if it does not exsits.

Definition at line 85 of file webdoc.py.

def webdoc.expand (   self,
  gen,
  pageNode = None 
)

Definition at line 770 of file webdoc.py.

def webdoc.expandAttr (   self,
  value,
  pageNode 
)
Expand an attribute by substituting any directive with its value.

Definition at line 448 of file webdoc.py.

def webdoc.findAncestors (   self,
  nodeType = None 
)
Return the node ancestors of type NODETYPE. If NODETYPE is
None, returns all ancestors.

Definition at line 334 of file webdoc.py.

def webdoc.findChildren (   self,
  nodeType = None 
)
Returns the node chldren of type NODTYPE. If NODETYPE is None,
returns all children.

Definition at line 350 of file webdoc.py.

def webdoc.getAttributes (   self)
Return the dictionary of node attributes.

Definition at line 305 of file webdoc.py.

def webdoc::getChildren (   self)
Returs an empty list
Return the list of node children.

Definition at line 237 of file webdoc.py.

def webdoc.getCurrentFileName (   self)

Definition at line 1169 of file webdoc.py.

def webdoc.getCurrentLocator (   self)

Definition at line 1147 of file webdoc.py.

def webdoc.getDepth (   self)
Return the depth of the node in the tree.

Definition at line 311 of file webdoc.py.

def webdoc.getDoxygenURL (   tag)

Definition at line 57 of file webdoc.py.

def webdoc.getID (   self)
Return the node ID.

Definition at line 287 of file webdoc.py.

def webdoc.getLocation (   self)
Get the location (file, row number, and column number)
where this node was instanitated

Definition at line 359 of file webdoc.py.

def webdoc.getOutDir (   self)

Definition at line 929 of file webdoc.py.

def webdoc.getParent (   self)
Return the node parent.

Definition at line 293 of file webdoc.py.

Returns the publish dir name of the parent.

Definition at line 244 of file webdoc.py.

def webdoc::getPublishDirName (   self)
Returns the publish dir name of the parent.

Definition at line 523 of file webdoc.py.

Returns NONE.

Definition at line 245 of file webdoc.py.

Returns NONE.

Definition at line 852 of file webdoc.py.

Returns NONE.

Definition at line 246 of file webdoc.py.

def webdoc::getPublishURL (   self)
Returns NONE.

Definition at line 715 of file webdoc.py.

def webdoc.getUniqueNodeID (   id = None)
getUniqueNodeID() generates an unique ID for a document node.
getUniqueNodeID(id) generates an unique ID adding a suffix to id.

Definition at line 65 of file webdoc.py.

def webdoc.ignorableWhitespace (   self,
  ws 
)

Definition at line 1166 of file webdoc.py.

def webdoc.isA (   self,
  classInfo 
)
Returns TRUE if the node is of class CLASSINFO.

Definition at line 231 of file webdoc.py.

def webdoc.load (   self,
  qualFilePath 
)

Definition at line 1132 of file webdoc.py.

def webdoc.lookupFile (   self,
  filePath 
)

Definition at line 1034 of file webdoc.py.

def webdoc.makeError (   self,
  message 
)

Definition at line 1046 of file webdoc.py.

def webdoc.open (   self,
  filePath 
)

Definition at line 951 of file webdoc.py.

def webdoc.parentDir (   self)

Definition at line 1000 of file webdoc.py.

def webdoc.publish ( )
Recursively calls PUBLISH() on its children.

Definition at line 248 of file webdoc.py.

def webdoc.publish (   self,
  gen,
  pageNode = None 
)

Definition at line 550 of file webdoc.py.

def webdoc.publish (   self)

Definition at line 935 of file webdoc.py.

Recursively calls PUBLISHINDEX() on its children.

Definition at line 249 of file webdoc.py.

def webdoc::publishIndex (   self,
  gen,
  inPage,
  activePageNodes,
  full = False 
)
Recursively calls PUBLISHINDEX() on its children.

Definition at line 877 of file webdoc.py.

def webdoc.publishTableOfContents (   self,
  gen,
  pageNode 
)
Create a TOC corresponding to the H1, H2, ... tags in a DocPage."

Definition at line 422 of file webdoc.py.

def webdoc.putString (   self,
  str 
)

Definition at line 958 of file webdoc.py.

def webdoc.putXMLAttr (   self,
  str 
)

Definition at line 979 of file webdoc.py.

def webdoc.putXMLString (   self,
  str 
)

Definition at line 969 of file webdoc.py.

def webdoc.resolveEntity (   self,
  publicid,
  systemid 
)
Resolve XML entities by mapping to a local copy of the (X)HTML
DTDs.

Definition at line 1024 of file webdoc.py.

def webdoc.seek (   self,
  pos 
)

Definition at line 1008 of file webdoc.py.

def webdoc.setDocumentLocator (   self,
  locator 
)
SAX interface: This is called when a new file is parsed to set the locator object.

Definition at line 1143 of file webdoc.py.

def webdoc.setOutDir (   self,
  outDir 
)

Definition at line 932 of file webdoc.py.

Set the parent of the node.

Definition at line 243 of file webdoc.py.

def webdoc.setPublishURL (   self,
  url 
)

Definition at line 923 of file webdoc.py.

def webdoc.start (   filePath,
  opts 
)

Definition at line 1201 of file webdoc.py.

def webdoc.startCDATA (   self)

Definition at line 1176 of file webdoc.py.

def webdoc.startDTD (   self,
  name,
  public_id,
  system_id 
)

Definition at line 1194 of file webdoc.py.

def webdoc.startElement (   self,
  name,
  attrs 
)
SAX interface: starting of XML element.
The function creates a new document node, i.e. a specialized
class of DocNode for the type of XML element encountered. It then
appends it as the head of the parsing stack for further processing."

Definition at line 1056 of file webdoc.py.

def webdoc.startEntity (   self,
  name 
)

Definition at line 1191 of file webdoc.py.

def webdoc.tell (   self)

Definition at line 1004 of file webdoc.py.

def webdoc.visit ( )
Recursively calls VISIT() on its children.

Definition at line 247 of file webdoc.py.

def webdoc::visit (   self,
  generator 
)
Recursively calls VISIT() on its children.

Definition at line 526 of file webdoc.py.

def webdoc.walkAncestors (   leafNode,
  nodeType = None 
)

Definition at line 149 of file webdoc.py.

def webdoc.walkNodes (   rootNode,
  nodeType = None,
  nodeBarrier = None 
)

Definition at line 140 of file webdoc.py.


Variable Documentation

string webdoc::action = "count"

Definition at line 1282 of file webdoc.py.

Definition at line 259 of file webdoc.py.

tuple webdoc::c = unichr(v)

Definition at line 47 of file webdoc.py.

Definition at line 259 of file webdoc.py.

Definition at line 163 of file webdoc.py.

int webdoc::counter = 0

Definition at line 822 of file webdoc.py.

string webdoc::default = 0

Definition at line 1281 of file webdoc.py.

string webdoc::dest = "verb"

Definition at line 1280 of file webdoc.py.

Definition at line 513 of file webdoc.py.

Definition at line 944 of file webdoc.py.

Definition at line 39 of file webdoc.py.

string webdoc::doxygenDir = ''

Definition at line 55 of file webdoc.py.

Definition at line 54 of file webdoc.py.

Definition at line 791 of file webdoc.py.

Definition at line 500 of file webdoc.py.

Definition at line 1016 of file webdoc.py.

Definition at line 944 of file webdoc.py.

Definition at line 205 of file webdoc.py.

Definition at line 35 of file webdoc.py.

string webdoc::help = "print more debuging information"

Definition at line 1283 of file webdoc.py.

Definition at line 824 of file webdoc.py.

Definition at line 259 of file webdoc.py.

Definition at line 1016 of file webdoc.py.

Definition at line 179 of file webdoc.py.

Definition at line 1016 of file webdoc.py.

Definition at line 45 of file webdoc.py.

Definition at line 824 of file webdoc.py.

dictionary webdoc::nodeIndex = { }

Definition at line 52 of file webdoc.py.

Definition at line 53 of file webdoc.py.

Definition at line 912 of file webdoc.py.

Definition at line 259 of file webdoc.py.

tuple webdoc::parser = OptionParser(usage=usage)

Definition at line 1277 of file webdoc.py.

Recursively calls PUBLISH() on its children.

Definition at line 410 of file webdoc.py.

Definition at line 1016 of file webdoc.py.

Definition at line 163 of file webdoc.py.

Definition at line 912 of file webdoc.py.

Definition at line 259 of file webdoc.py.

Definition at line 259 of file webdoc.py.

Definition at line 259 of file webdoc.py.

Definition at line 1016 of file webdoc.py.

Definition at line 704 of file webdoc.py.

Definition at line 824 of file webdoc.py.

Definition at line 543 of file webdoc.py.

Definition at line 824 of file webdoc.py.

Definition at line 669 of file webdoc.py.

Definition at line 163 of file webdoc.py.

string webdoc::usage
Initial value:
00001 """webdoc [OPTIONS...] <DOC.XML>
00002 
00003 --outdir    Set output directory
00004 --verbose   Be verbose
00005 --doxytag   Doxygen tag file
00006 --doxydir   Doxygen documentation location
00007 --profile   Collect and print profiling information
00008 """

Definition at line 1269 of file webdoc.py.



libvlfeat
Author(s): Andrea Vedaldi
autogenerated on Thu Jun 6 2019 20:25:53