| |
- NavLinks
-
- AdjacentArrows
-
- AdjacentArrows2
- AllFilenames
- AllIcons
class AdjacentArrows(NavLinks) |
|
Just put forward and back arrow images.
Mandatory attributes:
prev_image, next_image
Optional Attribute:
uplink, upimage
set either as keywords to the constructor or as
attribute assignments to instance. |
|
Methods defined here:
- get_left_terminus = null(self, *arg)
- Return empty string. Used to nullify one of these feature methods.
- get_right_terminus = null(self, *arg)
- Return empty string. Used to nullify one of these feature methods.
- get_sep = null(self, *arg)
- Return empty string. Used to nullify one of these feature methods.
- link_future_page = null(self, *arg)
- Return empty string. Used to nullify one of these feature methods.
- link_next_page(self, index)
- link_past_page = null(self, *arg)
- Return empty string. Used to nullify one of these feature methods.
- link_previous_page(self, index)
- link_this_page = null(self, *arg)
- Return empty string. Used to nullify one of these feature methods.
Methods inherited from NavLinks:
- __call__(self, docs, marker='NAVLINKS')
- __init__(self, **kw)
- generate_navbar(self, index)
- Generate and return navbar.
- link_up(self)
- Return symbol used to traverse upward.
- null(self, *arg)
- Return empty string. Used to nullify one of these feature methods.
|
class AdjacentArrows2(AdjacentArrows) |
|
Put forward and back arrow images plus a current doc icon.
Mandatory attributes:
prev_image, next_image, this_page_image
Optional Attribute:
uplink, upimage
set either as keywords to the constructor or as
attribute assignments to instance. |
|
- Method resolution order:
- AdjacentArrows2
- AdjacentArrows
- NavLinks
Methods defined here:
- link_this_page(self, index)
Methods inherited from AdjacentArrows:
- get_left_terminus = null(self, *arg)
- Return empty string. Used to nullify one of these feature methods.
- get_right_terminus = null(self, *arg)
- Return empty string. Used to nullify one of these feature methods.
- get_sep = null(self, *arg)
- Return empty string. Used to nullify one of these feature methods.
- link_future_page = null(self, *arg)
- Return empty string. Used to nullify one of these feature methods.
- link_next_page(self, index)
- link_past_page = null(self, *arg)
- Return empty string. Used to nullify one of these feature methods.
- link_previous_page(self, index)
Methods inherited from NavLinks:
- __call__(self, docs, marker='NAVLINKS')
- __init__(self, **kw)
- generate_navbar(self, index)
- Generate and return navbar.
- link_up(self)
- Return symbol used to traverse upward.
- null(self, *arg)
- Return empty string. Used to nullify one of these feature methods.
|
class AllFilenames(NavLinks) |
|
Display iconic links for all pages in series.
Optional Attribute:
uplink, upimage
set either as keywords to the constructor or
as attribute assignments to instance. |
|
Methods defined here:
- link_future_page = link_previous_page(self, index)
- link_next_page = link_previous_page(self, index)
- link_past_page = link_previous_page(self, index)
- link_previous_page(self, index)
- link_this_page(self, index)
Methods inherited from NavLinks:
- __call__(self, docs, marker='NAVLINKS')
- __init__(self, **kw)
- generate_navbar(self, index)
- Generate and return navbar.
- get_left_terminus(self)
- Return symbol used as left delimiter of navlinks.
- get_right_terminus(self)
- Return symbol used as right delimiter of navlinks.
- get_sep(self)
- Return symbol used to separate navlinks.
- link_up(self)
- Return symbol used to traverse upward.
- null(self, *arg)
- Return empty string. Used to nullify one of these feature methods.
|
class AllIcons(NavLinks) |
|
Display iconic links for all pages in series.
Mandatory attributes:
prev_image, this_page_image, next_image, past_image, future_image
Optional Attribute:
uplink, upimage
set either as keywords to the constructor or
as attribute assignments to instance. |
|
Methods defined here:
- get_left_terminus = null(self, *arg)
- Return empty string. Used to nullify one of these feature methods.
- get_right_terminus = null(self, *arg)
- Return empty string. Used to nullify one of these feature methods.
- get_sep = null(self, *arg)
- Return empty string. Used to nullify one of these feature methods.
- link_future_page(self, index)
- link_next_page(self, index)
- link_past_page(self, index)
- link_previous_page(self, index)
- link_this_page(self, index)
Methods inherited from NavLinks:
- __call__(self, docs, marker='NAVLINKS')
- __init__(self, **kw)
- generate_navbar(self, index)
- Generate and return navbar.
- link_up(self)
- Return symbol used to traverse upward.
- null(self, *arg)
- Return empty string. Used to nullify one of these feature methods.
|
class NavLinks |
|
Provide function to insert a hyperlink navigation component in a document.
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}. |
|
Methods defined here:
- __call__(self, docs, marker='NAVLINKS')
- __init__(self, **kw)
- generate_navbar(self, index)
- Generate and return navbar.
- get_left_terminus(self)
- Return symbol used as left delimiter of navlinks.
- get_right_terminus(self)
- Return symbol used as right delimiter of navlinks.
- get_sep(self)
- Return symbol used to separate navlinks.
- link_future_page(self, index)
- Return symbol used for non-adjacent following pages.
- link_next_page(self, index)
- Return symbol used for next page.
- link_past_page(self, index)
- Return symbol used for non-adjacent past pages.
- link_previous_page(self, index)
- Return symbol used for previous page.
- link_this_page(self, index)
- Return symbol used for this page.
- link_up(self)
- Return symbol used to traverse upward.
- null(self, *arg)
- Return empty string. Used to nullify one of these feature methods.
| |