summaryrefslogtreecommitdiff
path: root/MANUAL.txt
diff options
context:
space:
mode:
authorJohn MacFarlane <jgm@berkeley.edu>2023-01-30 18:41:44 -0800
committerJohn MacFarlane <jgm@berkeley.edu>2023-01-30 21:09:02 -0800
commit8fc4fc66a31a7a13db9072ebdf0c3f017d6ec51e (patch)
treebdef1df49034727a5cb1cf4821aa7e92a306c006 /MANUAL.txt
parent1193bb59641f0fa0ab033d0382916be4c83e07da (diff)
Add new `--chunk-template` option (closes #8581).
* Add `--chunk-template` CLI option, allowing more control over the chunk filenames in chunked HTML output. * Text.Pandoc.App: Add `optChunkTemplate` constructor to Opt [API change]. * Text.Pandoc.Options: add `writerChunkTemplate` contsructor to WriterOptions [API change]. * Text.Pandoc.Chunks: add Data, Typeable, Generic instances for PathTemplate.
Diffstat (limited to 'MANUAL.txt')
-rw-r--r--MANUAL.txt11
1 files changed, 11 insertions, 0 deletions
diff --git a/MANUAL.txt b/MANUAL.txt
index 751dc2c5b..0d6ce597b 100644
--- a/MANUAL.txt
+++ b/MANUAL.txt
@@ -1261,6 +1261,17 @@ header when requesting a document from a URL:
level of 2 or 3. For chunked HTML, this option determines
how much content goes in each "chunk."
+`--chunk-template=`*PATHTEMPLATE*
+
+: Specify a template for the filenames in a `chunkedhtml` document.
+ In the template, `%n` will be replaced by the chunk number (padded
+ with leading 0s to 3 digits), `%s` with the section number of the chunk,
+ `%h` with the heading text (with formatting removed), `%i` with
+ the section identifier. For example, `%section-%s-%i.html` might
+ be resolved to `section-1.1-introduction.html`. The characters
+ `/` and `\` are not allowed in chunk templates and will be
+ ignored. The default is `%s-%i.html`.
+
`--epub-chapter-level=`*NUMBER*
: *Deprecated synonym for `--split-level`.*