summaryrefslogtreecommitdiff
path: root/README.adoc
diff options
context:
space:
mode:
authorMarat Radchenko <marat@slonopotamus.org>2020-04-17 01:39:21 +0300
committerGitHub <noreply@github.com>2020-04-17 01:39:21 +0300
commit1fa8d7c40e1098c9875752fd7ed295350054d3f6 (patch)
tree2a93e7a572131958c3ef7299168e50df48c452de /README.adoc
parent65f8f4b3ab73a03ffe1b232453ea04c621f3d4e2 (diff)
resolves #327 add customizable splitting into chapters (#328)
Diffstat (limited to 'README.adoc')
-rw-r--r--README.adoc6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.adoc b/README.adoc
index 5a37061..903df68 100644
--- a/README.adoc
+++ b/README.adoc
@@ -297,6 +297,12 @@ The recommended practice is to identify the referenced resource by means of a st
|An optional override of the properties attribute for this document's item in the manifest.
_Only applies to a chapter document._
+|epub-chapter-level
+|Specify the section level at which to split the EPUB into separate "chapter" files.
+The default is to split into chapters at level-1 sections.
+This option only affects the internal composition of the EPUB, not the way chapters and sections are displayed to users.
+Some readers may be slow if the chapter files are too large, so for large documents with few level-1 headings, one might want to use a chapter level of 2 or 3.
+
|series-name, series-volume, series-id
|Populates the series statements (`belongs-to-collection`) in the package metadata.
Volume is a number, ID probably a UUID that is constant for all volumes in the series.