|
|
13.
|
|
|
Most screenshots are added with the *figure* directive:
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:25
|
|
|
14.
|
|
|
Example of including a screenshot
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:74
|
|
|
15.
|
|
|
The first line provides the path to the file. The \* replaces the file extension and Sphinx chooses the file that is most appropriate. Thus, files could have different image extensions or you could have the same screenshots in different file formats that are then chosen by the programme to best suit the end format of the manual.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:32
|
|
|
16.
|
|
|
The second line represents the alt text that is dispalayed when hovering over the image, when no images are displayed or when viewing the page via a screen reader.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:33
|
|
|
17.
|
|
|
The third line must follow an empty line. This is the text that is displayed below the screenshot as figure description. In the PDF output, the descriptions will be numbered continuously.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:84
|
|
|
18.
|
|
|
If you want to include an image inline with the text and don't want to or can't use the regular figure, you should create a substitution and place it into the shortcuts.rstext file.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:47
|
|
|
19.
|
|
|
Admonitions in use are
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:100
|
|
|
20.
|
|
|
**note**: for anything that should receive a bit more attention
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:102
|
|
|
21.
|
|
|
Notes can be placed directly within a bulleted list. As usual, an empty line before and after the note must be placed and the admonition must be indented by 3 spaces.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:105
|
|
|
22.
|
|
|
**warning**: for anything that needs to be done with caution
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:107
|
