docutils.utils.math.math2html.FormulaCommand

class documentation

class FormulaCommand(FormulaBit):

Known subclasses: docutils.utils.math.math2html.CommandBit, docutils.utils.math.math2html.FormulaCell, docutils.utils.math.math2html.FormulaRow

View In Hierarchy

A LaTeX command inside a formula
Method detect Find the current command.
Method emptycommand Check for an empty command: look for command disguised as ending. Special case against '{ { } }' situation.
Method extractcommand Extract the command from the current position.
Method parsebit Parse the command.
Method parsecommandtype Parse a given command type.
Method parseupgreek Parse the Greek up command..
Method parsewithcommand Parse the command type once we have the command.
Class Variable commandmap Undocumented
Class Variable start Undocumented
Class Variable types Undocumented
Instance Variable output Undocumented

Inherited from FormulaBit:

Method __init__ The formula bit type can be 'alpha', 'number', 'font'.
Method __unicode__ Get a string representation
Method add Add any kind of formula bit already processed
Method clone Return a copy of itself.
Method computesize Compute the size of the bit as the max of the sizes of all contents.
Method setfactory Set the internal formula factory.
Method skiporiginal Skip a string and add it to the original formula
Class Variable original Undocumented
Class Variable type Undocumented
Instance Variable contents Undocumented
Instance Variable factory Undocumented
Instance Variable size Undocumented

Inherited from Container (via FormulaBit):

Method escape Escape a line with replacements from a map
Method escapeentities Escape all Unicode characters to HTML entities.
Method extracttext Extract all text from allowed containers.
Method gethtml Get the resulting HTML
Method getparameter Get the value of a parameter, if present.
Method getparameterlist Get the value of a comma-separated parameter as a list.
Method group Group some adjoining elements into a group
Method hasemptyoutput Check if the parent's output is empty.
Method locateprocess Search for all embedded containers and process them
Method process Process contents
Method recursivesearch Perform a recursive search in the container.
Method remove Remove a container but leave its contents
Method searchall Search for all embedded containers of a given type
Method searchprocess Search for elements of a given type and process them
Method searchremove Search for all containers of a type and remove them
Method tree Show in a tree
Class Variable begin Undocumented
Class Variable parent Undocumented
Class Variable partkey Undocumented
def detect(self, pos):
overridden in docutils.utils.math.math2html.SymbolFunction
Find the current command.
def emptycommand(self, pos):
Check for an empty command: look for command disguised as ending. Special case against '{ { } }' situation.
def extractcommand(self, pos):
Extract the command from the current position.
def parsebit(self, pos):
overridden in docutils.utils.math.math2html.BeginCommand, docutils.utils.math.math2html.EmptyCommand, docutils.utils.math.math2html.EquationEnvironment, docutils.utils.math.math2html.FormulaArray, docutils.utils.math.math2html.FormulaCases, docutils.utils.math.math2html.FormulaCell, docutils.utils.math.math2html.FormulaEquation, docutils.utils.math.math2html.FormulaMatrix, docutils.utils.math.math2html.FormulaRow, docutils.utils.math.math2html.HybridFunction, docutils.utils.math.math2html.LabelFunction, docutils.utils.math.math2html.OneParamFunction, docutils.utils.math.math2html.SpacedCommand, docutils.utils.math.math2html.SymbolFunction, docutils.utils.math.math2html.TextFunction
Parse the command.
def parsecommandtype(self, command, type, pos):
Parse a given command type.
def parseupgreek(self, command, pos):
Parse the Greek up command..
def parsewithcommand(self, command, pos):
Parse the command type once we have the command.
commandmap =
overridden in docutils.utils.math.math2html.BeginCommand, docutils.utils.math.math2html.LimitPreviousCommand

Undocumented

start =

Undocumented

types: list =
overridden in docutils.utils.math.math2html.BeginCommand

Undocumented

output =
overrides docutils.utils.math.math2html.FormulaBit.output
overridden in docutils.utils.math.math2html.EquationEnvironment, docutils.utils.math.math2html.FormulaArray, docutils.utils.math.math2html.FormulaCases, docutils.utils.math.math2html.FormulaCell, docutils.utils.math.math2html.FormulaEquation, docutils.utils.math.math2html.FormulaMatrix, docutils.utils.math.math2html.FormulaRow, docutils.utils.math.math2html.LimitCommand, docutils.utils.math.math2html.OneParamFunction, docutils.utils.math.math2html.SymbolFunction, docutils.utils.math.math2html.TextFunction

Undocumented