Difference between revisions of "How to format article"

From EN Ikoula wiki
⧼vector-jumptonavigation⧽ ⧼vector-jumptosearch⧽
Line 1: Line 1:
<span data-link_translate_fr_title="Comment formater son article"  data-link_translate_fr_url="Comment_formater_son_article"></span>[[:fr:Comment formater son article]][[fr:Comment formater son article]]
+
 
  
 
This article has been created by an automatic translation software. You can view the article source [[:fr:Comment formater son article|here]].<br /><span data-translate="fr"></span>
 
This article has been created by an automatic translation software. You can view the article source [[:fr:Comment formater son article|here]].<br /><span data-translate="fr"></span>
Line 7: Line 7:
  
 
<!--T:1-->
 
<!--T:1-->
This article describes how to format your tutorial. By following this guide and one on the [[Comment rédiger un article pour la communauté iKoula | writing style]], your tutorial will apply the recommendations of {{iKoula }}.
+
Cet article explique comment formater votre tutoriel. En suivant ce guide et celui sur le [[:fr:Comment rédiger un article pour la communauté iKoula | writing style]], votre tutoriel appliquera les recommandations d'{{iKoula}}.
  
  
==Wiki syntax == <!--T:2-->
+
==Syntaxe wiki== <!--T:2-->
  
 
<!--T:3-->
 
