Difference between revisions of "How to format article"

From EN Ikoula wiki
⧼vector-jumptonavigation⧽ ⧼vector-jumptosearch⧽
 
(18 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
<span data-link_translate_en_title="How to format article"  data-link_translate_en_url="How to format article"></span>[[:en:How to format article]][[en:How to format article]]
 +
<span data-link_translate_de_title=""  data-link_translate_de_url=""></span>[[:de:]][[de:]]
 +
<span data-link_translate_he_title="כיצד לעצב מאמר"  data-link_translate_he_url="%D7%9B%D7%99%D7%A6%D7%93+%D7%9C%D7%A2%D7%A6%D7%91+%D7%9E%D7%90%D7%9E%D7%A8"></span>[[:he:כיצד לעצב מאמר]][[he:כיצד לעצב מאמר]]
 +
<span data-link_translate_ru_title="Как формат статьи"  data-link_translate_ru_url="%D0%9A%D0%B0%D0%BA+%D1%84%D0%BE%D1%80%D0%BC%D0%B0%D1%82+%D1%81%D1%82%D0%B0%D1%82%D1%8C%D0%B8"></span>[[:ru:Как формат статьи]][[ru:Как формат статьи]]
 +
<span data-link_translate_ja_title="記事の書式を設定する方法"  data-link_translate_ja_url="%E8%A8%98%E4%BA%8B%E3%81%AE%E6%9B%B8%E5%BC%8F%E3%82%92%E8%A8%AD%E5%AE%9A%E3%81%99%E3%82%8B%E6%96%B9%E6%B3%95"></span>[[:ja:記事の書式を設定する方法]][[ja:記事の書式を設定する方法]]
 +
<span data-link_translate_ar_title="كيفية تنسيق المادة"  data-link_translate_ar_url="%D9%83%D9%8A%D9%81%D9%8A%D8%A9+%D8%AA%D9%86%D8%B3%D9%8A%D9%82+%D8%A7%D9%84%D9%85%D8%A7%D8%AF%D8%A9"></span>[[:ar:كيفية تنسيق المادة]][[ar:كيفية تنسيق المادة]]
 +
<span data-link_translate_zh_title="如何设置格式文章"  data-link_translate_zh_url="%E5%A6%82%E4%BD%95%E8%AE%BE%E7%BD%AE%E6%A0%BC%E5%BC%8F%E6%96%87%E7%AB%A0"></span>[[:zh:如何设置格式文章]][[zh:如何设置格式文章]]
 +
<span data-link_translate_ro_title="Cum sa format articolul"  data-link_translate_ro_url="Cum+sa+format+articolul"></span>[[:ro:Cum sa format articolul]][[ro:Cum sa format articolul]]
 +
<span data-link_translate_pl_title="Jak sformatować art"  data-link_translate_pl_url="Jak+sformatowa%C4%87+art"></span>[[:pl:Jak sformatować art]][[pl:Jak sformatować art]]
 +
<span data-link_translate_nl_title="Hoe te formatteren van artikel"  data-link_translate_nl_url="Hoe+te+formatteren+van+artikel"></span>[[:nl:Hoe te formatteren van artikel]][[nl:Hoe te formatteren van artikel]]
 
<span data-link_translate_it_title="Come formattare articolo"  data-link_translate_it_url="Come+formattare+articolo"></span>[[:it:Come formattare articolo]][[it:Come formattare articolo]]
 
<span data-link_translate_it_title="Come formattare articolo"  data-link_translate_it_url="Come+formattare+articolo"></span>[[:it:Come formattare articolo]][[it:Come formattare articolo]]
 
<span data-link_translate_pt_title="Como formatar o artigo"  data-link_translate_pt_url="Como+formatar+o+artigo"></span>[[:pt:Como formatar o artigo]][[pt:Como formatar o artigo]]
 
<span data-link_translate_pt_title="Como formatar o artigo"  data-link_translate_pt_url="Como+formatar+o+artigo"></span>[[:pt:Como formatar o artigo]][[pt:Como formatar o artigo]]
<span data-link_translate_es_title="Cómo formato artículo"  data-link_translate_es_url="C%C3%B3mo+formato+art%C3%ADculo"></span>[[:es:Cómo formato artículo]][[es:Cómo formato artículo]]
+
<span data-link_translate_es_title="Cómo formato artículo"  data-link_translate_es_url="C%C3%B3mo+formato+art%C3%ADculo"></span>[[:es:Cómo formato artículo]][[es:Cómo formato artículo]]
 
<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]]
 
<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]]
 +
<br />
  
 +
{{#seo:
 +
|title=How to format article
 +
|title_mode=append
 +
|keywords=these,are,your,keywords
 +
|description=How to format article
 +
|image=Uploaded_file.png
 +
|image_alt=Wiki Logo
 +
}}
  
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>
+
==Wiki syntax== <!--T:2-->
 
 
 
 
 
 
 
 
<!--T:1-->
 
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}}.
 
 
 
 
 
==Syntaxe wiki== <!--T:2-->
 
  
 
