markdown.extensions.footnotes.FootnoteExtension

class documentation

class FootnoteExtension(Extension): (source)

View In Hierarchy

Footnote Extension.

Method __init__ Setup configs.
Method extendMarkdown Add pieces to Markdown.
Method findFootnotesPlaceholder Return ElementTree Element that contains Footnote placeholder.
Method get_separator Get the footnote separator.
Method makeFootnoteId Return footnote link id.
Method makeFootnoteRefId Return footnote back-link id.
Method makeFootnotesDiv Return div of footnotes as et Element.
Method reset Clear footnotes on reset, and prepare for distinct document.
Method setFootnote Store a footnote for later retrieval.
Method unique_ref Get a unique reference if there are duplicates.
Instance Variable config Undocumented
Instance Variable footnotes Undocumented
Instance Variable found_refs Undocumented
Instance Variable md Undocumented
Instance Variable parser Undocumented
Instance Variable unique_prefix Undocumented
Instance Variable used_refs Undocumented

Inherited from Extension:

Method getConfig Return a setting for the given key or an empty string.
Method getConfigInfo Return all config descriptions as a list of tuples.
Method getConfigs Return all configs settings as a dict.
Method setConfig Set a config setting for `key` with the given `value`.
Method setConfigs Set multiple config settings given a dict or list of tuples.
def __init__(self, **kwargs): (source)
overrides markdown.extensions.Extension.__init__

Setup configs.

def extendMarkdown(self, md): (source)
overrides markdown.extensions.Extension.extendMarkdown

Add pieces to Markdown.

def findFootnotesPlaceholder(self, root): (source)

Return ElementTree Element that contains Footnote placeholder.

def get_separator(self): (source)

Get the footnote separator.

def makeFootnoteId(self, id): (source)

Return footnote link id.

def makeFootnoteRefId(self, id, found=False): (source)

Return footnote back-link id.

def makeFootnotesDiv(self, root): (source)

Return div of footnotes as et Element.

def reset(self): (source)

Clear footnotes on reset, and prepare for distinct document.

def setFootnote(self, id, text): (source)

Store a footnote for later retrieval.

def unique_ref(self, reference, found=False): (source)

Get a unique reference if there are duplicates.

config: dict = (source)
overrides markdown.extensions.Extension.config

Undocumented

footnotes = (source)

Undocumented

found_refs: dict = (source)

Undocumented

md = (source)

Undocumented

parser = (source)

Undocumented

unique_prefix: int = (source)

Undocumented

used_refs = (source)

Undocumented