-
Notifications
You must be signed in to change notification settings - Fork 3
Closed
Description
At the moment there are some naming conventions:
The YAML settings documents, pages, images and templates have to be called exactly that, so does variants.
So do special settings like compress_pdf and svg2pdf_backend.
That is all fine and we don't have to go meta on it.
Technically configurable but in my opinion also ok to prescribe:
styleandthemehave to be called exactly thathighlight_colorhas to be called exactly that (and the tag it replaces has to be<highlight>)bake.pyhas to be called exactly that, and has to define aprocess_document()function taking aPDFBakerDocument
However:
documentsare just names, and for each document a directory has to exist by that nameconfig.ymlmust be the filename of the document configuration - it must exist in that directorypagesare just names, and for each page there has to be a.ymlfile insidepages/imagesare file names, and for each image a corresponding file has to be insideimages/templatesare file names, and for each template a corresponding file has to be insideimages/- the build directory is always
buildon the same level as the main config file - the dist directory is always
diston the same level as the main config file
(I may have overlooked other naming conventions.)
That's a little bit restrictive and black magic - some of these files might already exist in other locations and shouldn't have to move.
Therefore:
- For every document, allow to split so it has a "name", "file" and/or "config_file" - the latter two being relative or absolute paths (but "relative" to the main config file).
- For every page, allow to split up so it has a "name" and a "file" (again relative/absolute path to the config file)
- For every image, allow to split up - that's already possible for providing "type" - so it also has a "file" (again relative/absolute path to the image file)
- For every template, allow to split up so it has a "name" and a "file" (again relative/absolute path to the template file)
- Allow the configuration of the build directory in the main configuration file (name or path)
- Allow the configuration of the dist directory in the main configuration file (name or path)
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels