Cutlery/calibre
1
0
Fork 0
mirror of https://github.com/kovidgoyal/calibre.git synced 2025-07-09 03:04:10 -04:00
Code Issues Packages Projects Releases Wiki Activity

More wrapping and punctuation

Browse Source 
Why is the long XPATH expression being wrapped in the output?
This commit is contained in:
Joseph Fox-Rabinovitz 2021-01-05 13:26:06 -06:00 committed by GitHub
parent 6912bec1c9
commit 0b4c130126
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
manual/conversion.rst
View File

@ -391,15 +391,18 @@ and their syntax at :ref:`regexptutorial`.
Structure detection
---------------------
Structure detection involves calibre trying its best to detect structural elements in the input document, when they are not properly specified. For example, chapters, page breaks, headers, footers, etc. As you can imagine, this process varies widely from book to book. Fortunately, calibre has very powerful options to control this. With power comes complexity, but if once you take the time to learn the complexity, you will find it well worth the effort.
Structure detection involves calibre trying its best to detect structural elements in the input document, when they are not
properly specified. For example, chapters, page breaks, headers, footers, etc. As you can imagine, this process varies widely
from book to book. Fortunately, calibre has very powerful options to control this. With power comes complexity, but if once you
take the time to learn the complexity, you will find it well worth the effort.
Chapters and page breaks
~~~~~~~~~~~~~~~~~~~~~~~~~~~
calibre has two sets of options for :guilabel:`chapter detection` and :guilabel:`inserting page breaks`. This can sometimes be slightly confusing, as by default,
calibre will insert page breaks before detected chapters as well as the locations detected by the page breaks option.
The reason for this is that there are often location where page breaks should be inserted that are not chapter boundaries.
Also, detected chapters can be optionally inserted into the auto generated Table of Contents.
calibre has two sets of options for :guilabel:`chapter detection` and :guilabel:`inserting page breaks`. This can sometimes be
slightly confusing, as by default, calibre will insert page breaks before detected chapters as well as the locations detected by
the page breaks option. The reason for this is that there are often location where page breaks should be inserted that are not
chapter boundaries. Also, detected chapters can be optionally inserted into the auto generated Table of Contents.
calibre uses *XPath*, a powerful language to allow the user to specify chapter boundaries/page breaks. XPath can seem a little daunting
to use at first, fortunately, there is a :ref:`XPath tutorial <xpath-tutorial>` in the User Manual. Remember that Structure detection
@ -477,7 +480,7 @@ in the :ref:`structure-detection` section above. If you do not want to include d
table of contents, check the :guilabel:`Do not add detected chapters` option.
If less than the :guilabel:`Chapter threshold` number of chapters were detected, calibre will then add any hyperlinks
it finds in the input document to the Table of Contents. This often works well many input documents include a
it finds in the input document to the Table of Contents. This often works well: many input documents include a
hyperlinked Table of Contents right at the start. The :guilabel:`Number of links` option can be used to control
this behavior. If set to zero, no links are added. If set to a number greater than zero, at most that number of links
is added.