Skip to content

Commit 8de9fc8

Browse files
dannyadairdannyadair
committed
docs: clarify page template setting
1 parent c83f5c5 commit 8de9fc8

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

‎docs/configuration.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ At least `filename` and `pages` has to be specified.
9393
| Option | Type | Default | Description |
9494
| --------------------------- | ------- | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
9595
| _any main setting_ | | | Any of the Main Configuration File settings can be overridden for a particular document. `directories.base` is now the directory containing the document configuration file. |
96-
| `name` | string | as per main config `documents` | Name of the document. If a simple string or `name` was specified then that will be name. If a directory was specified it will be the name of the directory. If a config file was specified it will be the file name without extension. |
96+
| `name` | string | as per main config `documents` | Name of the document. If a simple string or `name` was specified then that will be the name. If a directory was specified it will be the name of the directory. If a config file was specified it will be the file name without extension. |
9797
| `filename` **required** | string | | Filename (without extension) of the final PDF document. Can use variables, particularly `variant` (see [Variants](variants.md)) |
9898
| `pages` **required** | array | | List of page configurations. A simple string specifies a file by the same name with `.yaml` extension in the document's _pages_ directory. You can also specify a `path` and `name` to a specific file (absolute or relative to the document's base directory). |
9999
| `variants` | array | | List of document variants (see [Variants](variants.md)). These are their own sections which will be merged with the document configuration. During processing, `variant` will hold the current variant configuration. |
@@ -123,14 +123,14 @@ pages:
123123

124124
At least `template` has to be specified.
125125

126-
| Option | Type | Default | Description |
127-
| ------------------------------ | ------- | ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
128-
| _any main or document setting_ | | | Any of the Main/Document Configuration File settings can be overridden for a particular page. `directories.base` is now the directory containing the page configuration file. |
129-
| `name` | string | as per document config `pages` | Name of the page. If a simple string or `name` was specified then that will be name. If a directory was specified it will be the name of the directory. If a config file was specified it will be the file name without extension. |
130-
| `template` **required** | string | | Filename of the SVG template (must be in the document's `templates/` directory) |
131-
| `images` | array | | List of images to use in the page. Each image must have a `name` (filename in the document's `images/` directory) and optionally a `type` (defaults to "default") |
132-
| `page_number` **readonly** | integer | | The number of the current page within its document |
133-
| _additional custom setting_ | | | Any settings you want to make available to this page. This allows you to have a template purely for layout purposes. |
126+
| Option | Type | Default | Description |
127+
| ------------------------------ | ------- | ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
128+
| _any main or document setting_ | | | Any of the Main/Document Configuration File settings can be overridden for a particular page. `directories.base` is now the directory containing the page configuration file. |
129+
| `name` | string | as per document config `pages` | Name of the page. If a simple string or `name` was specified then that will be the name. If a directory was specified it will be the name of the directory. If a config file was specified it will be the file name without extension. |
130+
| `template` **required** | string | | The SVG template to use. A simple string specifies the name of a file under `directories.templates`. You can also specify `path` to a specific template file. These usually end in `.svg.j2` to indicate that they are Jinja2 templates creating SVG files. |
131+
| `images` | array | | List of images to use in the page. Each image must have a `name` (filename in the document's `images/` directory) and optionally a `type` (defaults to "default") |
132+
| `page_number` **readonly** | integer | | The number of the current page within its document |
133+
| _additional custom setting_ | | | Any settings you want to make available to this page. This allows you to have a template purely for layout purposes. |
134134

135135
<details>
136136
<summary>Example Page Configuration File</summary>

0 commit comments

Comments
 (0)