PlyBook
class compolyx.PlyBook(name='PlyBook', parent=None, reST_ply='', reST_chapter='', reST_title_page='', scene=None)
Class to represent a ply book.
Attributes
| Name | Description |
|---|---|
PlyBook.chapters | Dictionary with all chapters defined |
PlyBook.is_dict_item | Specifies whether the object is an item of a dict |
PlyBook.is_list_item | Specifies whether the object is an item of a list |
PlyBook.link_path | Root path of the current node in the tree for links to this object |
PlyBook.name | Name of object |
PlyBook.parent | Parent object in tree |
PlyBook.reST_chapter | reST chapter template |
PlyBook.reST_ply | reST ply template |
PlyBook.reST_title_page | reST title page template |
PlyBook.root_path | Root path of the current node in the tree |
PlyBook.scene |
Methods
| Name | Description |
|---|---|
PlyBook.automatic_setup() | |
PlyBook.create_chapter(name[, view, ...]) | Add a chapter to the ply book |
PlyBook.find_parent(type) | Function steps up the tree and returns the first parent with given type |
PlyBook.generate(filename[, format]) | Generate the complete plybook |
PlyBook.initialize_plybook(**kwargs) | |
PlyBook.serialize() | |
PlyBook.update() | |
PlyBook.visit(visitor) | Walk through the tree and let the visitor perform action on every descendant node |