zim.import_files

module documentation

(source)

Undocumented

Function	`import_file`	No summary
Function	`import_folder`	No summary
Variable	`logger`	Undocumented

def import_file(file, notebook, path, format='wiki'): (source)

Import a file into a zim notebook page

Parameters
file	a `File` object to import from
notebook	a `Notebook` object to import into
path	the `Path` to import to within the notebook
format	Undocumented
Returns
the `Page` object for the imported page, this may be a different page than the one `path` is pointing - see `notebook.get_new_page()`

def import_folder(folder, notebook, path, filter=None, format='wiki'): (source)

Import a folder recursively

Parameters
folder	a `Folder` object to import from
notebook	a `Notebook` object to import into
path	the `Path` to import to within the notebook
filter	optional filter function to decide which files and folder to import when scanning `folder`. Will be given each file or folder found when scanning `folder` and expected to return boolean whether to import yes or no.
format	Undocumented

logger = (source)

Undocumented