docutils.utils.math.math2html.Reference

class documentation

class Reference(Link): (source)

View In Hierarchy

A reference to a label.
Method __unicode__ Return a printable representation.
Method formatcontents Format the reference contents.
Method process Read the reference and set the arrow.
Method replace Replace a key in the format template with a value.
Class Variable references Undocumented
Instance Variable contents Undocumented
Instance Variable destination Undocumented
Instance Variable direction Undocumented
Instance Variable formatted Undocumented
Instance Variable key Undocumented

Inherited from Link:

Method __init__ Initialize the link, add target if configured.
Method complete Complete the link.
Method computedestination Use the destination link to fill in the destination URL.
Method setmutualdestination Set another link as destination, and set its destination to this one.
Class Variable page Undocumented
Instance Variable anchor Undocumented
Instance Variable output Undocumented
Instance Variable parser Undocumented
Instance Variable target Undocumented
Instance Variable title Undocumented
Instance Variable type Undocumented
Instance Variable url Undocumented

Inherited from Container (via Link):

Method escape Escape a line with replacements from elyxer.a map
Method escapeall Escape all lines in an array according to the output options.
Method escapeentities Escape all Unicode characters to HTML entities.
Method extracttext Extract all text from elyxer.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 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 __unicode__(self): (source)
overrides docutils.utils.math.math2html.Link.__unicode__
Return a printable representation.
def formatcontents(self): (source)
Format the reference contents.
def process(self): (source)
overrides docutils.utils.math.math2html.Container.process
Read the reference and set the arrow.
def replace(self, key, value): (source)
Replace a key in the format template with a value.
references = (source)

Undocumented

contents = (source)
overrides docutils.utils.math.math2html.Link.contents

Undocumented

destination = (source)
overrides docutils.utils.math.math2html.Link.destination

Undocumented

direction: str = (source)

Undocumented

formatted = (source)

Undocumented

key = (source)

Undocumented