zim.notebook

package documentation

(source)

This module contains the main Notebook class and related classes.

The Notebook interface is the generic API for accessing and storing pages and other data in the notebook. The interface uses Path objects to indicate a specific page. See Notebook.pages.lookup_from_user_input() to obtain a Path from a page name as string. Pages in the notebook are represented by the Page object, which allows to access the page contents.

The notebook keeps track of all pages using an Index which is stored in a sqlite database. Methods that need a list of pages in the notebook always use the index rather than a direct lookup. See notebook.zim.index for more details.

The NotebookInfoList is defined to help access known notebooks and a NotebookInfo object can be used to access the notebook properties without instantiating a full Notebook object. Use the convience methods get_notebook_list() and resolve_notebook() to obtain these objects.

Notes
To open a notebook based on e.g. a commandline option it is almost always better to use `build_notebook()` rather than istantiating the notebook directly.
for more information about threading and concurency, see `notebook.zim.operations`

Package	`index`	No package docstring; 0/2 variable, 0/2 constant, 0/1 function, 1/5 class, 1/5 module documented
Module	`content_updater`	No module docstring; 0/1 variable, 3/10 functions documented
Module	`info`	No module docstring; 0/1 variable, 4/4 functions, 2/3 classes documented
Module	`layout`	No module docstring; 0/2 variable, 0/2 constant, 2/3 functions, 1/3 class documented
Module	`notebook`	No module docstring; 0/1 variable, 0/2 constant, 0/4 function, 3/9 classes documented
Module	`operations`	This module contains classes and functions needed for concurrent use of the notebook data.
Module	`page`	No module docstring; 0/3 variable, 0/3 constant, 1/1 function, 3/4 classes documented

From __init__.py:

Class	`ApplicationMountPointHandler`	Undocumented
Function	`build_notebook`	No summary
Function	`init_notebook`	Initialize a new notebook in a directory
Function	`is_relevant_mount_point`	Undocumented
Function	`mount_notebook`	Undocumented
Variable	`logger`	Undocumented

logger = (source)

Undocumented

def build_notebook(location): (source)

Create a Notebook object for a file location Tries to automount file locations first if needed

Parameters
location	a `FilePath` or a `NotebookInfo`
Returns
a `Notebook` object and a `Path` object or `None`
Raises
`FileNotFoundError`	if file location does not exist and could not be mounted

def mount_notebook(filepath): (source)

Undocumented

def is_relevant_mount_point(root, path): (source)

Undocumented

def init_notebook(dir, name=None): (source)

Initialize a new notebook in a directory