<!--T:3-->
 
<!--T:3-->
Les tutoriels {{iKoula}} doivent être formaté en utilisant la [http://www.mediawiki.org/wiki/Help:Formatting wiki syntax].
+
Tutorials  {{iKoula}} must be formatted using the  [http://www.mediawiki.org/wiki/Help:Formatting wiki syntax].
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.
+
This article will give you the most common examples of this syntax. You can find more details in the  [http://www.mediawiki.org/wiki/Help:Formatting mediawiki help section] as for the wiki formatting.
  
  
==Chapitres== <!--T:4-->
+
==Chapters== <!--T:4-->
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 />
+
To cut your tutorials into chapters, you can use the levels of title. As soon as you 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 />
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 />
+
This can be very useful to improve the readability of your article by cutting out the different stages of realization. <br />
  
===Les différents niveaux de titre=== <!--T:5-->
+
===The different levels of title === <!--T:5-->
  
 
<!--T:6-->
 
<!--T:6-->
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 />
+
The title of leve 1 corresponds to the title of the article. It is created automatically when you create your page. The tracks are built around your title by signs  "'''='''". The title of leve 2 corresponds to the first title of chapter or secti <br />
Exemple pour le titre de cette section :<br />
+
Example for the title of this section :<br />
 
  <nowiki>==Chapitres==</nowiki><br />
 
  <nowiki>==Chapitres==</nowiki><br />
  
Plus vous mettrez de signe autour de votre titre, plus vous descendrez dans l'arborescence.<br />
+
More you'll sign around your title, the more you go down the tree. <br />
 
{| style="width:100%"
 
{| style="width:100%"
! style="width: 50%;"|Exemple
+
! style="width: 50%;"|Exampl
! style="width: 50%;"|Résultat
+
! style="width: 50%;"|Result
 
|-
 
|-
| style="padding: 5px;"|
+
| style="padding: 5P;"|
 
  <nowiki>===Titre de niveau 3===</nowiki>
 
  <nowiki>===Titre de niveau 3===</nowiki>
 
  <nowiki>====Titre de niveau 4====</nowiki>
 
  <nowiki>====Titre de niveau 4====</nowiki>
 
  <nowiki>=====Titre de niveau 5=====</nowiki>
 
  <nowiki>=====Titre de niveau 5=====</nowiki>
| style="padding: 5px;"|
+
| style="padding: 5P;"|
 
===Titre de niveau 3=== <!--T:7-->
 
===Titre de niveau 3=== <!--T:7-->
 
====Titre de niveau 4====
 
====Titre de niveau 4====
Line 47: Line 57:
 
|}
 
|}
 
<br />
 
<br />
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.
+
It is worth noting that a table of contents automatically appears at the head of article as soon as there are 4 chapters or subchapters.
 
<br /><br />
 
<br /><br />
  
 
==Styles== <!--T:56-->
 
==Styles== <!--T:56-->
  
Vous pouvez formater votre texte en utilisant la syntaxe wiki et quelques balises HTML.
+
You can format your text using wiki syntax and a few HTML tags.
 
<br />
 
<br />
===Gras=== <!--T:8-->
+
===Bol=== <!--T:8-->
  
 
<!--T:9-->
 
<!--T:9-->
Voici comment mettre un terme en gras dans votre article.
+
Here's how to end bold in your article.
 
<br />
 
<br />
 
{| style="width:100%"
 
{| style="width:100%"
! style="width: 50%;"|Exemple
+
! style="width: 50%;"|Exampl
! style="width: 50%;"|Résultat
+
! style="width: 50%;"|Result
 
|-
 
|-
| style="padding: 5px;"|
+
| style="padding: 5P;"|
  <nowiki>'''texte en gras'''</nowiki>
+
  <nowiki>'''bold text '''</nowiki>
| style="padding: 5px;"|
+
| style="padding: 5P;"|
 
'''texte en gras'''
 
'''texte en gras'''
 
|}
 
|}
 
<br />
 
<br />
Voici une liste d'éléments qui devraient être en gras.
+
Here is a list of items that should be in bold.
* Texte visible d'une GUI
+
* Visible text of a GUI  
* Changement de contexte pour une commande, tel que changer d'utilisateur ou de serveur
+
* Change of context for a control, such as changing user or server
* Noms d'hôte comme '''serveur-1'''
+
* Hostnames as  '''Server 1'''
* Utilisateurs comme '''ikoula'''
+
* Users like  '''ikoula'''
* Prompts
+
* Quick
* Liste de termes, comme :
+
* List of terms, as  :
** '''MySQL''': moteur de base de données
+
** '''MySQL''': database engine
** '''Apache''': serveur web
+
** '''Apache''': webserver
* Eléments que le lecteur ne doit pas rater, sans trop en faire.
+
* Elements that the player should not miss, make it without too much.
 
<br />
 
<br />
  
===Italique=== <!--T:10-->
+
===Italic === <!--T:10-->
  
 
<!--T:11-->
 
<!--T:11-->
L'italique ne devrait être utilisé que pour introduire les termes techniques. Ex. : le serveur nginx sera utilisé comme ''reverse proxy''.
+
Italics should only be used to introduce technical terms. E.g.  : the nginx Server will be used as  ''reverse proxy''.
 
<br />
 
<br />
 
{| style="width:100%"
 
{| style="width:100%"
! style="width: 50%;"|Exemple
+
! style="width: 50%;"|Exampl
! style="width: 50%;"|Résultat
+
! style="width: 50%;"|Result
 
|-
 
|-
| style="padding: 5px;"|
+
| style="padding: 5P;"|
  <nowiki>''texte en italique''</nowiki>
+
  <nowiki>''italicized text ''</nowiki>
| style="padding: 5px;"|
+
| style="padding: 5P;"|
''texte en italique''
+
''texte en italic ''
 
|}
 
|}
 
<br />
 
<br />
  
===Notes et avertissements=== <!--T:12-->
+
===Notes and warnings === <!--T:12-->
  
 
<!--T:13-->
 
<!--T:13-->
L'utilisation de certaines balises HTML peut être nécessaire pour mettre en évidence certains éléments tels que des notes ou des avertissements.
+
The use of some HTML tags may be necessary to highlight certain elements such as notes or warnings.
 
<br />
 
<br />
 
{| style="width:100%"
 
{| style="width:100%"
! style="width: 50%;"|Exemple
+
! style="width: 50%;"|Exampl
! style="width: 50%;"|Résultat
+
! style="width: 50%;"|Result
 
|-
 
|-
| style="padding: 5px;"|
+
| style="padding: 5P;"|
 
<syntaxhighlight lang="html4strict">
 
<syntaxhighlight lang="html4strict">
<div style="background-color: #FFCC99;"> '''Note''': Ceci est une note.</div>
+
<div style="background-color: #FFCC99;"> '''Note''': This is a note. </div>
 
</syntaxhighlight>
 
</syntaxhighlight>
 
<br />
 
<br />
 
<syntaxhighlight lang="html4strict">
 
<syntaxhighlight lang="html4strict">
<div style="background-color: #FF9999;"> '''Warning''': Ceci est un avertissement.</div>
+
<div style="background-color: #FF9999;"> '''Warning''': This is a warning. </div>
 
</syntaxhighlight>
 
</syntaxhighlight>
| style="padding: 5px;"|
+
| style="padding: 5P;"|
 
<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 124: Line 134:
  
 
<!--T:15-->
 
<!--T:15-->
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.
+
Th ''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>. Then, your text will be formatted in a setting with a different font.
 
<br />
 
<br />
 
{| style="width:100%"
 
{| style="width:100%"
! style="width: 50%;"|Exemple
+
! style="width: 50%;"|Exampl
! style="width: 50%;"|Résultat
+
! style="width: 50%;"|Result
 
|-
 
|-
| style="padding: 5px;"|
+
| style="padding: 5P;"|
 
<nowiki> Texte important ''italique''</nowiki><br />
 
<nowiki> Texte important ''italique''</nowiki><br />
 
ou <br />
 
ou <br />
 
<nowiki><pre>Texte important ''italique''</pre></nowiki>
 
<nowiki><pre>Texte important ''italique''</pre></nowiki>
| style="padding: 5px;"|
+
| style="padding: 5P;"|
 
  Texte important ''italique''
 
  Texte important ''italique''
 
ou <br />
 
ou <br />
 
<pre>Texte important ''italique''</pre>
 
<pre>Texte important ''italique''</pre>
 
|}
 
|}
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 />
+
As you noted, the use of the tag  <nowiki><pre></nowiki> fact that any formatting within the block will be ignored and considered the text to display. If you use the first method, with the space at the beginning of line, be aware that a return to the line will close the framework. <br />
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.
+
We recommend to use the tag  [[:fr:#Code_source| GeSHi]] or the method of  [[:fr:#Notes_et_avertissements|notes and warnings]] to view the source code or important information.
 
<br />
 
<br />
  
===Code source=== <!--T:16-->
+
===Source cod=== <!--T:16-->
  
 
<!--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.
+
When you publish source code, you must apply the tag  <nowiki><syntaxhighlight></nowiki>. This will allow your code to benefit from a syntax highlighting, making it more readable. In order to adapt the coloration to the language used, add the option ''lang="langua"'' in the tag.
 
<br />
 
<br />
 
{| style="width:100%"
 
{| style="width:100%"
! style="width: 50%;"|Exemple
+
! style="width: 50%;"|Exampl
! style="width: 50%;"|Résultat
+
! style="width: 50%;"|Result
 
|-
 
|-
| style="padding: 5px;"|
+
| style="padding: 5P;"|
 
<nowiki><syntaxhighlight lang="php"></nowiki><br />
 
<nowiki><syntaxhighlight lang="php"></nowiki><br />
 
<nowiki><?</nowiki><br />
 
<nowiki><?</nowiki><br />
Line 159: Line 169:
 
<nowiki>?></nowiki><br />
 
<nowiki>?></nowiki><br />
 
<nowiki></syntaxhighlight></nowiki>
 
<nowiki></syntaxhighlight></nowiki>
| style="padding: 5px;"|
+
| style="padding: 5P;"|
 
<syntaxhighlight lang="php">
 
<syntaxhighlight lang="php">
 
<?
 
<?
Line 168: Line 178:
 
|}
 
|}
 
<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 ou la mise en évidence d'une ligne dans le code.
+
You will find on the site of the extensi [http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi GeSHi] the list of supported languages and some additional options, such the addition of line numbers or highlighting a line in the code.
 
<br /><br />
 
<br /><br />
  
==Référence à une application== <!--T:18-->
+
==Refers to an application == <!--T:18-->
  
 
<!--T:19-->
 
<!--T:19-->
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.
+
When you mention an application, prefer to use the capitalization of the official website. If the web site is not consistent, select a form and try to be in your article.
 
<br />
 
<br />
Par contre, ne capitalisez pas les noms de paquets ou des commandes, si ces derniers ne le sont pas.
+
On the other hand, Don't capitalize not the names of packages or orders, if they are not.
 
<br />
 
<br />
Exemple :<br />
+
Exampl :<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 />
  
==Listes== <!--T:20-->
+
==Lists== <!--T:20-->
  
A chaque type de liste son utilisation.
+
Each type of list usage.
 
<br />
 
<br />
===Listes non-ordonnées=== <!--T:21-->
+
===Unordered lists === <!--T:21-->
  
 
<!--T:22-->
 
<!--T:22-->
Ces listes sont utiles pour :
+
These lists are useful for :
* les prérequis
+
* the prerequi
* les checklists
+
* the checklist
 
{| style="width:100%"
 
{| style="width:100%"
! style="width: 50%;"|Exemple
+
! style="width: 50%;"|Exampl
! style="width: 50%;"|Résultat
+
! style="width: 50%;"|Result
 
|-
 
|-
| style="padding: 5px;"|
+
| style="padding: 5P;"|
 
  <nowiki>* élément 1
 
  <nowiki>* élément 1
 
* élément 2</nowiki>
 
* élément 2</nowiki>
| style="padding: 5px;"|
+
| style="padding: 5P;"|
* élément 1
+
* element  1
* élément 2
+
* element  2
 
|}
 
|}
 
<br />
 
<br />
  
===Listes de définitions=== <!--T:23-->
+
===Definition lists === <!--T:23-->
  
 
<!--T:24-->
 
<!--T:24-->
Ces listes sont utiles pour :
+
These lists are useful for :
* les termes et explications
+
* terms and explanations
* explications pour les variables dans une ligne de commande ou un fichier
+
* explanations for the variables in a command line or file
 
{| style="width:100%"
 
{| style="width:100%"
! style="width: 50%;"|Exemple
+
! style="width: 50%;"|Exampl
! style="width: 50%;"|Résultat
+
! style="width: 50%;"|Result
 
|-
 
|-
| style="padding: 5px;"|
+
| style="padding: 5P;"|
 
  <nowiki>;mot 1
 
  <nowiki>;mot 1
 
: définition 1
 
: définition 1
Line 221: Line 231:
 
: définition 2-1
 
: définition 2-1
 
: définition 2-2</nowiki>
 
: définition 2-2</nowiki>
| style="padding: 5px;"|
+
| style="padding: 5P;"|
 
;mot 1
 
;mot 1
 
: définition 1
 
: définition 1
Line 230: Line 240:
 
<br />
 
<br />
  
===Listes ordonnées=== <!--T:25-->
+
===Ordered lists === <!--T:25-->
  
 
<!--T:26-->
 
<!--T:26-->
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.
+
Ordered lists are to be used sparingly. It can be practical to list the order of a process, such as the processing of a query DNS.
 
<br />
 
<br />
 
{| style="width:100%"
 
{| style="width:100%"
! style="width: 50%;"|Exemple
+
! style="width: 50%;"|Exampl
! style="width: 50%;"|Résultat
+
! style="width: 50%;"|Result
 
|-
 
|-
| style="padding: 5px;"|
+
| style="padding: 5P;"|
 
  <nowiki># élément 1
 
  <nowiki># élément 1
 
# élément 2</nowiki>
 
# élément 2</nowiki>
| style="padding: 5px;"|
+
| style="padding: 5P;"|
 
# élément 1
 
# élément 1
 
# élément 2
 
# élément 2
 
|}
 
|}
 
<br />
 
<br />
Ces listes sont utiles pour :
+
These lists are useful for :
* décrire un processus de traitement
+
* describe a process
Dans certains cas, l’utilisation d'un tableau sera préférable aux listes.
+
In some cases, the use of a table will be preferable to lists.
 
<br /><br />
 
<br /><br />
  
===Tableaux=== <!--T:27-->
+
===Tables === <!--T:27-->
  
 
<!--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. Les tableaux sont structurés comme suit.
+
Here is a simple example of a table. This can be useful to more easily present sample code and its result. The tables are structured as follows.
  
 
<!--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>''' || beginnin '''table '''
 
|-
 
|-
|'''<nowiki>|+</nowiki>''' || '''descriptif''' du contenu, ''optionnel;'' un seul par tableau positionné entre le début du tableau et la première ligne
+
|'''<nowiki>|+</nowiki>''' || '''Overview ''' content, ''Optional;'' one per table positioned between the beginning of the array and the first line
 
|-
 
|-
|'''<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>''' || '''beginning of l''', ''Optional on the first line '' -- the wiki engine supports the first line
 
|-
 
|-
|'''<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>'''  || cell  '''header''', ''optional.'' The headers may be placed either on the same line separated by double exclamations points (!!), either on separate lines, each with its unique exclamation point (!).
 
|-  
 
|-  
|'''<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>'''  || cell of  '''data ''' , ''requis!'' Consecutive table data cells can be either placed on the same line separated by a double vertical bar  (<nowiki>||</nowiki>), either on separate lines, each with its unique vertical bar  (<nowiki>|</nowiki>).
 
|-
 
|-
|'''<nowiki>|}</nowiki>''' || '''fin de tableau'''
+
|'''<nowiki>|}</nowiki>''' || '''end of array '''
 
|}
 
|}
  
Line 275: Line 285:
 
<br />
 
<br />
 
{| style="width:100%"
 
{| style="width:100%"
! style="width: 50%;"|Exemple
+
! style="width: 50%;"|Exampl
! style="width: 50%;"|Résultat
+
! style="width: 50%;"|Result
 
|-
 
|-
| style="padding: 5px;"|
+
| style="padding: 5P;"|
 
<pre>
 
<pre>
 
{|
 
{|
Line 291: Line 301:
 
|}
 
|}
 
</pre>
 
</pre>
| style="padding: 5px;"|
+
| style="padding: 5P;"|
 
{|
 
{|
 
|Orange
 
|Orange
Line 305: Line 315:
  
 
<!--T:29-->
 
<!--T:29-->
Pour plus d'information sur les tableaux, vous pouvez consulter le [https://www.mediawiki.org/wiki/Help:Tables/fr Manual wikimedia]<br />
+
For more information on tables, please consult the  [https://www.mediawiki.org/wiki/Help:Tables/fr Manual wikimedia]<br />
  
==Scripts et fichiers== <!--T:30-->
+
==Scripts and files == <!--T:30-->
  
 
<!--T:59-->
 
<!--T:59-->
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.
+
Be sure to describe the role of files or scripts that you mention. In this way the reader will have the same level of information that you and will be more able to understand your approach.
 
<br />
 
<br />
  
 
===Scripts=== <!--T:31-->
 
===Scripts=== <!--T:31-->
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.
+
When you give the contents of a script or a configuration file, make sure you it is commented, preferably at the level of the lines concerned. The aim is that the reader understand all of the actions described, so it is important to be more educational as possible. In this way, it will be more able to customize, update or diagnose problems with its server in the long term.
 
<br /><br />
 
<br /><br />
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 '''(...)'''.
+
If the files that you post have long parts and /or not interesting for your tutorial, you can omit these parties with the ellipse  '''(...)'''.
 
<br />
 
<br />
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.
+
We recommend the use of the  [[:fr:#Code_source|Balise GeSHi]] to display the contents of the scripts or files. The latter will allow you, in addition to syntax highlighting, simply indicate numbers of lines and highlight the more important. It is recommended that you use the highlighting to indicate the lines where there are changes to perform.
 
<br />
 
<br />
  
 
<!--T:60-->
 
<!--T:60-->
 
{| style="width:100%"
 
{| style="width:100%"
! style="width: 50%;"|Exemple
+
! style="width: 50%;"|Exampl
! style="width: 50%;"|Résultat
+
! style="width: 50%;"|Result
 
|-
 
|-
| style="padding: 5px;"|
+
| style="padding: 5P;"|
 
  <nowiki><syntaxhighlight lang="apache" line start="10" highlight="5">
 
  <nowiki><syntaxhighlight lang="apache" line start="10" highlight="5">
 
<VirtualHost *:80>
 
<VirtualHost *:80>
Line 334: Line 344:
 
</VirtualHost>
 
</VirtualHost>
 
</syntaxhighlight></nowiki>
 
</syntaxhighlight></nowiki>
| style="padding: 5px;"|
+
| style="padding: 5P;"|
 
<syntaxhighlight lang="apache" line start="10" highlight="5">
 
<syntaxhighlight lang="apache" line start="10" highlight="5">
 
<VirtualHost *:80>
 
<VirtualHost *:80>
Line 345: Line 355:
 
<br />
 
<br />
  
===Fichiers=== <!--T:36-->
+
===File === <!--T:36-->
  
 
<!--T:37-->
 
<!--T:37-->
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.
+
You have the possibility of inserting a file or an image in your tutorial. The simplest way to achieve the thing is to mention the document in your article, then put online once completed writing. If the file does not already exist, it will be pointed to by a red link. By clicking on this link, you will come to a page that will allow you to upload your file.
 
<br />
 
<br />
  
 
<!--T:38-->
 
<!--T:38-->
 
{| style="width:100%"
 
{| style="width:100%"
! style="width: 50%;"|Exemple
+
! style="width: 50%;"|Exampl
! style="width: 50%;"|Résultat
+
! style="width: 50%;"|Result
 
|-
 
|-
| style="padding: 5px;"|
+
| style="padding: 5P;"|
 
  <nowiki>[[Media:mon_fichier.txt]]</nowiki>
 
  <nowiki>[[Media:mon_fichier.txt]]</nowiki>
| style="padding: 5px;"|
+
| style="padding: 5P;"|
 
[[Media:mon_fichier.txt]]
 
[[Media:mon_fichier.txt]]
 
|}
 
|}
  
 
<!--T:39-->
 
<!--T:39-->
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.
+
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.
 
<br /><br />
 
<br /><br />
  
Line 369: Line 379:
  
 
<!--T:41-->
 
<!--T:41-->
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 />
+
Images are treated as files. You can therefore include them and put them online in the same way as files. <br />
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.
+
The only difference with a file is that the image will be displayed in the text. What gives you more options to display.
 
<br /><br />
 
<br /><br />
La syntaxe à respecter est la suivante :
+
The syntax to comply is  :
 
  <nowiki>[[File:sample_image.jpg|options|description]]</nowiki>
 
  <nowiki>[[File:sample_image.jpg|options|description]]</nowiki>
Les options et la description sont facultatives.
+
Options and description are optional.
 
<br />
 
<br />
  
 
<!--T:61-->
 
<!--T:61-->
 
{| style="width:100%"
 
{| style="width:100%"
! style="width: 50%;"|Exemple
+
! style="width: 50%;"|Exampl
! style="width: 50%;"|Résultat
+
! style="width: 50%;"|Result
 
|-
 
|-
| style="padding: 5px;"|
+
| style="padding: 5P;"|
 
  <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''' : taille à afficher
+
* '''200P''' : size to display
*<span class="notranslate"> '''thumb'''</span> : l'image est encrée dans un cadre qui affichera la description<br />
+
*<span class="notranslate"> '''thumb'''</span> : the image is inked in a setting that will display the descrip<br />
* <span class="notranslate">'''right'''</span> : alignement de l'image à droite
+
* <span class="notranslate">'''right'''</span> : alignment of the image right
| style="padding: 5px;"| [[File:sample_image.jpg|200px|thumb|right|modèle image]]
+
| style="padding: 5P;"| [[File:sample_image.jpg|200px|thumb|right|modèle image]]
 
|}
 
|}
  
 
<!--T:62-->
 
<!--T:62-->
 
<br />
 
<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 />
+
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 />
Evitez d'utiliser des images trop lourdes et préférez utiliser les formats jpg, jpeg et png.
+
Avoid using too heavy images and prefer to use jpg, jpeg and png formats.
 
<br /><br />
 
<br /><br />
  
==Touches du clavier== <!--T:42-->
+
==Keyboard keys == <!--T:42-->
  
 
<!--T:43-->
 
<!--T:43-->
Pour décrire les touches de clavier, suivez ces recommandations :
+
To describe the keyboard keys, follow these recommendations  :
* les écrire en MAJUSCULE
+
* write them in uppercase
* utiliser la balise <nowiki><span></nowiki>
+
* use the tag  <nowiki><span></nowiki>
* utiliser le symbole '''+''' si elles doivent être pressées simultanément
+
* use the symbol  '''+''' If they have to be pressed simultaneously
  
 
<!--T:44-->
 
<!--T:44-->
 
{| style="width:100%"
 
{| style="width:100%"
! style="width: 50%;"|Exemple
+
! style="width: 50%;"|Exampl
! style="width: 50%;"|Résultat
+
! style="width: 50%;"|Result
 
|-
 
|-
 
| style="padding: 5px;"|
 
| style="padding: 5px;"|
  <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>
+
  <nowiki>Support on <span style="background-color: #E6E6E6;">CTRL</span>+<span style="background-color: #E6E6E6;">ALT</span>+<span style="background-color: #E6E6E6;">SUPP</span> The '''Task Manager '''</nowiki>
 
| style="padding: 5px;"|
 
| style="padding: 5px;"|
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 <span style="background-color: #E6E6E6;">CTRL</span>+<span style="background-color: #E6E6E6;">ALT</span>+<span style="background-color: #E6E6E6;">SUPP</span> The '''Task Manager '''
 
|}
 
|}
 
<br />
 
<br />
  
==Noms d'hôte== <!--T:45-->
+
==Host names == <!--T:45-->
  
 
<!--T:46-->
 
<!--T:46-->
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 />
+
It is recommended that you use host names the most specific possible, that is in relation to the role of the server. <br />
Exemple :
+
Exampl :
 
* dns_serveur
 
* dns_serveur
 
* bdd_master
 
* bdd_master
Line 427: Line 437:
 
<br />
 
<br />
  
==Noms de domaine== <!--T:47-->
+
==Domain names == <!--T:47-->
  
 
<!--T:48-->
 
<!--T:48-->
Lorsque vous traitez des noms de domaines, préférez utiliser le domaine '''domaine.tld''' comme domaine par défaut.
+
When you are dealing with domain names, prefer to use the field  '''domain.tld''' as the default domain.
Si vous avez plusieurs noms de domaine à mentionner, vous pouvez choisir d'utiliser des noms tels que '''domaine-1.tld''', '''domaine-2.tld''', etc.
+
If you have multiple domain names to mention, you can choose to use names such as  '''domain 1.tld''', '''domain 2.tld'''etc. |
 
<br /><br />
 
<br /><br />
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.
+
For subdomains, we recommend that you use a name in connection with the role to which this subdomain will be attached, as  '''master.Domaine.tl''', '''slave.Domaine.tl''', '''BDD.Domaine.tl'''etc. |
 
<br /><br />
 
<br /><br />
  
==Adresses IP== <!--T:49-->
+
==IP address== <!--T:49-->
  
 
<!--T:50-->
 
<!--T:50-->
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'''.
+
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. Eit '''203.0.113.0''' à '''203.0.113.255'''.
 
<br /><br />
 
<br /><br />
Pour les adresses des réseaux locaux et le localhost, vous pouvez conserver les IP que vous utilisez habituellement. C'est à dire :
+
For the addresses of local networks and localhost, you can keep the IP that you usually use. It means  :
 
* '''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 448: Line 458:
 
<br /><br />
 
<br /><br />
  
==Liens== <!--T:51-->
+
==Link== <!--T:51-->
 
{{:Créer_un_lien}}
 
{{:Créer_un_lien}}
  
Line 464: Line 474:
 
<br /><br />
 
<br /><br />
  
==Conclusion == <!--T:54-->
+
==Conclusion== <!--T:54-->
 
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 [[:fr: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 !
  
  
 
<!--T:55-->
 
<!--T:55-->
This article seemed you to be useful ? <vote />
+
This article seemed you to be u ? <vote />
  
[[Category:Help]]
+
[[Category:Contribute]]
 +
<br />
 
<comments />
 
<comments />

Latest revision as of 14:54, 1 October 2021

en:How to format article de: he:כיצד לעצב מאמר ru:Как формат статьи ja:記事の書式を設定する方法 ar:كيفية تنسيق المادة zh:如何设置格式文章 ro:Cum sa format articolul pl:Jak sformatować art nl:Hoe te formatteren van artikel it:Come formattare articolo pt:Como formatar o artigo es:Cómo formato artículo fr:Comment formater son article

Wiki syntax

Tutorials ikoula must be formatted using the wiki syntax. This article will give you the most common examples of this syntax. You can find more details in the mediawiki help section as for the wiki formatting.


Chapters

To cut your tutorials into chapters, you can use the levels of title. As soon as you 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.
This can be very useful to improve the readability of your article by cutting out the different stages of realization.

The different levels of title

The title of leve 1 corresponds to the title of the article. It is created automatically when you create your page. The tracks are built around your title by signs "=". The title of leve 2 corresponds to the first title of chapter or secti
Example for the title of this section :

==Chapitres==

More you'll sign around your title, the more you go down the tree.

Exampl Result
===Titre de niveau 3===
====Titre de niveau 4====
=====Titre de niveau 5=====

Titre de niveau 3

Titre de niveau 4

Titre de niveau 5


It is worth noting that a table of contents automatically appears at the head of article as soon as there are 4 chapters or subchapters.

Styles

You can format your text using wiki syntax and a few HTML tags.

Bol

Here's how to end bold in your article.

Exampl Result
'''bold text '''

texte en gras


Here is a list of items that should be in bold.

  • Visible text of a GUI
  • Change of context for a control, such as changing user or server
  • Hostnames as Server 1
  • Users like ikoula
  • Quick
  • List of terms, as :
    • MySQL: database engine
    • Apache: webserver
  • Elements that the player should not miss, make it without too much.


Italic

Italics should only be used to introduce technical terms. E.g. : the nginx Server will be used as reverse proxy.

Exampl Result
''italicized text ''

texte en italic


Notes and warnings

The use of some HTML tags may be necessary to highlight certain elements such as notes or warnings.

Exampl Result
<div style="background-color: #FFCC99;"> '''Note''': This is a note. </div>


<div style="background-color: #FF9999;"> '''Warning''': This is a warning. </div>
Note: Ceci est une note.


Warning: Ceci est un avertissement.



Blockquotes

Th 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 <pre>. Then, your text will be formatted in a setting with a different font.

Exampl Result

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

Texte important italique

ou

Texte important ''italique''

As you noted, the use of the tag <pre> fact that any formatting within the block will be ignored and considered the text to display. If you use the first method, with the space at the beginning of line, be aware that a return to the line will close the framework.
We recommend to use the tag GeSHi or the method of notes and warnings to view the source code or important information.

Source cod

When you publish source code, you must apply the tag <syntaxhighlight>. This will allow your code to benefit from a syntax highlighting, making it more readable. In order to adapt the coloration to the language used, add the option lang="langua" in the tag.

Exampl Result

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

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


You will find on the site of the extensi GeSHi the list of supported languages and some additional options, such the addition of line numbers or highlighting a line in the code.

Refers to an application

When you mention an application, prefer to use the capitalization of the official website. If the web site is not consistent, select a form and try to be in your article.
On the other hand, Don't capitalize not the names of packages or orders, if they are not.
Exampl :

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



Lists

Each type of list usage.

Unordered lists

These lists are useful for :

  • the prerequi
  • the checklist
Exampl Result
* élément 1
* élément 2
  • element 1
  • element 2


Definition lists

These lists are useful for :

  • terms and explanations
  • explanations for the variables in a command line or file
Exampl Result
;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


Ordered lists

Ordered lists are to be used sparingly. It can be practical to list the order of a process, such as the processing of a query DNS.

Exampl Result
# élément 1
# élément 2
  1. élément 1
  2. élément 2


These lists are useful for :

  • describe a process

In some cases, the use of a table will be preferable to lists.

Tables

Here is a simple example of a table. This can be useful to more easily present sample code and its result. The tables are structured as follows.

{| beginnin table
|+ Overview content, Optional; one per table positioned between the beginning of the array and the first line
|- beginning of l, Optional on the first line -- the wiki engine supports the first line
! cell header, optional. The headers may be placed either on the same line separated by double exclamations points (!!), either on separate lines, each with its unique exclamation point (!).
| cell of data , requis! Consecutive table data cells can be either placed on the same line separated by a double vertical bar (||), either on separate lines, each with its unique vertical bar (|).
|} end of array


Exampl Result
{|
|Orange
|Apple
|-
|Bread
|Pie
|-
|Butter
|Ice cream 
|}
Orange Apple
Bread Pie
Butter Ice cream

For more information on tables, please consult the Manual wikimedia

Scripts and files

Be sure to describe the role of files or scripts that you mention. In this way the reader will have the same level of information that you and will be more able to understand your approach.

Scripts

When you give the contents of a script or a configuration file, make sure you it is commented, preferably at the level of the lines concerned. The aim is that the reader understand all of the actions described, so it is important to be more educational as possible. In this way, it will be more able to customize, update or diagnose problems with its server in the long term.

If the files that you post have long parts and /or not interesting for your tutorial, you can omit these parties with the ellipse (...).
We recommend the use of the Balise GeSHi to display the contents of the scripts or files. The latter will allow you, in addition to syntax highlighting, simply indicate numbers of lines and highlight the more important. It is recommended that you use the highlighting to indicate the lines where there are changes to perform.

Exampl Result
<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>


File

You have the possibility of inserting a file or an image in your tutorial. The simplest way to achieve the thing is to mention the document in your article, then put online once completed writing. If the file does not already exist, it will be pointed to by a red link. By clicking on this link, you will come to a page that will allow you to upload your file.

Exampl Result
[[Media:mon_fichier.txt]]

Media:mon_fichier.txt

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.

Images

Images are treated as files. You can therefore include them and put them online in the same way as files.
The only difference with a file is that the image will be displayed in the text. What gives you more options to display.

The syntax to comply is :

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

Options and description are optional.

Exampl Result
[[File:sample_image.jpg|200px|thumb|right|modèle image]]
  • 200P : size to display
  • thumb : the image is inked in a setting that will display the descrip
  • right : alignment of the image right
modèle image


You can find more information about the different options available on the image manipulation on the mediawiki manual.
Avoid using too heavy images and prefer to use jpg, jpeg and png formats.

Keyboard keys

To describe the keyboard keys, follow these recommendations :

  • write them in uppercase
  • use the tag <span>
  • use the symbol + If they have to be pressed simultaneously
Exampl Result
Support on <span style="background-color: #E6E6E6;">CTRL</span>+<span style="background-color: #E6E6E6;">ALT</span>+<span style="background-color: #E6E6E6;">SUPP</span> The '''Task Manager '''

Appuyer sur CTRL+ALT+SUPP The Task Manager


Host names

It is recommended that you use host names the most specific possible, that is in relation to the role of the server.
Exampl :

  • dns_serveur
  • bdd_master
  • proxy_nginx
  • etc.


Domain names

When you are dealing with domain names, prefer to use the field domain.tld as the default domain. If you have multiple domain names to mention, you can choose to use names such as domain 1.tld, domain 2.tldetc. |

For subdomains, we recommend that you use a name in connection with the role to which this subdomain will be attached, as master.Domaine.tl, slave.Domaine.tl, BDD.Domaine.tletc. |

IP address

To avoid to disclose your IP in your tutorials and be as clear as possible, we invite you to meet the 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. Eit 203.0.113.0 à 203.0.113.255.

For the addresses of local networks and localhost, you can keep the IP that you usually use. It means :

  • 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



Link

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 u ?

0



You are not allowed to post comments.