Cutlery/calibre
1
0
Fork 0
mirror of https://github.com/kovidgoyal/calibre.git synced 2025-06-23 15:30:45 -04:00
Code Issues Packages Projects Releases Wiki Activity

Add summary and escaped tags to documentation

Browse Source
This commit is contained in:
Charles Haley 2024-11-20 14:21:09 +00:00
parent 593e0f45c7
commit 02b8644c17
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/calibre/gui2/dialogs/template_general_info.py
View File

@ -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 <DIV> or <P>.
[/LIST]