D'autres pages expliquent Mise en page et Boîte à outils avec des exemples de code.
Important |
---|
Adhérer à ces règles typograhiques assurera que votre documentation puisse être exportée précisement et facilement afin d'être traduite. Certaines règles peuvent ne pas être applicables pour d'autres langues. Elles sont donc notées sur des pages spécifiques par langue, voir Processus de Traduction. Si cette page n'existe pas dans votre langue, veuillez l'ajouter et y écrire les règles. |
Utilisez le gras pour mettre en valeur
Par exemple :
Utilisez le texte en italique pour mettre en valeur :
Quelques exemples :
Tip |
---|
Les Programmes sont lancés par les utilisateurs, les composants sont utilisés par les programmes |
Utilisez cette combinaison pour le texte remplaçable ou variable.
Quelques exemples :
ssh
nom-d'utilisateur@domaine.nom dans Konsole.rpm -q
nom_du_paquet renverra paquet-version-release.Le code devrait être présenté sous la forme de texte mono-espacé, en général dans une boîte, comme ci-dessous. Le texte saisi sera sur un fond jaune pale, le texte affiché sera sur un fond gris-violet.
{{Input|1=<nowiki> qdbus org.kde.NepomukServer /nepomukserver org.kde.NepomukServer.quit rm -r ~/.kde/share/apps/nepomuk rm -r ~/.kde4/share/apps/nepomuk nepomukserver</nowiki>}}Il s'affichera comme cela:
qdbus org.kde.NepomukServer /nepomukserver org.kde.NepomukServer.quit rm -r ~/.kde/share/apps/nepomuk rm -r ~/.kde4/share/apps/nepomuk nepomukserver
{{Output|1=<nowiki>l'affichage du terminal est aussi affiché comme du code, mais sur fond gris</nowiki>}}qui s'affichera ainsi
l'affichage du terminal est aussi affiché comme du code, mais sur fond gris
Note |
---|
Notez l'utilisation de 1=<nowiki> du texte </nowiki> . Parfois, des parties d'affichage peuvent déranger le format d'affichage.
Le bloc <nowiki>...</nowiki> protège contre cet effet. Également si quelque chose comme n= apparaît dans le corps du texte, l'affichage du modèle peut être perturbé. Le 1= initial protège contre cet effet. En résumé : il ne peut pas être modifié et il protège contre l'éventualité de dommages collatéraux. |
{{Input|<syntaxhighlight lang="php" line> # Initialisation du code commun $preIP = dirname( __FILE__ ); require_once( "$preIP/includes/WebStart.php" ); </syntaxhighlight>}}affichera
1 # Initialisation du code commun 2 $preIP = dirname( __FILE__ ); 3 require_once( "$preIP/includes/WebStart.php" );
<code></code>Le code It will
s'affichera
comme cela. Notez que si la balise <code> est immédiatement précédée d'un retour à la ligne, elle ne s'affichera pas correctement.Warning |
---|
Le code en ligne devrait être court ! Cela fait bizarre, et moche, si une ligne de code est séparée en deux lignes. Et rappelez-vous : même si cela à l'air bon dans votre navigateur, tout le monde n'a pas la même taille d'écran. Et même si votre texte à l'air bon sur toutes les tailles d'écran, les traductions peuvent toujours en souffrir. Il est recommandé d'utiliser le modèle Input pour le code à moins que celui-ci ne soit vraiment ourt. |
Note |
---|
Veuiller éviter d'utiliser les commands shell ou d'autres mots-clefs de programmation comme des verbes. Ils ne se traduisent pas très bien. Traitez toujours les mots-clefs comme des noms propres. |
Les tags <blockquote> et </blockquote> doivent être utilisés lorsque d'autres travaux ou d'autres pages sont cités. Ils produisent une police italique proportionelle, avec un espacement.
Voici un exemple de ce que vous obtenez en utilisant les balises blockquote.
Même si un des critères ci-dessus peut être atteint, n'utilisez pas de texte en gras dans les en-têtes de section ou dans les liens.
Le texte en gras devrait être évité dans le texte contenu dans ces modèles. Le texte en italique pour mettre en valeur un passage peut toujours être utilisé, mais avec parcimonie afin de maximiser son effet.
De nombreuses listes sont disponibles pour vos pages — à puces, numérotées ou détaillées. Vous pouvez touver tous les détails sur la Boîte à Outils.
Après que votre texte ait été écrit, une balise est automatiquement aajoutée par le système de traduction. Cela signifie que chaque fois qu'il rencontre une ligne vide, il démarre une nouvelle unité. quand votre texte est présenté aux traducteurs, ils examinent habituellement une unité à la fois, aussi il est important de ne pas laisser de ligne vide au milieu d'un contenu qui doit être traité comme un tout. Normalement un paragraphe entier doit être conservé dans une unité simple ; et jamais une phrase ne doit être coupée entre deux unités !
Si vous avez besoin d'un saut de ligne au milieu d'une section, la meilleure manière d'y parvenir sans créer d'autres unités est d'utiliser <br /> à la fin de la ligne où vous souhaitez placer un saut (pas une nouvelle ligne). Si un espace est nécessaire entre les lignes ajoutez <br /><br />.
Le système de traduction marque une unité traduite comme non traduitesi elle contient n'importe quelle sorte de parenthèses non-équilibrées. Si vous avez besoin d'avoir des parenthèses non-équilibrées dans votre texte, veuillez ajouter une parenthèse d'quilibre dans une balise de commentaire, comme ceci :
<!-- }} -->{{ Une ligne Une autre ligne}}<!-- {{ -->
Cela vaut pour toutes sortes de parenthèses, même pour les parenthèses ordinaires. (bien entendu, il est préférable d'aviter les lignes vides à l'intérieur d'une balise d'unité - voir Garder les contenus ensembles.)
{{Input|1=cmd1 {{!}} cmd2}}
qui affice cmd1 | cmd2
{{Input|cmd1 | cmd2}}
vous obtiendrez à la place cmd1
car le problème est que cmd2
est considéré comme un second paramètre pour le modèle, qui dans ce cas n'est pas utilisé.
{{Input|1=<nowiki>cmd1 | cmd2</nowiki>}}
, ce qui affichera également cmd1 | cmd2
tout ce qui est traduisible est contenu entre les balises <translate> et </translate> . Dans beaucoup de cas, des images peuvent être contenues dans la partie traduisible, car il est parfois nécessaire d'utiliser des versions localisées des images pour expliquer un point. La règle des vignettes est "Ien cas de doute, inclus là !".