Skip to main content

Bonnes pratiques de rédaction

Insérer un code

Lorsque vous souhaitez insérer un code informatique dans votre page ne faites pas une copie d'écran !

Utilisez l'option de mise en forme adéquate :

bouton-code.png

Vous obtiendrez ainsi un code qui sera lisible, colorisé syntaxiquement, et copiable.

Exemple :

$fn = 50;
/* eprouvette de traction - version 2 */

L = 70;
module forme() {
    union() {
        offset(r = -2) offset(delta = 2){
            translate([0,0]) square([4,L], center = true);
            translate([0,L/2]) square([15,15], center = true);
            translate([0,-L/2]) square([15,15], center = true);
        }
    }
}

linear_extrude(4) difference() {
    forme();
    translate([0,L/2]) circle(d = 3);
    translate([0,-L/2]) circle(d = 3);
}
    

Vous pouvez aussi (et c'est bien de faire les deux) attacher le fichier joint à la page :

eprouvette_v2.scad

Liens hypertextes

Lorsque vous citez une page web, vous ne savez jamais quelle est sa pérennité : elle peut disparaître du jour au lendemain. Votre documentation devient alors illisible.

C'est une bonne pratique d'aller systématiquement sur Internet Archive pour sauvegarder la page qui vous intéresse :

internet-archive-save.png

Vous pouvez ensuite citer la page originale (en sachant qu'on pourra la retrouver) ou citer directement la copie... ou les deux !

Expressions mathématiques

BookStack supporte les expressions en TeX/LaTeX via MathJax, en utilisant les délimiteurs 

$, ou $$, ou \[

$$ \lim_{x\rightarrow\infty} {\sin(x)\over x} = 0$$

limxsin(x)x=0