zim.export.layouts.FileLayout

class documentation

class FileLayout(DirLayoutBase): (source)

Layout that maps pages to files in a folder with one specific page as the top level file. Use to export sub-tree of a notebook.

Layout:

  page.html
  page_files/
   `--> attachment.png
   `--> subpage.html
   `--> subpage/attachment.pdf
   `--> _resources/

The root for relative links is the parent folder of "page.html" and "page_files/"

Inherited from DirLayoutBase:

Method	`attachments_dir`	No summary
Method	`resources_dir`	Returns the folder for template resources @returns: a `Dir` object

def __init__(self, file, page, ext): (source)

Constructor

Parameters
file	a `File` object
page	a `Path` object for the top level page
ext	the file extension to be used for sub-pages, e.g. 'html'

def page_file(self, page): (source)

overrides zim.export.layouts.ExportLayout.page_file

Returns the file for a page

Parameters
page	a `Page` or `Path` object
Returns
a `File` object
Raises
`ValueError`	if page can not be mapped
Unknown Field: implementation
must be implemented by subclasses

Undocumented

Undocumented

Undocumented

namespace = (source)

Undocumented

relative_root = (source)

overrides zim.export.layouts.ExportLayout.relative_root

Undocumented