Claroline Documentation:Règles de nommage
Un article de Claroline Documentation.
Les conventions exposées ci-dessous valent pour la version française de la documentation Claroline.
| Sommaire |
[modifier]
Conventions de nommage des éléments de l'interface
Dans la documentation en ligne :
- Mettez en gras le nom de tout élément de l'interface (nom de bouton, d'hyperlien, de zone de formulaire telle une case à cocher, etc.).
- Mettez en italiques le nom des éléments des listes déroulantes, les noms de fichiers et les chemins de répertoire.
- Mettez entre guillemets français (« et ») les messages affichés par l'interface.
[modifier]
Conventions stylistiques
- Dans les descriptions de procédure, utilisez de préférence l'impératif à l'infinitif.
[modifier]
Conventions typographiques
Deux-points (:)
- Ne mettez pas de majuscule après les deux-points.
- Séparez les deux-points du mot qui précède par un espace.
Par conséquent, écrivez : Pour vous identifier : tapez votre nom d'utilisateur
plutôt que
Pour vous identifier: Tapez votre nom d'utilisateur.
[modifier]
Conventions terminologiques
Respectez systématiquement la graphie originale des noms propres :
Claroline plutôt que claroline
EasyPHP
MySQL
phpMyAdmin
TeX
