Module

PuduLangDocgen.Site.Print

View source

Printable documents assembled from tables of contents

Types

Name Description
Printable One document to print and the settings of its table

Functions

Name Description
documents A printable document for every table of contents whose metadata sets `pdf`. Each lists its pages in reading order after an optional cover (`pdfCoverPage`) and contents page (`pdfTocPage`); `pdfFileName` names the output beside the table.
rebase Page HTML moved into a printed document: ids gain a prefix, links to pages in the document become section links, and other relative addresses are rebased to the document.

documents

fn documents(pages: &Array[Docgen.Page], books: &Array[Site.Book]) -> Array[Printable]

A printable document for every table of contents whose metadata sets pdf. Each lists its pages in reading order after an optional cover (pdfCoverPage) and contents page (pdfTocPage); pdfFileName names the output beside the table.

Parameters

pages
&Array[Docgen.Page]
books
&Array[Site.Book]

Returns

Array[Printable]

View source

rebase

fn rebase(body: Str, page: Str, document: Str, numbers: &Map[Str, Int], prefix: Str) -> Str

Page HTML moved into a printed document: ids gain a prefix, links to pages in the document become section links, and other relative addresses are rebased to the document.

Parameters

body
Str
page
Str
document
Str
numbers
&Map[Str, Int]
prefix
Str

Returns

Str

View source

Constants

Name Description
FOOTER Footer used when a table names none: the page number over the page count.
const FOOTER: Str

Footer used when a table names none: the page number over the page count.

Type

Str

View source