zim.export.template

This module defines the ExportTemplateContext, which is a dictionary used to set the template parameters when exporting.

Export template parameters supported:

  generator
        .name   -- "Zim x.xx"
        .user

  title

  navigation    - links to other export pages (if not included here)
        home
        up
        prev                    -- prev export file or None
        next                    -- next export file or None

  links                 -- links to other export pages (index & plugins / ...) - sorted dict to have Index, Home first followed by plugins

        link
                .name
                .basename

  pages                 -- iter over special + content
        .special        -- iter special pages to be included (index / plugins / ...) - support get() as well here
        .content        -- iter pages being exported

                page
                        .title          -- heading or basename
                        .name / .section / .basename
                        .heading
                        .body           -- full body minus first heading
                        .content        -- heading + body
                        .headings(max_level)    -- iter over headings

                                headingsection
                                        .level
                                        .heading
                                        .body
                                        .content

                        .links
                        .backlinks
                        .attachments

                                file
                                        .basename
                                        .mtime
                                        .size

  options               -- dict with template options (for format)

  toc([page])                   -- iter of headings in this page or all of pages
  index([section])      -- index of full export job, not just in this page
  uri(link|file)
  resource(file)
  anchor(page|section)

From template base:

  range() / len() / sorted() / reversed()
  strftime()
  strfcal()

Test in a template for single page export use: "IF loop.first and loop.last"