Overview

Comments in reStructuredText consist of different (nested) text body elements and can be divided into sections with headings.

Starting with an introductory sample, the following sections provide an overview of the syntax of the reStructuredText markup.

In the first part of the description the essential concepts and syntax of reStructuredText are introduced. In the second, more application-oriented part of the description, various commenting options using different syntax elements are explained.

	The correct use of the syntax is a prerequisite for error-free display in the Library Manager. The information presented is based on the contents of the Dokutils documentation (reStructuredText markup specification).

Sample	Samples
General notes (Syntax elements)	Blank lines and indentation Simple and more complex markup Explicit markup blocks Directives Inline markup Escaping mechanism Reference names
Comment structure (Comment structure)	Sections Transitions
Text blocks (Text blocks)	Text block (paragraph) Indented text block (block quote) Line-oriented text block (line block)
Lists (Lists)	Unordered enumeration list Ordered (numbered) enumeration list Definition list Field list
Tables (Tables)	Simple table Grid table CSV table List table
Hyperlinks (Hyperlinks)	Internal hyperlinks External hyperlinks Standalone hyperlinks Embedded URIs and aliases Indirect hyperlinks Inline hyperlinks Anonymous hyperlinks Footnotes Citations
Substitution	Substitution
Note elements (Note elements)	Specific notes Generic notes
Images	Images
Code block	Codeblock
Internal comments	Internal comments
Font style (Font style)	Highlighted text (italic) Highlighted text (bold) Inline literals (monospaced font)