zim.export

package documentation

(source)

This module contains the framework for exporting data from zim.

The main API for exporting from the application is the Exporter object. There are subclasses of Exporter to export to multiple files, to a single file or to a MHTML file.

To configure the exporter object an additional ExportLayout object is used. This layout defines the exact mapping of pages to files to be used.

To specific the pages to export a subclass of the PageSelection class is used. There are selection classes to export the whole notebook or to export a single page.

The ExportTemplateContext object defines specific template parameters for exporting. See also zim.templates for template parsing and processing classes.

See the module functions for convenient standard configurations.

Package	`exporters`	The exporters are the main public objects for exporting, they control the execution of the whole process. Each exporter implements a different export style.
Module	`layouts`	The ExportLayout object determines the mapping of pages to files when exporting. The subclasses give alternative file layouts.
Module	`linker`	The ExportLinker object translates links in zim pages to URLS for the export content
Module	`selections`	PageSelection objects wrap the list of pages to be exported
Module	`template`	This module defines the ExportTemplateContext, which is a dictionary used to set the template parameters when exporting.
Module	`__main__`	Undocumented

From __init__.py:

Function	`build_mhtml_file_exporter`	Returns an `Exporter` that is suitable for exporting a set of pages to a single mhtml file
Function	`build_notebook_exporter`	Returns an `Exporter` that is suitable for exporting a whole notebook to a folder with one file per page
Function	`build_page_exporter`	Returns an `Exporter` that is suitable for exporting a page with subpages to a file and a folder (e.g. "page.html" with "page_files/")
Function	`build_single_file_exporter`	Returns an `Exporter` that is suitable for exporting a set of pages to a single file

def build_notebook_exporter(dir, format, template, **opts): (source)

Returns an Exporter that is suitable for exporting a whole notebook to a folder with one file per page

def build_page_exporter(file, format, template, page, **opts): (source)

Returns an Exporter that is suitable for exporting a page with subpages to a file and a folder (e.g. "page.html" with "page_files/")

def build_single_file_exporter(file, format, template, namespace=None, **opts): (source)

Returns an Exporter that is suitable for exporting a set of pages to a single file

def build_mhtml_file_exporter(file, template, **opts): (source)

Returns an Exporter that is suitable for exporting a set of pages to a single mhtml file