Package Pyblio :: Package Cite :: Module Citator :: Class Citator
[hide private]
[frames] | no frames]

Class Citator

source code

object --+
         |
        Citator

Instance Methods [hide private]
 
__init__(self)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
source code
 
xmlload(self, fd) source code
 
prepare(self, db, wp, extra_info=None)
Link the citator with a specific database and word processor.
source code
 
update(self)
Force an update of keys and bibliography content
source code
 
cite(self, uids)
Insert the specified record identifiers in the current document
source code

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self)
(Constructor)

source code 
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
Overrides: object.__init__
(inherited documentation)

prepare(self, db, wp, extra_info=None)

source code 
Link the citator with a specific database and word
processor. @extra_info is an optional function that will
return a string to store along with the entry, if the word
processor allows it.

Args:
  db: Pyblio.Store.Database
  wp: Pyblio.Cite.WP.IWordProcessor
  extra_info: str = fn(Pyblio.Store.Key, Pyblio.Store.Database) or None