docs: document outline-title and attachment-title parameters

This commit is contained in:
2026-01-21 21:54:20 +02:00
parent 102c63925e
commit 9d5d4209bd

View File

@@ -33,6 +33,8 @@ configure the whole document and `attachment` helper function. Important argumen
`text` (content) and `keywords` (array) as well as `title`, `lang` and `keyword-title`. `text` (content) and `keywords` (array) as well as `title`, `lang` and `keyword-title`.
- `bibliography`: Result of `bibliography("path/to/file.yml")` or `none`. - `bibliography`: Result of `bibliography("path/to/file.yml")` or `none`.
- `attachments`: Tuple of `attachment(...)` items (tables, figures). All attachments must be referenced in the document body to appear in the outline. - `attachments`: Tuple of `attachment(...)` items (tables, figures). All attachments must be referenced in the document body to appear in the outline.
- `outline-title`: Title for the table of contents. Defaults to `"Saturs"`.
- `attachment-title`: Title for the attachments section. Defaults to `"Pielikumi"`.
- `display-documentary`: Whether to display the documentary page at the end. Defaults to `true`. - `display-documentary`: Whether to display the documentary page at the end. Defaults to `true`.
- `description`: Document description for PDF metadata. Defaults to `none`. - `description`: Document description for PDF metadata. Defaults to `none`.
- Positional argument: the document body follows the `ludf.with(...)` call. - Positional argument: the document body follows the `ludf.with(...)` call.