zim.export.layouts.ExportLayout

class documentation

class ExportLayout(object): (source)

Known subclasses: zim.export.layouts.DirLayoutBase, zim.export.linker.StubLayout

View In Hierarchy

The ExportLayout object determines the mapping of pages to files when exporting. This is the base class that defines the public API.
Method attachments_dir No summary
Method page_file No summary
Method resources_dir Returns the folder for template resources @returns: a Dir object
Class Variable relative_root Undocumented
def attachments_dir(self, page): (source)
overridden in zim.export.layouts.DirLayoutBase, zim.export.linker.StubLayout
Returns the attachments folder for a page
Parameters
pagea Page or Path object
Returns
a Dir object
Raises
ValueErrorif folder can not be mapped
Unknown Field: implementation
must be implemented by subclasses
def page_file(self, page): (source)
overridden in zim.export.layouts.FileLayout, zim.export.layouts.MultiFileLayout, zim.export.layouts.SingleFileLayout, zim.export.linker.StubLayout
Returns the file for a page
Parameters
pagea Page or Path object
Returns
a File object
Raises
ValueErrorif page can not be mapped
Unknown Field: implementation
must be implemented by subclasses
def resources_dir(self): (source)
overridden in zim.export.layouts.DirLayoutBase, zim.export.linker.StubLayout
Returns the folder for template resources
Returns
a Dir object
relative_root = (source)
overridden in zim.export.layouts.FileLayout, zim.export.layouts.MultiFileLayout, zim.export.layouts.SingleFileLayout

Undocumented