Elixir.ExDoc.Formatter.HTML

ExDocEPUB.Formatter.EPUB.Templates

Handle all template interfaces for the EPUB formatter.

Summary

Creates the Package Document Definition, this definition encapsulates the publication metadata and the resource information that constitute the EPUB publication. This definition also includes the default reading order

Returns the details of an individual function, macro or callback. This function is required used by module_template/6

Creates a new chapter when the user provides additional files

Generate content from the module template for a given node

Creates a chapter which contains all the details about an individual module, this chapter can include the following sections: functions, macros, types, callbacks

Creates the table of contents. This template follows the EPUB Navigation Document Definition

Creates a summary of the functions and macros available for an individual module, this function is required by module_template/6

Creates the cover page for the EPUB document

Creates an Navigation Center eXtended document (as defined in OPF 2.0.1), this is for compatibility purposes with EPUB 2 Reading Systems. EPUB 3 Reading Systems must ignore the NCX in favor of the EPUB Navigation Document

Returns all the details of an individual type. This function is required by module_template/6

Functions

content_template(config, nodes, uuid, datetime)

Creates the Package Document Definition, this definition encapsulates the publication metadata and the resource information that constitute the EPUB publication. This definition also includes the default reading order.

detail_template(node, module)

Returns the details of an individual function, macro or callback. This function is required used by module_template/6.

extra_template(config, content)

Creates a new chapter when the user provides additional files.

module_page(config, node)

Generate content from the module template for a given node

module_template(config, module, types, functions, macros, callbacks)

Creates a chapter which contains all the details about an individual module, this chapter can include the following sections: functions, macros, types, callbacks.

Creates the table of contents. This template follows the EPUB Navigation Document Definition.

summary_template(node)

Creates a summary of the functions and macros available for an individual module, this function is required by module_template/6.

title_template(config)

Creates the cover page for the EPUB document.

toc_template(config, nodes, uuid)

Creates an Navigation Center eXtended document (as defined in OPF 2.0.1), this is for compatibility purposes with EPUB 2 Reading Systems. EPUB 3 Reading Systems must ignore the NCX in favor of the EPUB Navigation Document.

type_detail_template(node)

Returns all the details of an individual type. This function is required by module_template/6.