From 02b8644c17fc8e28e76fb9be1c29f4af890d30da Mon Sep 17 00:00:00 2001 From: Charles Haley Date: Wed, 20 Nov 2024 14:21:09 +0000 Subject: [PATCH] Add summary and escaped tags to documentation --- src/calibre/gui2/dialogs/template_general_info.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/calibre/gui2/dialogs/template_general_info.py b/src/calibre/gui2/dialogs/template_general_info.py index a50c8284df..ae33e27278 100644 --- a/src/calibre/gui2/dialogs/template_general_info.py +++ b/src/calibre/gui2/dialogs/template_general_info.py @@ -116,6 +116,13 @@ program: \[/CODE] \[/LIST] [/CODE] +[*]End of summary marker. A summary is generated from the first characters of +the documentation. The summary includes text up to a \[/] tag. There is no +opening tag because the summary starts at the first character. If there is +no \[/] tag then all the document is used for the summary. The \[/] tag +is not replaced with white space or any other character. +[*]Escaped character: precede the character with a backslash. This is useful +to escape tags. For example to make the \[CODE] tag not a tag, use \\\[CODE]. [*]HTML output contains no CSS and does not start with a tag such as
or

. [/LIST]