Outils pour utilisateurs

Outils du site


wiki:conventions

Syntaxe

Pour la syntaxe officielle, voir le site de Dokuwiki.

Conventions typographiques

Pour distinguer les éléments et faciliter la lecture du texte de documentation, il est de mise d'utiliser une convention, ou une standardisation du texte dans les documents.

Code

Le code dans un document sera écrit avec une police à espacement constant. Pour du code tenant sur une ligne, ce style sera utilisé inséré dans une phrase ou une ligne d'un style normal. Avec du code sur plusieurs lignes, on utilisera, par exemple, ce style :

#include <stdio.h>
#include <conio.h>
 
main () {
  printf("Hello World!");
}

Commandes

  • Les commandes sont écrites en caractères mono-spaced.
  • Pour les commandes Linux/Unix/Mac OS X, un # devant la commande dénote une commande qui doit être exécutée en mode privilégié. Sinon on verra $. On peut voir $ avec un sudo.
    $ sudo commande
  • Les crochets [] dénotent un paramètre optionnel.
    $ commande [parametre-optionnel]
  • Les accolades {} dénotent un choix avec une barre (ou pipe, |) pour séparer les choix.
    $ commande verbose={true|false}

Équations mathématiques

Soit:

  • Full size : 18pt avec exportation à 100% (préférable)
  • Full size : 12pt avec exportation à 200%
  • 10pt avec exportation à 200%
  • Inline
    • Export : 18pt à 100%
    • Utiliser style="vertical-align:middle;"
    • <html><img style="vertical-align:middle;" src="/wiki/lib/exe/fetch.php/math:calcul_integral:dy_fxdx.gif" alt="" /></html>
  • Encadrés de théorèmes :
    <html><div style="background-color:#ddd;width:50%;margin-left:25%;padding:5px;border:1px solid #aaa"></html>
    <html><div class="theoreme"></html>
    • #aaa = CMYK 0% 0% 0% 33% = RGB 170,170,170
    • #ccc = CMYK 0% 0% 0% 20% = RGB 204,204,204
    • #ddd = CMYK 0% 0% 0% 13,3% = RGB 221,221,221

Citations et références

  1. Bouthat, Chantal. 1993. Guide de présentation des mémoires et thèses. Montréal : Université du Québec à Montréal. Décanat des études avancées et de la recherche, 110 p.

CSS personnalisé pour ce wiki

div.theoreme {
	background-color:#ddd;
	width:50%;
	margin-left:25%;
	padding:5px;
	border:2px solid #aaa;
}

div.demarche {
	background-color:#fff;
	width:50%;
	margin-left:25%;
	padding:5px;
	border:2px solid #aaa;
}

div.taparte {
	text-align:center;
	margin:5px;
	border:1px dotted #aaa;
}
wiki/conventions.txt · Dernière modification : 2023/09/25 17:34 de sgariepy