<!--T:3-->
Tutorials {{iKoula }} must be formatted using the [http://www.mediawiki.org/wiki/Help:Formatting wiki syntax].
+
Les tutoriels {{iKoula}} doivent être formaté en utilisant la [http://www.mediawiki.org/wiki/Help:Formatting wiki syntax].
This article will give yor the most common examples of this syntax. Yor can find more details in the [http://www.mediawiki.org/wiki/Help:Formatting mediawiki help section] as for the wiki formatting.
+
Cet article va vous donner les exemples les plus courants de cette syntaxe. Vous trouverez plus de détails dans la [http://www.mediawiki.org/wiki/Help:Formatting mediawiki help section] quant au formatage wiki.
  
  
==Chapters == <!--T:4-->
+
==Chapitres== <!--T:4-->
To cut your tutorials into chapters, yor can use the levels of title. As soon as yor put a title in the page, all of the following items will be considered as part of the new chapter, until the next title of the same level.<br />
+
Pour sectionner vos tutoriels en chapitres, vous pouvez utiliser les niveaux de titre. Dès que vous placez un titre dans la page, tous les éléments suivants seront considérés comme faisant partie du nouveau chapitre, jusqu'au prochain titre de même niveau.<br />
This can be very useful to improve the readability of your article by cutting out the different stages of realization.<br />
+
Cela peut être très utile pour améliorer la lisibilité de votre article en découpant les différentes étapes de réalisation.<br />
  
===The different levels of title === <!--T:5-->
+
===Les différents niveaux de titre=== <!--T:5-->
  
 
<!--T:6-->
 
<!--T:6-->
The title of level 1 corresponds to the title of the article. It is created automatically when yor create your page. The tracks are built around your title by signs "'''='''". The title of level 2 corresponds to the first title of chapter or section. <br />
+
Le titre de niveau 1 correspond au titre de l'article. Il est créé automatiquement lorsque vous créez votre page. Les autres titres se construisent en entourant votre titre par des signes "'''='''". Le titre de niveau 2 correspond au premier titre de chapitre ou section. <br />
Example for the title of this section :<br />
+
Exemple pour le titre de cette section :<br />
  <nowiki             >==Chapters ==</nowiki><br />
+
  <nowiki>==Chapitres==</nowiki><br />
  
More you'll sign around your title, the more yor go down the tree.<br />
+
Plus vous mettrez de signe autour de votre titre, plus vous descendrez dans l'arborescence.<br />
{| style="width                     :100%"
+
{| style="width:100%"
! style="width                     : 50%;"|Example
+
! style="width: 50%;"|Exemple
! style="width                     : 50%;"|Result
+
! style="width: 50%;"|Résultat
 
|-
 
|-
| style="padding                 : 5PX ;"|
+
| style="padding: 5px;"|
  <nowiki             >===Level title 3===</nowiki>
+
  <nowiki>===Titre de niveau 3===</nowiki>
  <nowiki             >====Level title 4====</nowiki>
+
  <nowiki>====Titre de niveau 4====</nowiki>
  <nowiki             >=====Level title 5=====</nowiki>
+
  <nowiki>=====Titre de niveau 5=====</nowiki>
| style="padding                 : 5PX ;"|
+
| style="padding: 5px;"|
===Level title 3=== <!--T:7-->
+
===Titre de niveau 3=== <!--T:7-->
====Level title 4====
+
====Titre de niveau 4====
=====Level title 5=====
+
=====Titre de niveau 5=====
 
|}
 
|}
 
<br />
 
<br />
It is worth noting that a table of contents automatically appears at the head of article as soon as there are at least 4 chapters or subchapters.
+
Il est à noter qu'une table des matière s'affiche automatiquement en tête d'article dès qu'il y a au moins 4 chapitres ou sous-chapitres.
 
<br /><br />
 
<br /><br />
  
==Styles == <!--T:56-->
+
==Styles== <!--T:56-->
  
Yor can format your text using wiki syntax and a few HTML tags.
+
Vous pouvez formater votre texte en utilisant la syntaxe wiki et quelques balises HTML.
 
<br />
 
<br />
===Bold === <!--T:8-->
+
===Gras=== <!--T:8-->
  
 
<!--T:9-->
 
<!--T:9-->
Here's how to end bold in your article.
+
Voici comment mettre un terme en gras dans votre article.
 
<br />
 
<br />
{| style="width                     :100%"
+
{| style="width:100%"
! style="width                     : 50%;"|Example
+
! style="width: 50%;"|Exemple
! style="width                     : 50%;"|Result
+
! style="width: 50%;"|Résultat
 
|-
 
|-
| style="padding                 : 5PX ;"|
+
| style="padding: 5px;"|
  <nowiki             >'''bold text '''</nowiki>
+
  <nowiki>'''texte en gras'''</nowiki>
| style="padding                 : 5PX ;"|
+
| style="padding: 5px;"|
'''bold text '''
+
'''texte en gras'''
 
|}
 
|}
 
<br />
 
<br />
Here is a list of items that should be in bold.
+
Voici une liste d'éléments qui devraient être en gras.
* Visible text of a GUI  
+
* Texte visible d'une GUI
* Change of context for a control, such as changing user or server
+
* Changement de contexte pour une commande, tel que changer d'utilisateur ou de serveur
* Hostnames as '''Server - 1'''
+
* Noms d'hôte comme '''serveur-1'''
* Users like '''ikoula '''
+
* Utilisateurs comme '''ikoula'''
* Quick
+
* Prompts
* List of terms, as :
+
* Liste de termes, comme :
** '''MySQL ''': database engine
+
** '''MySQL''': moteur de base de données
** '''Apache ''': webserver
+
** '''Apache''': serveur web
* Elements that the player should not miss, make it without too much.
+
* Eléments que le lecteur ne doit pas rater, sans trop en faire.
 
<br />
 
<br />
  
===Italic === <!--T:10-->
+
===Italique=== <!--T:10-->
  
 
<!--T:11-->
 
<!--T:11-->
Italics should only be used to introduce technical terms. E.g. : the nginx Server will be used as ''reverse proxy ''.
+
L'italique ne devrait être utilisé que pour introduire les termes techniques. Ex. : le serveur nginx sera utilisé comme ''reverse proxy''.
 
<br />
 
<br />
{| style="width                     :100%"
+
{| style="width:100%"
! style="width                     : 50%;"|Example
+
! style="width: 50%;"|Exemple
! style="width                     : 50%;"|Result
+
! style="width: 50%;"|Résultat
 
|-
 
|-
| style="padding                 : 5PX ;"|
+
| style="padding: 5px;"|
  <nowiki             >''italicized text ''</nowiki>
+
  <nowiki>''texte en italique''</nowiki>
| style="padding                 : 5PX ;"|
+
| style="padding: 5px;"|
''italicized text ''
+
''texte en italique''
 
|}
 
|}
 
<br />
 
<br />
  
===Notes and warnings === <!--T:12-->
+
===Notes et avertissements=== <!--T:12-->
  
 
<!--T:13-->
 
<!--T:13-->
The use of some HTML tags may be necessary to highlight certain elements such as notes or warnings.
+
L'utilisation de certaines balises HTML peut être nécessaire pour mettre en évidence certains éléments tels que des notes ou des avertissements.
 
<br />
 
<br />
{| style="width                     :100%"
+
{| style="width:100%"
! style="width                     : 50%;"|Example
+
! style="width: 50%;"|Exemple
! style="width                     : 50%;"|Result
+
! style="width: 50%;"|Résultat
 
|-
 
|-
| style="padding                 : 5PX ;"|
+
| style="padding: 5px;"|
 
<syntaxhighlight lang="html4strict">
 
<syntaxhighlight lang="html4strict">
 
<div style="background-color: #FFCC99;"> '''Note''': Ceci est une note.</div>
 
<div style="background-color: #FFCC99;"> '''Note''': Ceci est une note.</div>
Line 110: Line 110:
 
<div style="background-color: #FF9999;"> '''Warning''': Ceci est un avertissement.</div>
 
<div style="background-color: #FF9999;"> '''Warning''': Ceci est un avertissement.</div>
 
</syntaxhighlight>
 
</syntaxhighlight>
| style="padding                 : 5PX ;"|
+
| style="padding: 5px;"|
 
<div style="background-color: #FFCC99;">'''Note''': Ceci est une note.</div>
 
<div style="background-color: #FFCC99;">'''Note''': Ceci est une note.</div>
 
<br />
 
<br />
Line 117: Line 117:
 
<br /><br />
 
<br /><br />
  
===Blockquotes === <!--T:14-->
+
===Blockquotes=== <!--T:14-->
  
 
<!--T:15-->
 
<!--T:15-->
The ''blockquotes '' are blocks where your text is formatted differently. To do this, simply place a space at the beginning of sentence, or enclose your text from tags <nowiki             ><pre></nowiki>. Votre texte sera alors formaté dans un cadre avec une police différente.
+
Les ''blockquotes'' sont des blocs où votre texte est formaté différemment. Pour cela, il suffit de placer un espace en début de phrase, ou d'encadrer votre texte des balises <nowiki><pre></nowiki>. Votre texte sera alors formaté dans un cadre avec une police différente.
 
<br />
 
<br />
{| style="width                     :100%"
+
{| style="width:100%"
! style="width                     : 50%;"|Example
+
! style="width: 50%;"|Exemple
! style="width                     : 50%;"|Result
+
! style="width: 50%;"|Résultat
 
|-
 
|-
| style="padding                 : 5PX ;"|
+
| style="padding: 5px;"|
<nowiki             > Important text ''italic ''</nowiki><br />
+
<nowiki> Texte important ''italique''</nowiki><br />
or <br />
+
ou <br />
<nowiki             ><pre>Texte important ''italic ''</pre></nowiki>
+
<nowiki><pre>Texte important ''italique''</pre></nowiki>
| style="padding                 : 5PX ;"|
+
| style="padding: 5px;"|
  Important text ''italic ''
+
  Texte important ''italique''
or <br />
+
ou <br />
<pre>Texte important ''italic ''</pre>
+
<pre>Texte important ''italique''</pre>
 
|}
 
|}
As you noted, the use of the tag <nowiki             ><pre></nowiki> fait que tout autre formatage à l'intérieur du bloc sera ignoré et considéré comme du texte à afficher. Si vous utilisez la première méthode, avec l'espace en début de ligne, sachez qu'un retour à la ligne fermera le cadre.<br />
+
Comme vous pouvez le noter, l'utilisation de la balise <nowiki><pre></nowiki> fait que tout autre formatage à l'intérieur du bloc sera ignoré et considéré comme du texte à afficher. Si vous utilisez la première méthode, avec l'espace en début de ligne, sachez qu'un retour à la ligne fermera le cadre.<br />
Nous préconisons d'use the tag [[#Code_source|GeSHi]] or la méthode des [[#Notes_et_avertissements|notes et avertissements]] pour afficher du code source or des informations importantes.
+
Nous préconisons d'utiliser la balise [[#Code_source|GeSHi]] ou la méthode des [[#Notes_et_avertissements|notes et avertissements]] pour afficher du code source ou des informations importantes.
 
<br />
 
<br />
  
Line 142: Line 142:
  
 
<!--T:17-->
 
<!--T:17-->
Lorsque vous publiez un code source, vous devez appliquer la balise <nowiki             ><syntaxhighlight></nowiki>. Cela permettra à votre code de bénéficier d'une coloration syntaxique, le rendant plus lisible. Afin d'adapter la coloration au langage utilisé, ajoutez l'option ''lang="langage"'' dans la balise.
+
Lorsque vous publiez un code source, vous devez appliquer la balise <nowiki><syntaxhighlight></nowiki>. Cela permettra à votre code de bénéficier d'une coloration syntaxique, le rendant plus lisible. Afin d'adapter la coloration au langage utilisé, ajoutez l'option ''lang="langage"'' dans la balise.
 
<br />
 
<br />
{| style="width                     :100%"
+
{| style="width:100%"
! style="width                     : 50%;"|Example
+
! style="width: 50%;"|Exemple
! style="width                     : 50%;"|Result
+
! style="width: 50%;"|Résultat
 
|-
 
|-
| style="padding                 : 5PX ;"|
+
| style="padding: 5px;"|
<nowiki             ><syntaxhighlight lang="php"></nowiki><br />
+
<nowiki><syntaxhighlight lang="php"></nowiki><br />
<nowiki             ><?</nowiki><br />
+
<nowiki><?</nowiki><br />
&nbsp;&nbsp;&nbsp;&nbsp;<nowiki             >    $hello = "Hello World";</nowiki><br />
+
&nbsp;&nbsp;&nbsp;&nbsp;<nowiki>    $hello = "Hello World";</nowiki><br />
&nbsp;&nbsp;&nbsp;&nbsp;<nowiki             >    echo $hello;        // comment</nowiki><br />
+
&nbsp;&nbsp;&nbsp;&nbsp;<nowiki>    echo $hello;        // comment</nowiki><br />
<nowiki             >?></nowiki><br />
+
<nowiki>?></nowiki><br />
<nowiki             ></syntaxhighlight></nowiki>
+
<nowiki></syntaxhighlight></nowiki>
| style="padding                 : 5PX ;"|
+
| style="padding: 5px;"|
 
<syntaxhighlight lang="php">
 
<syntaxhighlight lang="php">
 
<?
 
<?
Line 164: Line 164:
 
|}
 
|}
 
<br />
 
<br />
Vous trouverez sur le site de l'extension [http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi GeSHi] la liste des langages supportés et quelques options supplémentaires, telle l'ajout de numéros de ligne or la mise en évidence d'une ligne dans le code.
+
Vous trouverez sur le site de l'extension [http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi GeSHi] la liste des langages supportés et quelques options supplémentaires, telle l'ajout de numéros de ligne ou la mise en évidence d'une ligne dans le code.
 
<br /><br />
 
<br /><br />
  
Line 172: Line 172:
 
Lorsque vous mentionnez une application, préférez utiliser la capitalisation du site officiel. Si le site web n'est pas consistent, choisissez une forme et essayez de l'être dans votre article.
 
Lorsque vous mentionnez une application, préférez utiliser la capitalisation du site officiel. Si le site web n'est pas consistent, choisissez une forme et essayez de l'être dans votre article.
 
<br />
 
<br />
Par contre, ne capitalisez pas les noms de paquets or des commandes, si ces derniers ne le sont pas.
+
Par contre, ne capitalisez pas les noms de paquets ou des commandes, si ces derniers ne le sont pas.
 
<br />
 
<br />
Example  :<br />
+
Exemple :<br />
  A MySQL database vs. the mysql command or the mysql-server package.
+
  A MySQL database vs. the mysql command or the mysql-server package.
 
<br /><br />
 
<br /><br />
  
Line 188: Line 188:
 
* les prérequis
 
* les prérequis
 
* les checklists
 
* les checklists
{| style="width                     :100%"
+
{| style="width:100%"
! style="width                     : 50%;"|Example
+
! style="width: 50%;"|Exemple
! style="width                     : 50%;"|Result
+
! style="width: 50%;"|Résultat
 
|-
 
|-
| style="padding                 : 5PX ;"|
+
| style="padding: 5px;"|
  <nowiki             >* élément 1
+
  <nowiki>* élément 1
 
* élément 2</nowiki>
 
* élément 2</nowiki>
| style="padding                 : 5PX ;"|
+
| style="padding: 5px;"|
 
* élément 1
 
* élément 1
 
* élément 2
 
* élément 2
Line 206: Line 206:
 
Ces listes sont utiles pour :
 
Ces listes sont utiles pour :
 
* les termes et explications
 
* les termes et explications
* explications pour les variables dans une ligne de commande or un fichier
+
* explications pour les variables dans une ligne de commande ou un fichier
{| style="width                     :100%"
+
{| style="width:100%"
! style="width                     : 50%;"|Example
+
! style="width: 50%;"|Exemple
! style="width                     : 50%;"|Result
+
! style="width: 50%;"|Résultat
 
|-
 
|-
| style="padding                 : 5PX ;"|
+
| style="padding: 5px;"|
  <nowiki             >;mot 1
+
  <nowiki>;mot 1
 
: définition 1
 
: définition 1
 
;mot 2
 
;mot 2
 
: définition 2-1
 
: définition 2-1
 
: définition 2-2</nowiki>
 
: définition 2-2</nowiki>
| style="padding                 : 5PX ;"|
+
| style="padding: 5px;"|
 
;mot 1
 
;mot 1
 
: définition 1
 
: définition 1
Line 229: Line 229:
  
 
<!--T:26-->
 
<!--T:26-->
The listes ordonnées sont à utiliser avec parcimonie. Elles peuvent s'avérer pratiques pour lister l'ordre d'un processus, tel que le traitement d'une requête DNS.
+
Les listes ordonnées sont à utiliser avec parcimonie. Elles peuvent s'avérer pratiques pour lister l'ordre d'un processus, tel que le traitement d'une requête DNS.
 
<br />
 
<br />
{| style="width                     :100%"
+
{| style="width:100%"
! style="width                     : 50%;"|Example
+
! style="width: 50%;"|Exemple
! style="width                     : 50%;"|Result
+
! style="width: 50%;"|Résultat
 
|-
 
|-
| style="padding                 : 5PX ;"|
+
| style="padding: 5px;"|
  <nowiki             ># élément 1
+
  <nowiki># élément 1
 
# élément 2</nowiki>
 
# élément 2</nowiki>
| style="padding                 : 5PX ;"|
+
| style="padding: 5px;"|
 
# élément 1
 
# élément 1
 
# élément 2
 
# élément 2
Line 251: Line 251:
  
 
<!--T:28-->
 
<!--T:28-->
Voici un exemple simple de tableau. Cela peut être utile pour présenter plus facilement un code exemple et son résultat. The tableaux sont structurés comme suit.
+
Voici un exemple simple de tableau. Cela peut être utile pour présenter plus facilement un code exemple et son résultat. Les tableaux sont structurés comme suit.
  
 
<!--T:57-->
 
<!--T:57-->
{|cellpadding                 ="5" border="1" style="border-collapse:collapse;"
+
{|cellpadding="5" border="1" style="border-collapse:collapse;"
|'''<nowiki             >{|</nowiki>''' || début de '''tableau'''
+
|'''<nowiki>{|</nowiki>''' || début de '''tableau'''
 
|-
 
|-
|'''<nowiki             >|+</nowiki>''' || '''descriptif''' du contenu, ''optionnel;'' un seul par tableau positionné entre le début du tableau et la première ligne
+
|'''<nowiki>|+</nowiki>''' || '''descriptif''' du contenu, ''optionnel;'' un seul par tableau positionné entre le début du tableau et la première ligne
 
|-
 
|-
|'''<nowiki             >|-</nowiki>''' || '''début de ligne''', ''optionnel sur la première ligne'' -- le moteur de wiki prend en charge la première ligne
+
|'''<nowiki>|-</nowiki>''' || '''début de ligne''', ''optionnel sur la première ligne'' -- le moteur de wiki prend en charge la première ligne
 
|-
 
|-
|'''<nowiki             >!</nowiki>'''  || cellule '''entête''', ''optionnel.'' The entêtes peuvent être mises soit sur la même ligne séparées par des doubles points d'exclamations (!!), soit sur des lignes séparées, chacune ayant son unique point d'exclamation (!).
+
|'''<nowiki>!</nowiki>'''  || cellule '''entête''', ''optionnel.'' Les entêtes peuvent être mises soit sur la même ligne séparées par des doubles points d'exclamations (!!), soit sur des lignes séparées, chacune ayant son unique point d'exclamation (!).
 
|-  
 
|-  
|'''<nowiki             >|</nowiki>'''  || cellule de '''donnée''' , ''requis!'' The cellules de données consécutives d'un tableau peuvent être soit mises sur la même ligne séparées par une double barre verticale (<nowiki             >||</nowiki>), soit sur des lignes séparées, chacune ayant son unique barre verticale (<nowiki             >|</nowiki>).
+
|'''<nowiki>|</nowiki>'''  || cellule de '''donnée''' , ''requis!'' Les cellules de données consécutives d'un tableau peuvent être soit mises sur la même ligne séparées par une double barre verticale (<nowiki>||</nowiki>), soit sur des lignes séparées, chacune ayant son unique barre verticale (<nowiki>|</nowiki>).
 
|-
 
|-
|'''<nowiki             >|}</nowiki>''' || '''fin de tableau'''
+
|'''<nowiki>|}</nowiki>''' || '''fin de tableau'''
 
|}
 
|}
  
 
<!--T:58-->
 
<!--T:58-->
 
<br />
 
<br />
{| style="width                     :100%"
+
{| style="width:100%"
! style="width                     : 50%;"|Example
+
! style="width: 50%;"|Exemple
! style="width                     : 50%;"|Result
+
! style="width: 50%;"|Résultat
 
|-
 
|-
| style="padding                 : 5PX ;"|
+
| style="padding: 5px;"|
 
<pre>
 
<pre>
 
{|
 
{|
|Orange  
+
|Orange
|Apple  
+
|Apple
 
|-
 
|-
|Bread  
+
|Bread
|Pie  
+
|Pie
 
|-
 
|-
|Butter  
+
|Butter
 
|Ice cream  
 
|Ice cream  
 
|}
 
|}
 
</pre>
 
</pre>
| style="padding                 : 5PX ;"|
+
| style="padding: 5px;"|
 
{|
 
{|
|Orange  
+
|Orange
|Apple  
+
|Apple
 
|-
 
|-
|Bread  
+
|Bread
|Pie  
+
|Pie
 
|-
 
|-
|Butter  
+
|Butter
 
|Ice cream  
 
|Ice cream  
 
|}
 
|}
Line 301: Line 301:
  
 
<!--T:29-->
 
<!--T:29-->
For more information on tables, please consult the [https://www.mediawiki.org/wiki/Help:Tables/fr Manual wikimedia]<br />
+
Pour plus d'information sur les tableaux, vous pouvez consulter le [https://www.mediawiki.org/wiki/Help:Tables/fr Manual wikimedia]<br />
  
==Scripts and files == <!--T:30-->
+
==Scripts et fichiers== <!--T:30-->
  
 
<!--T:59-->
 
<!--T:59-->
N'oubliez pas de décrire le rôle des fichiers or scripts que vous mentionnez. De cette manière le lecteur aura le même niveau d'information que vous et sera plus à même de comprendre votre démarche.
+
N'oubliez pas de décrire le rôle des fichiers ou scripts que vous mentionnez. De cette manière le lecteur aura le même niveau d'information que vous et sera plus à même de comprendre votre démarche.
 
<br />
 
<br />
  
===Scripts === <!--T:31-->
+
===Scripts=== <!--T:31-->
Lorsque vous donnez le contenu d'un script or d'un fichier de configuration, assurez vous qu'il soit commenté, de préférence au niveau des lignes concernées. Le but est que le lecteur comprenne l'ensemble des actions décrites, il est donc important d'être le plus didactique possible. De cette manière, il sera plus à même de personnaliser, mettre à jour or diagnostiquer les problèmes de son serveur sur le long terme.
+
Lorsque vous donnez le contenu d'un script ou d'un fichier de configuration, assurez vous qu'il soit commenté, de préférence au niveau des lignes concernées. Le but est que le lecteur comprenne l'ensemble des actions décrites, il est donc important d'être le plus didactique possible. De cette manière, il sera plus à même de personnaliser, mettre à jour ou diagnostiquer les problèmes de son serveur sur le long terme.
 
<br /><br />
 
<br /><br />
If the files that you post have long parts and /or non intéressantes pour votre tutoriel, vous pouvez omettre ces parties avec l’ellipse '''(...)'''.
+
Si les fichiers que vous affichez possèdent des parties longues et/ou non intéressantes pour votre tutoriel, vous pouvez omettre ces parties avec l’ellipse '''(...)'''.
 
<br />
 
<br />
We recommend the use of the [[#Code_source|Balise GeSHi]] pour afficher le contenu des scripts or fichiers. Cette dernière vous permettra, en plus de la coloration syntaxique, d'indiquer simplement des numéros de lignes et de surligner la or les plus importantes. Nous vous recommandons d'utiliser le surlignage pour indiquer les lignes où il y a des modifications à effectuer.
+
Nous vous recommandons l'utilisation de la [[:fr:#Code_source|Balise GeSHi]] pour afficher le contenu des scripts ou fichiers. Cette dernière vous permettra, en plus de la coloration syntaxique, d'indiquer simplement des numéros de lignes et de surligner la ou les plus importantes. Nous vous recommandons d'utiliser le surlignage pour indiquer les lignes où il y a des modifications à effectuer.
 
<br />
 
<br />
  
 
<!--T:60-->
 
<!--T:60-->
{| style="width                     :100%"
+
{| style="width:100%"
! style="width                     : 50%;"|Example
+
! style="width: 50%;"|Exemple
! style="width                     : 50%;"|Result
+
! style="width: 50%;"|Résultat
 
|-
 
|-
| style="padding                 : 5PX ;"|
+
| style="padding: 5px;"|
  <nowiki             ><syntaxhighlight lang="apache" line start="10" highlight="5">
+
  <nowiki><syntaxhighlight lang="apache" line start="10" highlight="5">
 
<VirtualHost *:80>
 
<VirtualHost *:80>
 
     DocumentRoot /www/example1
 
     DocumentRoot /www/example1
Line 330: Line 330:
 
</VirtualHost>
 
</VirtualHost>
 
</syntaxhighlight></nowiki>
 
</syntaxhighlight></nowiki>
| style="padding                 : 5PX ;"|
+
| style="padding: 5px;"|
 
<syntaxhighlight lang="apache" line start="10" highlight="5">
 
<syntaxhighlight lang="apache" line start="10" highlight="5">
 
<VirtualHost *:80>
 
<VirtualHost *:80>
Line 341: Line 341:
 
<br />
 
<br />
  
===File === <!--T:36-->
+
===Fichiers=== <!--T:36-->
  
 
<!--T:37-->
 
<!--T:37-->
Vous avez la possibilité d'insérer un fichier or une image dans votre tutoriel. Le plus simple pour réaliser la chose est de mentionner le document dans votre article, Then de le mettre en ligne une fois la rédaction terminée. Si le fichier n'existe pas déjà, il sera pointé par un lien rouge. En cliquant sur ce lien, vous arriverez sur une page que vous permettra de téléverser votre fichier.
+
Vous avez la possibilité d'insérer un fichier ou une image dans votre tutoriel. Le plus simple pour réaliser la chose est de mentionner le document dans votre article, puis de le mettre en ligne une fois la rédaction terminée. Si le fichier n'existe pas déjà, il sera pointé par un lien rouge. En cliquant sur ce lien, vous arriverez sur une page que vous permettra de téléverser votre fichier.
 
<br />
 
<br />
  
 
<!--T:38-->
 
<!--T:38-->
{| style="width                     :100%"
+
{| style="width:100%"
! style="width                     : 50%;"|Example
+
! style="width: 50%;"|Exemple
! style="width                     : 50%;"|Result
+
! style="width: 50%;"|Résultat
 
|-
 
|-
| style="padding                 : 5PX ;"|
+
| style="padding: 5px;"|
  <nowiki             >[[Media:mon_fichier.txt]]</nowiki>
+
  <nowiki>[[Media:mon_fichier.txt]]</nowiki>
| style="padding                 : 5PX ;"|
+
| style="padding: 5px;"|
 
[[Media:mon_fichier.txt]]
 
[[Media:mon_fichier.txt]]
 
|}
 
|}
  
 
<!--T:39-->
 
<!--T:39-->
It is worth noting that the link to the file depends exclusively on the name of the file. It is recommended that you use names as descriptive as possible files. Don't forget to include a description of the file when you put it online.
+
Il est à noter que le lien vers le fichier dépend exclusivement du nom du fichier. Nous vous recommandons d'utiliser des noms de fichiers aussi descriptifs que possible. N'oubliez pas d'inclure une description du fichier lorsque vous le mettez en ligne.
 
<br /><br />
 
<br /><br />
  
===Images === <!--T:40-->
+
===Images=== <!--T:40-->
  
 
<!--T:41-->
 
<!--T:41-->
The images sont considérées comme des fichiers. Vous pouvez donc les inclure et les mettre en ligne de la même manière que les fichiers.<br />
+
Les images sont considérées comme des fichiers. Vous pouvez donc les inclure et les mettre en ligne de la même manière que les fichiers.<br />
The only difference with a file is that the image will be displayed in the text. What gives you more options to display.
+
La seule différence avec un fichier est que l'image sera affichée dans le texte. Ce qui vous donne plus d'options pour son affichage.
 
<br /><br />
 
<br /><br />
The syntax to comply is :
+
La syntaxe à respecter est la suivante :
  <nowiki             >[[File:sample_image.jpg|options|description]]</nowiki>
+
  <nowiki>[[File:sample_image.jpg|options|description]]</nowiki>
The options et la description sont facultatives.
+
Les options et la description sont facultatives.
 
<br />
 
<br />
  
 
<!--T:61-->
 
<!--T:61-->
{| style="width                     :100%"
+
{| style="width:100%"
! style="width                     : 50%;"|Example
+
! style="width: 50%;"|Exemple
! style="width                     : 50%;"|Result
+
! style="width: 50%;"|Résultat
 
|-
 
|-
| style="padding                 : 5PX ;"|
+
| style="padding: 5px;"|
  <nowiki             >[[File:sample_image.jpg|200px|thumb|right|modèle image]]</nowiki>
+
  <nowiki>[[File:sample_image.jpg|200px|thumb|right|modèle image]]</nowiki>
* '''200PX ''' : size to display
+
* '''200px''' : taille à afficher
*<span class="notranslate"> '''thumb'''</span> : the image is inked in a setting that will display the description <br />
+
*<span class="notranslate"> '''thumb'''</span> : l'image est encrée dans un cadre qui affichera la description<br />
* <span class="notranslate">'''right'''</span> : alignment of the image right
+
* <span class="notranslate">'''right'''</span> : alignement de l'image à droite
| style="padding                 : 5PX ;"| [[File:sample_image.jpg|200px|thumb|right|modèle image]]
+
| style="padding: 5px;"| [[File:sample_image.jpg|200px|thumb|right|modèle image]]
 
|}
 
|}
  
 
<!--T:62-->
 
<!--T:62-->
 
<br />
 
<br />
You can find more information about the different options available on the image manipulation on the [http://www.mediawiki.org/wiki/Help:Images/fr mediawiki manual].<br />
+
Vous trouverez plus d'informations concernant les différentes options possibles sur la manipulation d'image sur le [http://www.mediawiki.org/wiki/Help:Images/fr mediawiki manual].<br />
Avoid using too heavy images and prefer to use jpg, jpeg and png formats.
+
Evitez d'utiliser des images trop lourdes et préférez utiliser les formats jpg, jpeg et png.
 
<br /><br />
 
<br /><br />
  
==Keyboard keys == <!--T:42-->
+
==Touches du clavier== <!--T:42-->
  
 
<!--T:43-->
 
<!--T:43-->
To describe the keyboard keys, follow these recommendations :
+
Pour décrire les touches de clavier, suivez ces recommandations :
* write them in uppercase
+
* les écrire en MAJUSCULE
* use the tag <nowiki             ><span></nowiki>
+
* utiliser la balise <nowiki><span></nowiki>
 
* utiliser le symbole '''+''' si elles doivent être pressées simultanément
 
* utiliser le symbole '''+''' si elles doivent être pressées simultanément
  
 
<!--T:44-->
 
<!--T:44-->
{| style="width                     :100%"
+
{| style="width:100%"
! style="width                     : 50%;"|Example
+
! style="width: 50%;"|Exemple
! style="width                     : 50%;"|Result
+
! style="width: 50%;"|Résultat
 
|-
 
|-
| style="padding                 : 5PX ;"|
+
| style="padding: 5px;"|
  <nowiki             >Support on <span style="background-color: #E6E6E6;">CTRL</span>+<span style="background-color: #E6E6E6;">ALT</span>+<span style="background-color: #E6E6E6;">SUPP</span> Then '''Task Manager '''</nowiki>
+
  <nowiki>Appuyer sur <span style="background-color: #E6E6E6;">CTRL</span>+<span style="background-color: #E6E6E6;">ALT</span>+<span style="background-color: #E6E6E6;">SUPP</span> puis '''Gestionnaire des tâches'''</nowiki>
| style="padding                 : 5PX ;"|
+
| style="padding: 5px;"|
Support on <span style="background-color: #E6E6E6;">CTRL</span>+<span style="background-color: #E6E6E6;">ALT</span>+<span style="background-color: #E6E6E6;">SUPP</span> Then '''Task Manager '''
+
Appuyer sur <span style="background-color: #E6E6E6;">CTRL</span>+<span style="background-color: #E6E6E6;">ALT</span>+<span style="background-color: #E6E6E6;">SUPP</span> puis '''Gestionnaire des tâches'''
 
|}
 
|}
 
<br />
 
<br />
  
==Host names == <!--T:45-->
+
==Noms d'hôte== <!--T:45-->
  
 
<!--T:46-->
 
<!--T:46-->
It is recommended that you use host names the most specific possible, that is in relation to the role of the server.<br />
+
Nous vous recommandons d'utiliser des noms d'hôte les plus spécifiques possible, qui soit en rapport avec le rôle du serveur.<br />
Example  :
+
Exemple :
* dns_serveur  
+
* dns_serveur
* bdd_master  
+
* bdd_master
* proxy_nginx  
+
* proxy_nginx
 
* etc.
 
* etc.
 
<br />
 
<br />
  
==Domain names == <!--T:47-->
+
==Noms de domaine== <!--T:47-->
  
 
<!--T:48-->
 
<!--T:48-->
When you are dealing with domain names, prefer to use the field '''domain.tld   ''' as the default domain.
+
Lorsque vous traitez des noms de domaines, préférez utiliser le domaine '''domaine.tld''' comme domaine par défaut.
If you have multiple domain names to mention, you can choose to use names such as '''domain - 1.tld ''', '''domain - 2.tld '''etc. |
+
Si vous avez plusieurs noms de domaine à mentionner, vous pouvez choisir d'utiliser des noms tels que '''domaine-1.tld''', '''domaine-2.tld''', etc.
 
<br /><br />
 
<br /><br />
For subdomains, we recommend that you use a name in connection with the role to which this subdomain will be attached, as '''master.domain.tld   ''', '''slave.domain.tld   ''', '''bdd.domain.tld   '''etc. |
+
Pour les sous-domaines, nous vous recommandons d'utiliser un nom en rapport avec le rôle auquel ce sous-domaine sera rattaché, comme '''master.domaine.tld''', '''slave.domaine.tld''', '''bdd.domaine.tld''', etc.
 
<br /><br />
 
<br /><br />
  
==IP addresses == <!--T:49-->
+
==Adresses IP== <!--T:49-->
  
 
<!--T:50-->
 
<!--T:50-->
To avoid to disclose your IP in your tutorials and be as clear as possible, we invite you to meet the [https://en.wikipedia.org/wiki/Reserved_IP_addresses reserved addresses] to the documentation. In our case, we prefer to use the block addresses '''203.0.113.0/24''' for everything which is public address. Either '''203.0.113.0''' à '''203.0.113.255'''.
+
Afin d'éviter de divulguer vos IP dans vos tutoriels et d'être le plus clair possible, nous vous invitons à respecter les [https://en.wikipedia.org/wiki/Reserved_IP_addresses reserved addresses] à la documentation. Dans notre cas, nous préférerons utiliser les adresses du bloc '''203.0.113.0/24''' pour tout ce qui est adresse publiques. Soit '''203.0.113.0''' à '''203.0.113.255'''.
 
<br /><br />
 
<br /><br />
For the addresses of local networks and localhost, you can keep the IP that you usually use. It means :
+
Pour les adresses des réseaux locaux et le localhost, vous pouvez conserver les IP que vous utilisez habituellement. C'est à dire :
 
* '''10.0.0.0/8''' - 10.0.0.0 – 10.255.255.255
 
* '''10.0.0.0/8''' - 10.0.0.0 – 10.255.255.255
 
* '''172.16.0.0/12''' - 172.16.0.0 – 172.31.255.255
 
* '''172.16.0.0/12''' - 172.16.0.0 – 172.31.255.255
Line 444: Line 444:
 
<br /><br />
 
<br /><br />
  
==Links == <!--T:51-->
+
==Liens== <!--T:51-->
{{:Creer_un_lien }}
+
{{:Créer_un_lien}}
  
 
==Screenshots == <!--T:52-->
 
==Screenshots == <!--T:52-->
Line 451: Line 451:
 
<!--T:53-->
 
<!--T:53-->
 
If your tutorial describes actions to realize on a graphical interface, it is better to include screen shots to make it clearer.
 
If your tutorial describes actions to realize on a graphical interface, it is better to include screen shots to make it clearer.
Attention toutefois à ne pas en faire de trop. Il n'est pas question d'avoir une capture pour chaque bouton, zone de texte or lien, mais juste ce qu'il faut pour que le lecteur réussisse à vous suivre.
+
Be careful however not to be too. It is not question of having a screenshot for each button, text or link box, but just what it takes for successful drive to follow you.
 
<br />
 
<br />
Si vous souhaitez mettre des éléments de la capture en évidence, n'hésitez pas à y ajouter des flèches or cadres pour les pointer. Cela n'en rendra le tutoriel que plus compréhensif.
+
If you want to capture highlight items, please feel free to add arrows or frames to the point. This only will be the only comprehensive tutorial.
 
<br /><br />
 
<br /><br />
Nous vous recommandons de mettre en gras les éléments que vous mentionnez et qui sont dans l'interface graphique, que ce soit un bouton, un lien, une case à cocheretc. |
+
We recommend that you put the elements you mention in fat and which are in the graphic interface, that it is a button, a link, a checkbox, etc. |
 
<br />
 
<br />
 
Don't forget to add a description when you turn the image online.
 
Don't forget to add a description when you turn the image online.
Line 463: Line 463:
 
Please include a short conclusion to your tutorial which will summarize what has been done and introduce what might be done subsequently.
 
Please include a short conclusion to your tutorial which will summarize what has been done and introduce what might be done subsequently.
 
<br />
 
<br />
You have everything you need to create your own articles ! In addition, you can also consult our article on the [[Comment rédiger un article pour la communauté iKoula | style iKoula]], and good writing !
+
You have everything you need to create your own articles ! In addition, you can also consult our article on the [[:fr:Comment rédiger un article pour la communauté iKoula | style iKoula]], and good writing !
  
  

Revision as of 16:19, 23 September 2015


This article has been created by an automatic translation software. You can view the article source here.



Cet article explique comment formater votre tutoriel. En suivant ce guide et celui sur le writing style, votre tutoriel appliquera les recommandations d'ikoula.


Syntaxe wiki

Les tutoriels ikoula doivent être formaté en utilisant la wiki syntax. Cet article va vous donner les exemples les plus courants de cette syntaxe. Vous trouverez plus de détails dans la mediawiki help section quant au formatage wiki.


Chapitres

Pour sectionner vos tutoriels en chapitres, vous pouvez utiliser les niveaux de titre. Dès que vous placez un titre dans la page, tous les éléments suivants seront considérés comme faisant partie du nouveau chapitre, jusqu'au prochain titre de même niveau.
Cela peut être très utile pour améliorer la lisibilité de votre article en découpant les différentes étapes de réalisation.

Les différents niveaux de titre

Le titre de niveau 1 correspond au titre de l'article. Il est créé automatiquement lorsque vous créez votre page. Les autres titres se construisent en entourant votre titre par des signes "=". Le titre de niveau 2 correspond au premier titre de chapitre ou section.
Exemple pour le titre de cette section :

==Chapitres==

Plus vous mettrez de signe autour de votre titre, plus vous descendrez dans l'arborescence.

Exemple Résultat
===Titre de niveau 3===
====Titre de niveau 4====
=====Titre de niveau 5=====

Titre de niveau 3

Titre de niveau 4

Titre de niveau 5


Il est à noter qu'une table des matière s'affiche automatiquement en tête d'article dès qu'il y a au moins 4 chapitres ou sous-chapitres.

Styles

Vous pouvez formater votre texte en utilisant la syntaxe wiki et quelques balises HTML.

Gras

Voici comment mettre un terme en gras dans votre article.

Exemple Résultat
'''texte en gras'''

texte en gras


Voici une liste d'éléments qui devraient être en gras.

  • Texte visible d'une GUI
  • Changement de contexte pour une commande, tel que changer d'utilisateur ou de serveur
  • Noms d'hôte comme serveur-1
  • Utilisateurs comme ikoula
  • Prompts
  • Liste de termes, comme :
    • MySQL: moteur de base de données
    • Apache: serveur web
  • Eléments que le lecteur ne doit pas rater, sans trop en faire.


Italique

L'italique ne devrait être utilisé que pour introduire les termes techniques. Ex. : le serveur nginx sera utilisé comme reverse proxy.

Exemple Résultat
''texte en italique''

texte en italique


Notes et avertissements

L'utilisation de certaines balises HTML peut être nécessaire pour mettre en évidence certains éléments tels que des notes ou des avertissements.

Exemple Résultat
<div style="background-color: #FFCC99;"> '''Note''': Ceci est une note.</div>


<div style="background-color: #FF9999;"> '''Warning''': Ceci est un avertissement.</div>
Note: Ceci est une note.


Warning: Ceci est un avertissement.



Blockquotes

Les blockquotes sont des blocs où votre texte est formaté différemment. Pour cela, il suffit de placer un espace en début de phrase, ou d'encadrer votre texte des balises <pre>. Votre texte sera alors formaté dans un cadre avec une police différente.

Exemple Résultat

Texte important ''italique''
ou
<pre>Texte important ''italique''</pre>

Texte important italique

ou

Texte important ''italique''

Comme vous pouvez le noter, l'utilisation de la balise <pre> fait que tout autre formatage à l'intérieur du bloc sera ignoré et considéré comme du texte à afficher. Si vous utilisez la première méthode, avec l'espace en début de ligne, sachez qu'un retour à la ligne fermera le cadre.
Nous préconisons d'utiliser la balise GeSHi ou la méthode des notes et avertissements pour afficher du code source ou des informations importantes.

Code source

Lorsque vous publiez un code source, vous devez appliquer la balise <syntaxhighlight>. Cela permettra à votre code de bénéficier d'une coloration syntaxique, le rendant plus lisible. Afin d'adapter la coloration au langage utilisé, ajoutez l'option lang="langage" dans la balise.

Exemple Résultat

<syntaxhighlight lang="php">
<?
     $hello = "Hello World";
     echo $hello; // comment
?>
</syntaxhighlight>

<?
    $hello = "Hello World";
    echo $hello;         // comment
?>


Vous trouverez sur le site de l'extension GeSHi la liste des langages supportés et quelques options supplémentaires, telle l'ajout de numéros de ligne ou la mise en évidence d'une ligne dans le code.

Référence à une application

Lorsque vous mentionnez une application, préférez utiliser la capitalisation du site officiel. Si le site web n'est pas consistent, choisissez une forme et essayez de l'être dans votre article.
Par contre, ne capitalisez pas les noms de paquets ou des commandes, si ces derniers ne le sont pas.
Exemple :

A MySQL database vs. the mysql command or the mysql-server package.



Listes

A chaque type de liste son utilisation.

Listes non-ordonnées

Ces listes sont utiles pour :

  • les prérequis
  • les checklists
Exemple Résultat
* élément 1
* élément 2
  • élément 1
  • élément 2


Listes de définitions

Ces listes sont utiles pour :

  • les termes et explications
  • explications pour les variables dans une ligne de commande ou un fichier
Exemple Résultat
;mot 1
: définition 1
;mot 2
: définition 2-1
: définition 2-2
mot 1
définition 1
mot 2
définition 2-1
définition 2-2


Listes ordonnées

Les listes ordonnées sont à utiliser avec parcimonie. Elles peuvent s'avérer pratiques pour lister l'ordre d'un processus, tel que le traitement d'une requête DNS.

Exemple Résultat
# élément 1
# élément 2
  1. élément 1
  2. élément 2


Ces listes sont utiles pour :

  • décrire un processus de traitement

Dans certains cas, l’utilisation d'un tableau sera préférable aux listes.

Tableaux

Voici un exemple simple de tableau. Cela peut être utile pour présenter plus facilement un code exemple et son résultat. Les tableaux sont structurés comme suit.

{| début de tableau
|+ descriptif du contenu, optionnel; un seul par tableau positionné entre le début du tableau et la première ligne
|- début de ligne, optionnel sur la première ligne -- le moteur de wiki prend en charge la première ligne
! cellule entête, optionnel. Les entêtes peuvent être mises soit sur la même ligne séparées par des doubles points d'exclamations (!!), soit sur des lignes séparées, chacune ayant son unique point d'exclamation (!).
| cellule de donnée , requis! Les cellules de données consécutives d'un tableau peuvent être soit mises sur la même ligne séparées par une double barre verticale (||), soit sur des lignes séparées, chacune ayant son unique barre verticale (|).
|} fin de tableau


Exemple Résultat
{|
|Orange
|Apple
|-
|Bread
|Pie
|-
|Butter
|Ice cream 
|}
Orange Apple
Bread Pie
Butter Ice cream

Pour plus d'information sur les tableaux, vous pouvez consulter le Manual wikimedia

Scripts et fichiers

N'oubliez pas de décrire le rôle des fichiers ou scripts que vous mentionnez. De cette manière le lecteur aura le même niveau d'information que vous et sera plus à même de comprendre votre démarche.

Scripts

Lorsque vous donnez le contenu d'un script ou d'un fichier de configuration, assurez vous qu'il soit commenté, de préférence au niveau des lignes concernées. Le but est que le lecteur comprenne l'ensemble des actions décrites, il est donc important d'être le plus didactique possible. De cette manière, il sera plus à même de personnaliser, mettre à jour ou diagnostiquer les problèmes de son serveur sur le long terme.

Si les fichiers que vous affichez possèdent des parties longues et/ou non intéressantes pour votre tutoriel, vous pouvez omettre ces parties avec l’ellipse (...).
Nous vous recommandons l'utilisation de la Balise GeSHi pour afficher le contenu des scripts ou fichiers. Cette dernière vous permettra, en plus de la coloration syntaxique, d'indiquer simplement des numéros de lignes et de surligner la ou les plus importantes. Nous vous recommandons d'utiliser le surlignage pour indiquer les lignes où il y a des modifications à effectuer.

Exemple Résultat
<syntaxhighlight lang="apache" line start="10" highlight="5">
<VirtualHost *:80>
    DocumentRoot /www/example1
    ServerName www.example.com
    # Other directives here
</VirtualHost>
</syntaxhighlight>
10<VirtualHost *:80>
11    DocumentRoot /www/example1
12    ServerName www.example.com
13    # Other directives here
14</VirtualHost>


Fichiers

Vous avez la possibilité d'insérer un fichier ou une image dans votre tutoriel. Le plus simple pour réaliser la chose est de mentionner le document dans votre article, puis de le mettre en ligne une fois la rédaction terminée. Si le fichier n'existe pas déjà, il sera pointé par un lien rouge. En cliquant sur ce lien, vous arriverez sur une page que vous permettra de téléverser votre fichier.

Exemple Résultat
[[Media:mon_fichier.txt]]

Media:mon_fichier.txt

Il est à noter que le lien vers le fichier dépend exclusivement du nom du fichier. Nous vous recommandons d'utiliser des noms de fichiers aussi descriptifs que possible. N'oubliez pas d'inclure une description du fichier lorsque vous le mettez en ligne.

Images

Les images sont considérées comme des fichiers. Vous pouvez donc les inclure et les mettre en ligne de la même manière que les fichiers.
La seule différence avec un fichier est que l'image sera affichée dans le texte. Ce qui vous donne plus d'options pour son affichage.

La syntaxe à respecter est la suivante :

[[File:sample_image.jpg|options|description]]

Les options et la description sont facultatives.

Exemple Résultat
[[File:sample_image.jpg|200px|thumb|right|modèle image]]
  • 200px : taille à afficher
  • thumb : l'image est encrée dans un cadre qui affichera la description
  • right : alignement de l'image à droite
modèle image


Vous trouverez plus d'informations concernant les différentes options possibles sur la manipulation d'image sur le mediawiki manual.
Evitez d'utiliser des images trop lourdes et préférez utiliser les formats jpg, jpeg et png.

Touches du clavier

Pour décrire les touches de clavier, suivez ces recommandations :

  • les écrire en MAJUSCULE
  • utiliser la balise <span>
  • utiliser le symbole + si elles doivent être pressées simultanément
Exemple Résultat
Appuyer sur <span style="background-color: #E6E6E6;">CTRL</span>+<span style="background-color: #E6E6E6;">ALT</span>+<span style="background-color: #E6E6E6;">SUPP</span> puis '''Gestionnaire des tâches'''

Appuyer sur CTRL+ALT+SUPP puis Gestionnaire des tâches


Noms d'hôte

Nous vous recommandons d'utiliser des noms d'hôte les plus spécifiques possible, qui soit en rapport avec le rôle du serveur.
Exemple :

  • dns_serveur
  • bdd_master
  • proxy_nginx
  • etc.


Noms de domaine

Lorsque vous traitez des noms de domaines, préférez utiliser le domaine domaine.tld comme domaine par défaut. Si vous avez plusieurs noms de domaine à mentionner, vous pouvez choisir d'utiliser des noms tels que domaine-1.tld, domaine-2.tld, etc.

Pour les sous-domaines, nous vous recommandons d'utiliser un nom en rapport avec le rôle auquel ce sous-domaine sera rattaché, comme master.domaine.tld, slave.domaine.tld, bdd.domaine.tld, etc.

Adresses IP

Afin d'éviter de divulguer vos IP dans vos tutoriels et d'être le plus clair possible, nous vous invitons à respecter les reserved addresses à la documentation. Dans notre cas, nous préférerons utiliser les adresses du bloc 203.0.113.0/24 pour tout ce qui est adresse publiques. Soit 203.0.113.0 à 203.0.113.255.

Pour les adresses des réseaux locaux et le localhost, vous pouvez conserver les IP que vous utilisez habituellement. C'est à dire :

  • 10.0.0.0/8 - 10.0.0.0 – 10.255.255.255
  • 172.16.0.0/12 - 172.16.0.0 – 172.31.255.255
  • 192.168.0.0/16 - 192.168.0.0 – 192.168.255.255
  • 127.0.0.0/8 - 127.0.0.0 – 127.255.255.255



Liens

Créer un lien

Screenshots

If your tutorial describes actions to realize on a graphical interface, it is better to include screen shots to make it clearer. Be careful however not to be too. It is not question of having a screenshot for each button, text or link box, but just what it takes for successful drive to follow you.
If you want to capture highlight items, please feel free to add arrows or frames to the point. This only will be the only comprehensive tutorial.

We recommend that you put the elements you mention in fat and which are in the graphic interface, that it is a button, a link, a checkbox, etc. |
Don't forget to add a description when you turn the image online.

Conclusion

Please include a short conclusion to your tutorial which will summarize what has been done and introduce what might be done subsequently.
You have everything you need to create your own articles ! In addition, you can also consult our article on the style iKoula, and good writing !


This article seemed you to be useful ?

0


You are not allowed to post comments.