### Class NavLinks - Provide function to insert a hyperlink navigation component in a document.

## SYNOPSIS

    import NavLinks

    class NavLinks
      def __call__(self, docs, marker='NAVLINKS')
      def __init__(self, **kw)
      string __module__ = 'NavLinks'
      def generate_navbar(self, index)
      def get_left_terminus(self)
      def get_right_terminus(self)
      def get_sep(self)
      def link_future_page(self, index)
      def link_next_page(self, index)
      def link_past_page(self, index)
      def link_previous_page(self, index)
      def link_this_page(self, index)
      def link_up(self)
      def null(self, *arg)

## DESCRIPTION

Usage: A = NavLinks() A(list_of_docs) where list_of_docs is a list of tuple pairs (HTMLdoc, docfilename). HTMLdoc can be either an instance of SimpleDocument (or child), an instance of StringTemplate (or child), or a string. These documents must contain a marker string "{NAVLINKS}" where you wish the nav aid to be placed. The docfilename is the filename for the HTML document when it is written to disk. Calling the NavLinks instance as a function given this list of tuples mutates the individual documents. Then it is up to the user to write the objects out as files. See test() for examples. An optional second argument to the instance call can specify a different tag, e.g., A(doclist, 'INDEX') would look for {INDEX} instead of {NAVLINKS}.

### def generate_navbar(self, index)

Generate and return navbar.

### def get_left_terminus(self)

Return symbol used as left delimiter of navlinks.

### def get_right_terminus(self)

Return symbol used as right delimiter of navlinks.

### def get_sep(self)

Return symbol used to separate navlinks.

### def link_future_page(self, index)

Return symbol used for non-adjacent following pages.

### def link_next_page(self, index)

Return symbol used for next page.

### def link_past_page(self, index)

Return symbol used for non-adjacent past pages.

### def link_previous_page(self, index)

Return symbol used for previous page.

### def link_this_page(self, index)

Return symbol used for this page.

### def link_up(self)

Return symbol used to traverse upward.

### def null(self, *arg)

Return empty string. Used to nullify one of these feature methods.

## SEE ALSO

NavLinks

Copyright © 1996-9 Robin Friedrich
All Rights Reserved
Comments to author: friedrich@pythonpros.com
Generated: Tue Apr 20, 1999