class documentation

class LinksView(IndexView): (source)

View In Hierarchy

Undocumented

Method __init__ Undocumented
Method list_floating_links Undocumented
Method list_links Generator listing links between pages
Method list_links_section Undocumented
Method n_list_links Undocumented
Method n_list_links_section Undocumented
Method _list_links Undocumented
Method _list_links_section Undocumented
Method _n_list_links Undocumented
Instance Variable _pages Undocumented

Inherited from IndexView:

Class Method new_from_index Undocumented
Instance Variable db Undocumented
def __init__(self, db): (source)
def list_floating_links(self, basename): (source)

Undocumented

def list_links(self, pagename, direction=LINK_DIR_FORWARD): (source)
Generator listing links between pages
Parameters
pagenamethe Path for which to list links
direction

the link direction to be listed. This can be one of:

  • LINK_DIR_FORWARD: for links from path
  • LINK_DIR_BACKWARD: for links to path
  • LINK_DIR_BOTH: for links from and to path
Returns
yields IndexLink objects
Raises
IndexNotFoundErrorif path is not found in the index
def list_links_section(self, pagename, direction=LINK_DIR_FORWARD): (source)

Undocumented

def n_list_links(self, pagename, direction=LINK_DIR_FORWARD): (source)

Undocumented

def n_list_links_section(self, pagename, direction=LINK_DIR_FORWARD): (source)

Undocumented

def _list_links(self, page_id, pagename, direction): (source)

Undocumented

def _list_links_section(self, page_id, pagename, direction): (source)

Undocumented

def _n_list_links(self, page_id, direction): (source)

Undocumented

_pages = (source)

Undocumented