zim.export.linker.ExportLinker

class documentation

class ExportLinker(BaseLinker): (source)

Known subclasses: zim.export.linker.StaticExportLinker, zim.www.WWWLinker

This object translate links in zim pages to (relative) URLs. This is used when exporting data to resolve links. Relative URLs start with "./" or "../" and should be interpreted in the same way as in HTML. Both URLs and relative URLs are already URL encoded

Unknown Field: todo
info on formats to know how to set "usebase"

Method	`__init__`	No summary
Method	`file_object`	Turn a `File` object in a relative link or URI
Method	`img`	Returns an url for image file 'src'
Method	`link`	Returns an url for a link in a zim page This method is used to translate links of any type.
Method	`page_object`	Turn a `Path` object in a relative link or URI
Method	`resolve_dest_file`	Find the destination file for an attachment @returns: a `File` object
Method	`resolve_source_file`	No summary
Method	`resource`	Return an url for template resources
Instance Variable	`base`	Undocumented
Instance Variable	`document_root_url`	Undocumented
Instance Variable	`layout`	Undocumented
Instance Variable	`notebook`	Undocumented
Instance Variable	`output`	Undocumented
Instance Variable	`source`	Undocumented
Instance Variable	`usebase`	Undocumented
Method	`_link_file`	Undocumented
Method	`_link_interwiki`	Undocumented
Method	`_link_mailto`	Undocumented
Method	`_link_notebook`	Undocumented
Method	`_link_page`	Undocumented
Method	`_resolve_file`	Undocumented

def __init__(self, notebook, layout, source=None, output=None, usebase=False, document_root_url=None): (source)

overridden in zim.export.linker.StaticExportLinker, zim.www.WWWLinker

Contructor

Parameters
notebook	the source `Notebook` for resolving links
layout	the `ExportLayout` for resolving target files
source	is the `Path` of the source page being exported
output	is a `File` object for the destination file
usebase	if `True` the format allows returning relative paths
document_root_url	optional URL for the document root

def file_object(self, file): (source)

overrides zim.formats.BaseLinker.file_object

overridden in zim.www.WWWLinker

Turn a File object in a relative link or URI

def img(self, src): (source)

overrides zim.formats.BaseLinker.img

Returns an url for image file 'src'

def link(self, link): (source)

overrides zim.formats.BaseLinker.link

Returns an url for a link in a zim page This method is used to translate links of any type.

Parameters
link	link to be translated
Returns
url, uri, or relative path context of this linker

def page_object(self, path): (source)

overrides zim.formats.BaseLinker.page_object

overridden in zim.www.WWWLinker

Turn a Path object in a relative link or URI

def resolve_dest_file(self, link): (source)

Find the destination file for an attachment

Returns
a `File` object

def resolve_source_file(self, link): (source)

overrides zim.formats.BaseLinker.resolve_source_file

overridden in zim.www.WWWLinker

Find the source file for an attachment Used e.g. by the latex format to find files for equations to be inlined. Do not use this method to resolve links, the file given here might be temporary and is not guaranteed to be available after the export.