|
|
14.
|
|
|
Example of including a screenshot
|
|
|
|
|
Exemple d'inclusion d'une copie d'écran
|
|
Translated and reviewed by
Dominique-Alain JAN
|
|
|
|
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.
|
|
|
|
|
La première ligne indique le chemin pour atteindre le fichier de l'image. Le \* remplace l'extension du fichier, de ce fait Sphinx choisit le format le plus approprié pour chaque fichier. De ce fait, chaque image peut être proposée avec différentes extensions, dans différentes qualités, qui seront choisies automatiquement en fonction de l'usage et du périphérique de sortie (écran, imprimante, affichage dans le navigateur web, création d'un document PDF ou ePub).
|
|
Translated and reviewed by
Dominique-Alain JAN
|
|
|
|
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.
|
|
|
|
|
La deuxième ligne contient le texte «alt» qui sera affiché quand l'utilisateur placera sa souri au-dessus de l'image ou lorsque l'image ne sera pas affichée, notamment dans le cas où l'utilisateur accède la page avec un logiciel d'aide à la lecteur pour mal-voyant.
|
|
Translated and reviewed by
Dominique-Alain JAN
|
|
|
|
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.
|
|
|
|
|
La troisième ligne doit être placée après une ligne vide. Elle contient la description qui doit être affiché sous la copie d'écran. Lorsque un document PDF est créé à partir de la documentation sur le web, les descriptions seront numérotées de manière continue.
|
|
Translated and reviewed by
Dominique-Alain JAN
|
|
|
|
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.
|
|
|
|
|
Si vous désirez inclure une image non pas entre des lignes de texte, mais au milieux d'elles, ou que vous ne pouvez ou voulez pas utiliser la forme régulière des copies d'écran, vous devez créer une substitutions et la placer dans le fichier shortcuts.rstext.
|
|
Translated and reviewed by
Dominique-Alain JAN
|
|
|
|
Located in
../source/documentation_info.rst:47
|
|
|
19.
|
|
|
Admonitions in use are
|
|
|
|
|
Types d'alertes utilisées dans la documentation
|
|
Translated and reviewed by
Dominique-Alain JAN
|
|
|
|
Located in
../source/documentation_info.rst:100
|
|
|
20.
|
|
|
**note**: for anything that should receive a bit more attention
|
|
|
|
|
**note** : pour tout ce qui doit retenir un peu plus l'attention des lecteurs
|
|
Translated and reviewed by
Dominique-Alain JAN
|
|
|
|
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.
|
|
|
|
|
Les notes peuvent être intégrées directement sous forme de listes à puces. Comme d'habitude, une ligne vide doit précéder et suivre la liste. La note doit être indentée par 3 espaces.
|
|
Translated and reviewed by
Dominique-Alain JAN
|
|
|
|
Located in
../source/documentation_info.rst:105
|
|
|
22.
|
|
|
**warning**: for anything that needs to be done with caution
|
|
|
|
|
**warning** : pour tout ce qui doit être effectué et qui peut comporter un risque (par exemple : perte de donnée, impossibilité de revenir en arrière, ...)
|
|
Translated and reviewed by
Dominique-Alain JAN
|
|
|
|
Located in
../source/documentation_info.rst:107
|
|
|
23.
|
|
|
Try not to put everything into an admonition because then the truly important information is lost.
|
|
|
|
|
Essayez de ne pas mettre trop d'informations dans la note, car l'essentiel risque d'être alors noyé dans la masse.
|
|
Translated and reviewed by
Dominique-Alain JAN
|
|
|
|
Located in
../source/documentation_info.rst:110
|
