Différences entre versions de « Comment formater son article »

De Ikoula Wiki
Jump to navigation Jump to search
m
 
(112 versions intermédiaires par 7 utilisateurs non affichées)
Ligne 1 : Ligne 1 :
−
{{tocright}}
+
<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]]
−
==Introduction==
+
<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_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_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_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_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_de_title="Artikel formatieren"  data-link_translate_de_url="Artikel+formatieren"></span>[[:de:Artikel formatieren]][[de:Artikel formatieren]]
 +
<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_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_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]]
  
 +
{{#seo:
 +
|title=Comment formater son article
 +
|title_mode=append
 +
|keywords=these,are,your,keywords
 +
|description=Comment formater son article
 +
|image=Uploaded_file.png
 +
|image_alt=Wiki Logo
 +
}}
 +
 +
<!--T:1-->
 
Cet article explique comment formater votre tutoriel. En suivant ce guide et celui sur le [[Comment rédiger un article pour la communauté iKoula | style de rédaction]], votre tutoriel appliquera les recommandations d'{{iKoula}}.
 
Cet article explique comment formater votre tutoriel. En suivant ce guide et celui sur le [[Comment rédiger un article pour la communauté iKoula | style de rédaction]], votre tutoriel appliquera les recommandations d'{{iKoula}}.
  
  
−
==Syntaxe wiki==
+
==Syntaxe wiki== <!--T:2-->
  
−
Les tutoriaux {{iKoula}} doivent être formaté en utilisant la [http://www.mediawiki.org/wiki/Help:Formatting syntaxe wiki].
+
<!--T:3-->
 +
Les tutoriels {{iKoula}} doivent être formaté en utilisant la [http://www.mediawiki.org/wiki/Help:Formatting syntaxe wiki].
 
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 section d'aide de mediawiki] quant au formatage wiki.
 
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 section d'aide de mediawiki] quant au formatage wiki.
  
  
−
==Headers==
+
==Chapitres== <!--T:4-->
−
This section explains how to use headers in your tutorial.
+
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 />
 +
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 />
  
−
===Title===
+
===Les différents niveaux de titre=== <!--T:5-->
  
−
The tutorial should begin with a title using an H1 header.
+
<!--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 />
 +
Exemple pour le titre de cette section :<br />
 +
<nowiki>==Chapitres==</nowiki><br />
  
−
For procedural tutorials, the title should begin with How To.
+
Plus vous mettrez de signe autour de votre titre, plus vous descendrez dans l'arborescence.<br />
−
 
+
{| style="width:100%"
−
The typical title should follow the format of How To do <Task> with <Software> on <Distro>.
+
! style="width: 50%;"|Exemple
−
 
+
! style="width: 50%;"|Résultat
−
Markdown Example:
+
|-
−
 
+
| style="padding: 5px;"|
−
# How To Set Up a Firewall Using IPTables on Ubuntu 14.04
+
<nowiki>===Titre de niveau 3===</nowiki>
−
Result:
+
<nowiki>====Titre de niveau 4====</nowiki>
−
 
+
<nowiki>=====Titre de niveau 5=====</nowiki>
−
How To Set Up a Firewall Using IPTables on Ubuntu 14.04
+
| style="padding: 5px;"|
−
===Introduction===
+
===Titre de niveau 3=== <!--T:7-->
−
 
+
====Titre de niveau 4====
−
The first section of every tutorial should have the H3 header Introduction, followed by a paragraph or more describing the goals, methods, and results of the tutorial.
+
=====Titre de niveau 5=====
−
 
+
|}
−
Markdown Example:
+
<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 quatre chapitres ou sous-chapitres.
−
### Introduction
+
<br /><br />
−
 
 
−
OpenSSL is a versatile command line tool that can be used for a large variety of tasks related to Public Key Infrastructure (PKI) and HTTPS (HTTP over TLS).
 
−
 
 
−
Result:
 
−
 
 
−
Introduction
 
−
 
 
−
OpenSSL is a versatile command line tool that can be used for a large variety of tasks related to Public Key Infrastructure (PKI) and HTTPS (HTTP over TLS).
 
−
 
 
−
Typically, the introduction should cover:
 
−
 
 
−
Main topic of the tutorial
 
−
Practical reasons the reader would want to follow this tutorial; e.g., Why should I install this software? Why would I want to monitor my server this way?
 
−
Methods used, including all software involved
 
−
Final result; i.e., What will the reader have accomplished at the end of the tutorial?
 
−
Goals (Optional)
 
−
 
 
−
You can include an optional Goals section if your tutorial has a complicated purpose, method, or result.
 
−
 
 
−
Prerequisites
 
−
 
 
−
Introduce your prerequisites with a sentence or several paragraphs, as needed. Then, include all of the required items, software, and configurations as separate list items that the reader can use as a checklist.
 
−
 
 
−
Common prerequisite bullet points include:
 
−
 
 
−
Distribution and size (if there are minimum requirements) of the Droplet; e.g., Debian 7
 
−
Number of Droplets needed and roles, for multi-server setups
 
−
Link to a tutorial about setting up a sudo user for the appropriate distribution
 
−
Link to a tutorial about installing prerequisite software, such as LAMP
 
−
Link to part of a tutorial; e.g., Follow Step 1 from this tutorial to install RVM
 
−
Required DNS settings
 
−
Required SSL certificates
 
−
Remember that your tutorial should get the reader from the deployment of a vanilla distribution image to a working setup. If your tutorial is not going to start with the first SSH connection to the server, you need to link to another DO tutorial that does.
 
−
 
 
−
When you link to another DO tutorial as a prerequisite, make sure that you follow all the commands from that other tutorial yourself during testing. Your bash history should match the commands from every tutorial you use as a prerequisite.
 
−
 
 
−
H2 Steps and Body Headers
 
−
 
 
−
Every header must include at least one sentence under it that describes the context or purpose of that section of the tutorial. For example, you could say, In this section we will install Nginx as our load balancer. Don't jump from one header to another, and don't start a section with a contextless instruction or command.
 
−
 
 
−
Every header of the same level should use the same part of speech. Default to the gerund — that means -ing words. Consistency is the most important rule.
 
−
 
 
−
Do not use special formatting in headers.
 
−
 
 
−
Headers in the main body of the tutorial should be H2. In Markdown, make an H2 header with two hash marks followed by a space (*## *), followed by the title text.
 
−
 
 
−
For procedural tutorials, headers should include step numbers (numerical) followed by an em dash (—), like Step 1 — Installing Nginx.
 
−
 
 
−
Markdown Example:
 
−
 
 
−
## [Example] Step 1 — Installing Nginx
 
−
 
 
−
In this section we will install Nginx as our load balancer.
 
−
Result:
 
−
 
 
−
[Example] Step 1 — Installing Nginx
 
−
In this section we will install Nginx as our load balancer.
 
−
 
 
−
===Subheaders===
 
−
 
 
−
H3 headers should be used sparingly. H4 headers should be avoided. If you need to use subheaders, make sure there are two or more headers of that level within that section of the tutorial.
 
−
 
 
−
Remember your introductory sentences.
 
−
 
 
−
Markdown Example:
 
−
 
 
−
## [Example] Step 1 — Installing Nginx
 
−
 
 
−
Text
 
−
 
 
−
## [Example] Step 2 — Configuring the Virtual Host File
 
−
 
 
−
Text
 
−
 
 
−
### [Example] Upstream Module
 
−
 
 
−
Text
 
−
 
 
−
### [Example] Proxy Settings
 
−
 
 
−
Text
 
−
Result:
 
−
 
 
−
[Example] Step 1 — Installing Nginx
 
−
Text
 
−
 
 
−
[Example] Step 2 — Configuring the Virtual Host File
 
−
Text
 
−
 
 
−
[Example] Upstream Module
 
−
 
 
−
Text
 
−
 
 
−
[Example] Proxy Settings
 
−
 
 
−
Text
 
−
 
 
−
==Code==
 
−
Code formatting should be used for:
 
−
 
 
−
commands
 
−
files and scripts
 
−
output
 
−
interactive dialogues
 
−
in-line items as explained in that section
 
−
Every code block needs an explanation. The sentence must describe what the code block does. Examples of good explanations:
 
−
 
 
−
Change to the /usr/bin directory.
 
−
Now we will update the port for this Apache virtual host.
 
−
This short script sets up a weekly cron job to rotate the log files.
 
−
Markdown Example:
 
−
 
 
−
```command
 
−
cd /usr/bin
 
−
```
 
−
Result:
 
−
 
 
−
Change to the /usr/bin directory:
 
−
 
 
−
cd /usr/bin
 
−
You will notice variable highlighting in some of examples in this section. Variables are explained in the next section.
 
−
 
 
−
Commands in Code Blocks
 
−
 
 
−
Assume a non-root sudo user.
 
−
 
 
−
If you want to use an example username, you can use sammy. In your prerequisites, you should link to a tutorial for setting up a sudo user for the right distro. (Exceptions: You can use root or a nonprivileged user if needed.)
 
−
 
 
−
Every command needs an explanation. The sentence must describe what the command does. e.g., Change to the /usr/bin directory. Describe options and flags as necessary.
 
−
 
 
−
Most commands should be on their own lines in code blocks, not in-line. Any command that the reader needs to execute to complete the tutorial should be on its own line.
 
−
 
 
−
Do not include the command prompt in the code block for bash, MySQL, etc. Use the customized DigitalOcean markdown, demonstrated below, to add the prompts to the code blocks. You can also explain context changes in the text.
 
−
 
 
−
You can create a standard markdown code block by surrounding the block with three backticks (```). The DigitalOcean markdown parser allows you to add the appropriate prompt by using "```command" (normal, non-root user), "```super_user" (root user), "```custom_prefix(customized>)" (any other prompt).
 
−
 
 
−
Markdown Example:
 
−
 
 
−
As a non-root user with sudo privileges, update your package lists:
 
−
 
 
−
```command
 
−
sudo apt-get update
 
−
```
 
−
 
 
−
As root, add a user named "sammy":
 
−
 
 
−
```super_user
 
−
adduser sammy
 
−
```
 
−
 
 
−
In the MySQL console, run this command to put the changes into effect:
 
−
 
 
−
```custom_prefix(mysql>)
 
−
FLUSH PRIVILEGES;
 
−
```
 
−
Result:
 
−
 
 
−
As a non-root user with sudo privileges, update your package lists:
 
−
 
 
−
sudo apt-get update
 
−
As root, add a user named "sammy":
 
−
 
 
−
adduser sammy
 
−
In the MySQL console, run this command to put the changes into effect:
 
−
 
 
−
FLUSH PRIVILEGES;
 
−
When can I group commands?
 
−
 
 
−
You can group commands that are covered by the same short explanation. For example, it's okay to group commands to create and then change to a new directory.
 
−
 
 
−
Markdown Example:
 
−
 
 
−
Create and change to the `Downloads` directory:
 
−
 
 
−
```command
 
−
mkdir ~/Downloads
 
−
cd ~/Downloads
 
−
```
 
−
Result:
 
−
 
 
−
Create and change to the downloads directory:
 
  
−
mkdir ~/downloads
+
==Styles== <!--T:56-->
−
cd ~/downloads
 
−
Please make sure that the first time you issue a sudo command, a command that includes a highlighted variable, or any other command that requires input, it's on its own line. When in doubt, separate your commands to one per line.
 
  
−
Sometimes you'll want to make sure that a command is only executed if the first command is successful. This is especially important for destructive commands. Chain these commands with a double ampersand (&&) for safety.
+
Vous pouvez formater votre texte en utilisant la syntaxe wiki et quelques balises HTML.
−
 
 
−
Markdown Example:
 
−
 
 
−
Delete the unencrypted file:
 
−
 
 
−
```command
 
−
cd ~/downloads/foo && rm bar.txt
 
−
```
 
−
Result:
 
−
 
 
−
Delete the unencrypted file:
 
−
 
 
−
cd ~/downloads/foo && rm bar.txt
 
−
When should I use in-line code formatting?
 
−
 
 
−
In-line commands are useful for referencing:
 
−
 
 
−
command names
 
−
package names
 
−
optional or destructive commands
 
−
file names and paths like ~/.ssh/authorized_keys
 
−
options like -latr
 
−
arguments like filename
 
−
example URLs like http://example.com/myapp
 
−
ports like :3000
 
−
key presses like ENTER
 
−
Don't use in-line code for commands the reader needs to execute to complete the tutorial. Also, don't use it to emphasize something; use bold for that.
 
−
 
 
−
In-line commands can be formatted with a single backtick (`) before and after the in-line text.
 
−
 
 
−
In-line Code Examples:
 
−
 
 
−
We can use `knife ssh` to issue commands to our nodes.
 
−
We can use knife ssh to issue commands to our nodes.
 
−
 
 
−
Append the public key to the `/home/sammy/.ssh/authorized_keys` file.
 
−
Append the public key to the /home/sammy/.ssh/authorized_keys file.
 
−
 
 
−
Remember to replace `master_private_ip` in the config file below with your master DNS server's private IP address.
 
−
Remember to replace master_private_ip in the config file below with your master DNS server's private IP address.
 
−
 
 
−
It's time to install the `mysql-server` package.
 
−
It's time to install the mysql-server package.
 
−
 
 
−
==Files and Scripts==
 
−
 
 
−
Always introduce a file or script by describing its general purpose. Then explain any changes that the reader will be making in the file.
 
−
 
 
−
Short files and scripts should be thoroughly explained in an introductory paragraph. Longer configuration files and scripts should have detailed in-line comments (at least at the block level, and possibly at the line level).
 
−
 
 
−
We do not want to encourage readers to copy and paste long files without understanding. If the reader just copies and pastes a big file, they will not be able to customize, update, or troubleshoot their server in the long run.
 
−
 
 
−
Do not include custom scripts with your tutorial. (Some exceptions include short commands that need to be run by cron, and configuration management recipes.)
 
−
 
 
−
Excerpts and omissions can be indicated with ellipses (. . .). If most of a file can be left with the default settings, it's usually better to show just the section that needs to be changed.
 
−
 
 
−
A label can be added to the code block, to denote the filename that is being shown, by adding "[label /path/to/file]" within the code block. This is demonstrated in the example. If you are showing an entire file, you may add line numbers to the code block by starting your code block with "```line_numbers".
 
−
 
 
−
Markdown Example: (This is an image)
 
−
 
 
−
File Markdown Example
 
−
 
 
−
Result:
 
−
 
 
−
Locate the <Directory /var/www/> block in the /etc/apache2/sites-available/default file and set AllowOverride to All. This will allow your .htaccess file to function. You can leave the other settings as they are (not shown):
 
−
 
 
−
/etc/apache2/sites-available/default
 
−
<Directory /var/www/>
 
−
 
 
−
. . .
 
−
 
 
−
          AllowOverride All
 
−
 
 
−
. . .
 
−
 
 
−
</Directory>
 
−
Output
 
−
 
 
−
Describe output code blocks so the reader realizes that this is output, not something that should be executed on the command line. Often a simple Output: will suffice.
 
−
 
 
−
Highlight any unique output the reader needs to use later, like an auto-generated secret key.
 
−
 
 
−
A secondary_label can be added to the code block, to denote "Output" is being shown. This is demonstrated in the example.
 
−
 
 
−
Markdown Example: (This is an image)
 
−
 
 
−
Output example
 
−
 
 
−
Result:
 
−
 
 
−
Note down the output string. We will be using it in the configuration file of both the master and slave servers.
 
−
 
 
−
Output
 
−
 
 
−
sHi0avMk1bME89cnJdHkYzFBbvQmQ8YZ
 
−
Interactive Dialogues
 
−
 
 
−
If your interactive dialogue brings up a graphical user interface, like when you install MySQL, please use an image.
 
−
 
 
−
If your interactive dialogue is just text, you can show the prompt in a code block, and the user entry in red. You should explain that this is how you're showing the input.
 
−
 
 
−
Please don't show the entire output if it's long.
 
−
 
 
−
Example:
 
−
 
 
−
What domain do you want to use for the OpenShift hosts? openshift.example.com
 
−
==Key Presses==
 
−
 
 
−
Key presses:
 
−
 
 
−
ALL CAPS
 
−
Use in-line code formatting
 
−
Use a plus symbol (+) if keys need to be pressed simultaneously
 
−
Examples:
 
−
 
 
−
Press ENTER.
 
−
 
 
−
To stop tailing the log file, press CTRL+C.
 
−
 
 
−
Variables
 
−
Often you will need to highlight variables in your commands, config files, example URLs, etc. Any item that needs to be changed by the reader should be highlighted. However, please don't highlight every possible setting that can be changed if the default example is fine to copy. It's what the reader should change, not what the reader could change.
 
−
 
 
−
Use this symbol to highlight variables: <^>.
 
−
 
 
−
DigitalOcean's Markdown parser will use this symbol to turn text red, even in an otherwise unformatted block or line. This only works in-line; you would have to highlight each line to turn multiple lines red.
 
−
 
 
−
Markdown Example: (This is an image)
 
−
 
 
−
Highlighting example <span class='highlight'>your highlighted code here</span>
 
−
 
 
−
Result:
 
−
 
 
−
your highlighted code here
 
−
If you reference a variable in a context where you would normally also use in-line code formatting, you should use both styles.
 
−
 
 
−
Use these examples throughout your tutorial. (These haven't always been used in all DO tutorials, but they're a good guideline.)
 
−
 
 
−
If you are writing a tutorial as part of a series, please use the same variables throughout the series.
 
−
 
 
−
==Users==
 
−
 
 
−
sammy is the default username.
 
−
 
 
−
You can also choose something descriptive, like webdav-kai or nsd. Please choose gender-neutral names or alternate between gendered names.
 
−
 
 
−
Use bold when you reference a specific user, especially if you are switching users.
 
−
 
 
−
==Hostnames==
 
−
 
 
−
your_server is the default hostname.
 
−
 
 
−
You are encouraged to choose something descriptive, especially in multi-server setups, like nsd_master or mysql_slave_1.
 
−
 
 
−
==Domains==
 
−
 
 
−
example.com is the default domain.
 
−
 
 
−
For multi-server setups, you can choose something like master-1.example.com or slave-1.example.com.
 
−
 
 
−
==IP Addresses==
 
−
 
 
−
your_server_ip is the default way to show an IP address. You should use in-line code with variable highlighting.
 
−
 
 
−
If you need to show multiple IPs, you can do it with formatting like master_private_ip and slave_private_ip.
 
−
 
 
−
If you need to illustrate more realistic IP addresses, you can use 111.111.111.111, 111.111.111.222, etc.
 
−
 
 
−
==URLs==
 
−
 
 
−
Example URLs, that contain a variable the reader needs to customize, should use code formatting with the variable highlighted.
 
−
 
 
−
Examples:
 
−
 
 
−
https://example.com:3000/simple/
 
−
http://your_server_ip/
 
−
If it's a live link, use a standard Markdown link instead, without code formatting.
 
−
 
 
−
==Liens==
 
−
{{:Créer_un_lien}}
 
−
 
 
−
==GUIs==
 
−
If your tutorial references a graphical user interface (GUI), you should include screenshots. You don't have to include a new screenshot for every single button, field, or link, but show enough that the reader can navigate the interface easily.
 
−
 
 
−
You can add arrows and outlines to the image to improve comprehension.
 
−
 
 
−
Please use bold text to refer to any element in the GUI, whether that is a button, link, checkbox, tab, popup text, or anything else.
 
−
 
 
−
Please specify the type of element you're referencing and its location on the page.
 
−
 
 
−
Example:
 
−
 
 
−
Select DNS from the left navigation menu. Then click anywhere in the IP address area (104.131.240.129 in the example) to edit the A record for the subdomain subdomain entry.
 
−
 
 
−
Click in the IP address area to edit the subdomain record
 
−
 
 
−
Press ENTER to save your change. The message Domain record was successfully updated will appear at the top of the screen.
 
−
 
 
−
For nested menus, it's fine to say something like:
 
−
 
 
−
From the top navigation menu, go to Settings > Networking > Domains.
 
−
 
 
−
Don't assume your reader is familiar with the GUI; that's why they're reading a tutorial about it.
 
−
 
 
−
==Images and Other Assets==
 
−
The general format for including an image is as follows. Please include descriptive alt text so readers using a screen reader can rely on the alt text rather than the image.
 
−
 
 
−
Markdown Example:
 
−
 
 
−
![Alt text for screen readers](/path/to/img.png)
 
−
Screenshots and other images:
 
−
 
 
−
Use the .png file format
 
−
Max size of 745x745 pixels
 
−
Make the image with as short a height as possible
 
−
Larger images should be broken into multiple images or resized
 
−
Borders are not required, but if one would make the image clearer, use #eeeeee, 1px
 
−
Host images on imgur
 
−
DigitalOcean will take care of uploading images to our servers
 
−
Types of images:
 
−
 
 
−
==GUI images==
 
−
Technical diagrams
 
−
Terminal menus that can't be copied
 
−
Please do not include images of the console. Commands and output should be included as code-style text so they can be copied.
 
−
Below are three good examples of images, including a technical diagram and a terminal menu that have been uploaded by DigitalOcean, and a GUI image hosted on imgur.
 
−
 
 
−
Markdown Example:
 
−
 
 
−
![The haproxy-www load balancer sits in front of two WordPress servers, wordpress-1 and wordpress-2, which connect to the same mysql-1 database server backend](https://assets.digitalocean.com/articles/article_guidelines/diagram.png)
 
−
Result:
 
−
 
 
−
The haproxy-www load balancer sits in front of two WordPress servers, wordpress-1 and wordpress-2, which connect to the same mysql-1 database server backend
 
−
 
 
−
Markdown Example:
 
−
 
 
−
![Enter your mail destinations and then select <Ok>](https://assets.digitalocean.com/articles/article_guidelines/legit_img.png)
 
−
Result:
 
−
 
 
−
Enter your mail destinations and then select <Ok>
 
−
 
 
−
Markdown Example:
 
−
 
 
−
![Click in the IP address area to edit the subdomain record](http://i.imgur.com/ia3M6Wm.png)
 
−
Result:
 
−
 
 
−
Click in the IP address area to edit the subdomain record
 
−
 
 
−
If you want a diagram for your tutorial, you can provide a mockup, and we can create a diagram that matches our style.
 
−
 
 
−
Other assets:
 
−
 
 
−
Occasionally you will want the reader to have access to a configuration file that is too long to display in the main body of the tutorial. DigitalOcean will host this file on our asset server. You can use standard link formatting to link to the file.
 
−
 
 
−
==Styles==
 
−
 
 
−
Follow these conventions for when to use various element styles. Code styles are used in a variety of ways, so please see the earlier section for details about block and in-line code formatting.
 
−
You can format your text by using wiki markup. This consists of normal characters like asterisks, apostrophes or equal signs which have a special function in the wiki, sometimes depending on their position.
 
 
<br />
 
<br />
−
===Gras===
+
===Gras=== <!--T:8-->
  
 +
<!--T:9-->
 
Voici comment mettre un terme en gras dans votre article.
 
Voici comment mettre un terme en gras dans votre article.
 
<br />
 
<br />
−
Exemple wikitext :
+
{| style="width:100%"
 +
! style="width: 50%;"|Exemple
 +
! style="width: 50%;"|Résultat
 +
|-
 +
| style="padding: 5px;"|
 
  <nowiki>'''texte en gras'''</nowiki>
 
  <nowiki>'''texte en gras'''</nowiki>
−
<br />
+
| style="padding: 5px;"|
−
Résultat :<br />
 
 
'''texte en gras'''
 
'''texte en gras'''
 +
|}
 
<br />
 
<br />
 
Voici une liste d'éléments qui devraient être en gras.
 
Voici une liste d'éléments qui devraient être en gras.
 
* Texte visible d'une GUI
 
* Texte visible d'une GUI
−
* Changement de contexte pour une commande, tel que changer d'utilisateur ou de serveur
+
* Changement de contexte pour une commande, tel que changer d'utilisateur ou de {{Template:Serveur}}
−
* Noms d'hôte comme '''serveur-1'''
+
* Noms d'hôte comme '''{{Template:Serveur}}-1'''
 
* Utilisateurs comme '''ikoula'''
 
* Utilisateurs comme '''ikoula'''
 
* Prompts
 
* Prompts
 
* Liste de termes, comme :
 
* Liste de termes, comme :
 
** '''MySQL''': moteur de base de données
 
** '''MySQL''': moteur de base de données
−
** '''Apache''': serveur web
+
** '''Apache''': {{Template:Serveur}} web
 
* Eléments que le lecteur ne doit pas rater, sans trop en faire.
 
* Eléments que le lecteur ne doit pas rater, sans trop en faire.
 
<br />
 
<br />
  
−
===Italique===
+
===Italique=== <!--T:10-->
  
−
L'italique ne devrait être utilisé que pour introduire les termes techniques. Ex. : le serveur nginx sera utilisé comme ''reverse proxy''.
+
<!--T:11-->
 +
L'italique ne devrait être utilisé que pour introduire les termes techniques. Ex. : le {{Template:Serveur}} nginx sera utilisé comme ''reverse proxy''.
 
<br />
 
<br />
−
Exemple wikitext :
+
{| style="width:100%"
 +
! style="width: 50%;"|Exemple
 +
! style="width: 50%;"|Résultat
 +
|-
 +
| style="padding: 5px;"|
 
  <nowiki>''texte en italique''</nowiki>
 
  <nowiki>''texte en italique''</nowiki>
−
<br />
+
| style="padding: 5px;"|
−
Résultat :<br />
 
 
''texte en italique''
 
''texte en italique''
 +
|}
 
<br />
 
<br />
  
−
===Notes et avertissements===
+
===Notes et avertissements=== <!--T:12-->
  
−
L'utilisation de certaines balises HTML peuvent être nécessaire pour mettre en évidence certains éléments tels que des notes ou des avertissements.
+
<!--T:13-->
−
<br /><br />
+
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 wikitext + HTML :
+
<br />
 +
{| style="width:100%"
 +
! style="width: 50%;"|Exemple
 +
! style="width: 50%;"|Résultat
 +
|-
 +
| 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>
 
</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''': Ceci est un avertissement.</div>
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
| style="padding: 5px;"|
 +
<div style="background-color: #FFCC99;">'''Note''': Ceci est une note.</div>
 
<br />
 
<br />
−
Résultat :
+
<div style="background-color: #FF9999;">'''Warning''': Ceci est un avertissement.</div>
−
<div style="background-color: #FFCC99;"> '''Note''': Ceci est une note.</div>
+
|}
 +
<br /><br />
 +
 
 +
===Blockquotes=== <!--T:14-->
 +
 
 +
<!--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.
 
<br />
 
<br />
−
<div style="background-color: #FF9999;"> '''Warning''': Ceci est un avertissement.</div>
+
{| style="width:100%"
 +
! style="width: 50%;"|Exemple
 +
! style="width: 50%;"|Résultat
 +
|-
 +
| style="padding: 5px;"|
 +
<nowiki> Texte important ''italique''</nowiki><br />
 +
ou <br />
 +
<nowiki><pre>Texte important ''italique''</pre></nowiki>
 +
| style="padding: 5px;"|
 +
Texte important ''italique''
 +
ou <br />
 +
<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 />
 +
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 />
  
−
===Blockquotes===
+
===Code source=== <!--T:16-->
  
−
You may use blockquotes to set the indent the text, which is useful for calling out important content.
+
<!--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.
−
Exemple wikitext :<br />
+
<br />
−
<nowiki> Texte important</nowiki><br />
+
{| style="width:100%"
−
Résultat :<br />
+
! style="width: 50%;"|Exemple
−
Texte important
+
! style="width: 50%;"|Résultat
 +
|-
 +
| style="padding: 5px;"|
 +
<nowiki><syntaxhighlight lang="php"></nowiki><br />
 +
<nowiki><?</nowiki><br />
 +
&nbsp;&nbsp;&nbsp;&nbsp;<nowiki>    $hello = "Hello World";</nowiki><br />
 +
&nbsp;&nbsp;&nbsp;&nbsp;<nowiki>    echo $hello;        // comment</nowiki><br />
 +
<nowiki>?></nowiki><br />
 +
<nowiki></syntaxhighlight></nowiki>
 +
| style="padding: 5px;"|
 +
<syntaxhighlight lang="php">
 +
<?
 +
    $hello = "Hello World";
 +
    echo $hello;        // comment
 +
?>
 +
</syntaxhighlight>
 +
|}
 
<br />
 
<br />
−
Referring to Software
+
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.
−
Use the official capitalization of the software name from its website if available. If the product website is not consistent, please be consistent within a single article. We capitalize the first letter of Nginx.
+
<br /><br />
  
−
If you are referencing the software by name, please capitalize it properly. On the other hand, you don't have to capitalize commands and package names.
+
==Référence à une application== <!--T:18-->
  
−
Example:
+
<!--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.
−
A MySQL database vs. the mysql command or the mysql-server package.
+
<br />
 +
Par contre, ne capitalisez pas les noms de paquets ou des commandes, si ces derniers ne le sont pas.
 
<br />
 
<br />
 +
Exemple :<br />
 +
A MySQL database vs. the mysql command or the mysql-server package.
 +
<br /><br />
  
−
==Listes==
+
==Listes== <!--T:20-->
  
 
A chaque type de liste son utilisation.
 
A chaque type de liste son utilisation.
 
<br />
 
<br />
−
===Listes non-ordonnées===
+
===Listes non-ordonnées=== <!--T:21-->
−
Exemple wikitext :
+
 
 +
<!--T:22-->
 +
Ces listes sont utiles pour :
 +
* les prérequis
 +
* les checklists
 +
{| style="width:100%"
 +
! style="width: 50%;"|Exemple
 +
! style="width: 50%;"|Résultat
 +
|-
 +
| style="padding: 5px;"|
 
  <nowiki>* élément 1
 
  <nowiki>* élément 1
 
* élément 2</nowiki>
 
* élément 2</nowiki>
−
<br />
+
| style="padding: 5px;"|
−
Résultat :
 
 
* élément 1
 
* élément 1
 
* élément 2
 
* élément 2
 +
|}
 
<br />
 
<br />
 +
 +
===Listes de définitions=== <!--T:23-->
 +
 +
<!--T:24-->
 
Ces listes sont utiles pour :
 
Ces listes sont utiles pour :
−
* les prérequis
+
* les termes et explications
−
* les checklists
+
* explications pour les variables dans une ligne de commande ou un fichier
−
<br />
+
{| style="width:100%"
−
===Listes de définitions===
+
! style="width: 50%;"|Exemple
−
 
+
! style="width: 50%;"|Résultat
−
Exemple wikitext :
+
|-
 +
| style="padding: 5px;"|
 
  <nowiki>;mot 1
 
  <nowiki>;mot 1
 
: définition 1
 
: définition 1
Ligne 576 : Ligne 234 :
 
: définition 2-1
 
: définition 2-1
 
: définition 2-2</nowiki>
 
: définition 2-2</nowiki>
 +
| style="padding: 5px;"|
 +
;mot 1
 +
: définition 1
 +
;mot 2
 +
: définition 2-1
 +
: définition 2-2
 +
|}
 
<br />
 
<br />
−
Ces listes sont utiles pour :
 
−
* les termes et explications
 
−
* explications pour les variables dans une ligne de commande ou un fichier
 
−
 
  
−
===Listes ordonnées===
+
===Listes ordonnées=== <!--T:25-->
  
 +
<!--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.
 
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 />
−
Exemple wikitext :
+
{| style="width:100%"
 +
! style="width: 50%;"|Exemple
 +
! style="width: 50%;"|Résultat
 +
|-
 +
| style="padding: 5px;"|
 
  <nowiki># élément 1
 
  <nowiki># élément 1
 
# élément 2</nowiki>
 
# élément 2</nowiki>
−
<br />
+
| style="padding: 5px;"|
−
Résultat :
 
 
# élément 1
 
# élément 1
 
# élément 2
 
# élément 2
 +
|}
 
<br />
 
<br />
 
Ces listes sont utiles pour :
 
Ces listes sont utiles pour :
 
* décrire un processus de traitement
 
* décrire un processus de traitement
−
<br /><br /><br />
 
 
Dans certains cas, l’utilisation d'un tableau sera préférable aux listes.
 
Dans certains cas, l’utilisation d'un tableau sera préférable aux listes.
 +
<br /><br />
 +
 +
===Tableaux=== <!--T:27-->
 +
 +
<!--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.
 +
 +
<!--T:57-->
 +
{|cellpadding="5" border="1" style="border-collapse:collapse;"
 +
|'''<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>''' || '''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.'' 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!'' 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'''
 +
|}
 +
 +
<!--T:58-->
 +
<br />
 +
{| style="width:100%"
 +
! style="width: 50%;"|Exemple
 +
! style="width: 50%;"|Résultat
 +
|-
 +
| style="padding: 5px;"|
 +
<pre>
 +
{|
 +
|Orange
 +
|Apple
 +
|-
 +
|Bread
 +
|Pie
 +
|-
 +
|Butter
 +
|Ice cream
 +
|}
 +
</pre>
 +
| style="padding: 5px;"|
 +
{|
 +
|Orange
 +
|Apple
 +
|-
 +
|Bread
 +
|Pie
 +
|-
 +
|Butter
 +
|Ice cream
 +
|}
 +
|}
 +
 +
<!--T:29-->
 +
Pour plus d'information sur les tableaux, vous pouvez consulter le [https://www.mediawiki.org/wiki/Help:Tables/fr manuel wikimedia]<br />
 +
 +
==Scripts et fichiers== <!--T:30-->
 +
 +
<!--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.
 +
<br />
 +
 +
===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 {{Template:Serveur}} sur le long terme.
 +
<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 '''(...)'''.
 +
<br />
 +
Nous vous recommandons l'utilisation de la [[#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 />
 +
 +
<!--T:60-->
 +
{| style="width:100%"
 +
! style="width: 50%;"|Exemple
 +
! style="width: 50%;"|Résultat
 +
|-
 +
| style="padding: 5px;"|
 +
<nowiki><syntaxhighlight lang="apache" line start="10" highlight="5">
 +
<VirtualHost *:80>
 +
    DocumentRoot /www/example1
 +
    ServerName www.example.com
 +
    # Other directives here
 +
</VirtualHost>
 +
</syntaxhighlight></nowiki>
 +
| style="padding: 5px;"|
 +
<syntaxhighlight lang="apache" line start="10" highlight="5">
 +
<VirtualHost *:80>
 +
    DocumentRoot /www/example1
 +
    ServerName www.example.com
 +
    # Other directives here
 +
</VirtualHost>
 +
</syntaxhighlight>
 +
|}
 +
<br />
 +
 +
===Fichiers=== <!--T:36-->
 +
 +
<!--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.
 +
<br />
 +
 +
<!--T:38-->
 +
{| style="width:100%"
 +
! style="width: 50%;"|Exemple
 +
! style="width: 50%;"|Résultat
 +
|-
 +
| style="padding: 5px;"|
 +
<nowiki>[[Media:mon_fichier.txt]]</nowiki>
 +
| style="padding: 5px;"|
 +
[[Media:mon_fichier.txt]]
 +
|}
 +
 +
<!--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.
 +
<br /><br />
 +
 +
===Images=== <!--T:40-->
 +
 +
<!--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 />
 +
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 />
 +
La syntaxe à respecter est la suivante :
 +
<nowiki>[[File:sample_image.jpg|options|description]]</nowiki>
 +
Les options et la description sont facultatives.
 +
<br />
 +
 +
<!--T:61-->
 +
{| style="width:100%"
 +
! style="width: 50%;"|Exemple
 +
! style="width: 50%;"|Résultat
 +
|-
 +
| style="padding: 5px;"|
 +
<nowiki>[[File:sample_image.jpg|200px|thumb|right|modèle image]]</nowiki>
 +
* '''200px''' : taille à afficher
 +
*<span class="notranslate"> '''thumb'''</span> : l'image est encrée dans un cadre qui affichera la description<br />
 +
* <span class="notranslate">'''right'''</span> : alignement de l'image à droite
 +
| style="padding: 5px;"| [[File:sample_image.jpg|200px|thumb|right|modèle image]]
 +
|}
 +
 +
<!--T:62-->
 +
<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 manuel de mediawiki].<br />
 +
Evitez d'utiliser des images trop lourdes et préférez utiliser les formats jpg, jpeg et png.
 +
<br /><br />
 +
 +
==Touches du clavier== <!--T:42-->
 +
 +
<!--T:43-->
 +
Pour décrire les touches de clavier, suivez ces recommandations :
 +
* les écrire en MAJUSCULE
 +
* utiliser la balise <nowiki><span></nowiki>
 +
* utiliser le symbole '''+''' si elles doivent être pressées simultanément
 +
 +
<!--T:44-->
 +
{| style="width:100%"
 +
! style="width: 50%;"|Exemple
 +
! style="width: 50%;"|Résultat
 +
|-
 +
| 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>
 +
| 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'''
 +
|}
 +
<br />
 +
 +
==Noms d'hôte== <!--T:45-->
 +
 +
<!--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 {{Template:Serveur}}.<br />
 +
Exemple :
 +
* dns_{{Template:Serveur}}
 +
* bdd_master
 +
* proxy_nginx
 +
* etc.
 +
<br />
 +
 +
==Noms de domaine== <!--T:47-->
  
 +
<!--T:48-->
 +
Lorsque vous traitez des {{Template:Nom de domaine}}s, préférez utiliser le domaine '''domaine.tld''' comme domaine par défaut.
 +
Si vous avez plusieurs {{Template:Nom de domaine}} à mentionner, vous pouvez choisir d'utiliser des noms tels que '''domaine-1.tld''', '''domaine-2.tld''', etc.
 +
<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.
 +
<br /><br />
  
 +
==Adresses IP== <!--T:49-->
  
−
==Conclusion==
+
<!--T:50-->
−
Write a brief conclusion for your tutorial to summarize what has been accomplished, and what the reader might want to do next.
+
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 adresses réservées] à 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 />
 +
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
 +
<br /><br />
  
−
That's all! Check out the [[Comment rédiger un article pour la communauté iKoula | Style Guide]], and happy writing!
+
==Liens== <!--T:51-->
 +
Vous pouvez trouver la méthodologie de création d'un lien sur la page suivante: [[Créer_un_lien]]
  
 +
==Captures d'écran== <!--T:52-->
  
 +
<!--T:53-->
 +
Si votre tutoriel décrit des actions à réaliser sur une interface graphique, il est préférable d'inclure des captures d'écran pour le rendre plus clair.
 +
Attention toutefois à ne pas en faire de trop. Il n'est pas question d'avoir une capture pour chaque bouton, zone de texte ou lien, mais juste ce qu'il faut pour que le lecteur réussisse à vous suivre.
 +
<br />
 +
Si vous souhaitez mettre des éléments de la capture en évidence, n'hésitez pas à y ajouter des flèches ou cadres pour les pointer. Cela n'en rendra le tutoriel que plus compréhensif.
 +
<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 à cocher, etc.
 +
<br />
 +
N'oubliez pas d'ajouter une description lorsque vous mettrez l'image en ligne.
 +
<br /><br />
 +
 +
==Conclusion== <!--T:54-->
 +
N'hésitez pas inclure une courte conclusion à votre tutoriel qui résumera ce qui a été fait et introduire ce qui pourrait être fait par la suite.
 +
<br />
 +
Vous avez tout ce qu'il faut pour créer vos propres articles ! En complément, vous pouvez aussi consulter notre article sur le [[Comment rédiger un article pour la communauté iKoula | style iKoula]], et bonne rédaction !
 +
 +
 +
<!--T:55-->
 +
<!-- Fin de l'article -->
 +
<br /><br />
 
Cet article vous a semblé utile ? <vote />
 
Cet article vous a semblé utile ? <vote />
 +
 +
<!--T:56-->
 +
 +
<!-- Commentaire -->
 +
<comments />
 +
 +
 
[[Category:Contribuer]]
 
[[Category:Contribuer]]
 +
[[Category:Interface]]

Version actuelle datée du 22 septembre 2021 à 14:23

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

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


Syntaxe wiki

Les tutoriels ikoula doivent être formaté en utilisant la syntaxe wiki. Cet article va vous donner les exemples les plus courants de cette syntaxe. Vous trouverez plus de détails dans la section d'aide de mediawiki 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 quatre 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 manuel 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 manuel de mediawiki.
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 nom de domaines, préférez utiliser le domaine domaine.tld comme domaine par défaut. Si vous avez plusieurs nom 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 adresses réservées à 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

Vous pouvez trouver la méthodologie de création d'un lien sur la page suivante: Créer_un_lien

Captures d'écran

Si votre tutoriel décrit des actions à réaliser sur une interface graphique, il est préférable d'inclure des captures d'écran pour le rendre plus clair. Attention toutefois à ne pas en faire de trop. Il n'est pas question d'avoir une capture pour chaque bouton, zone de texte ou lien, mais juste ce qu'il faut pour que le lecteur réussisse à vous suivre.
Si vous souhaitez mettre des éléments de la capture en évidence, n'hésitez pas à y ajouter des flèches ou cadres pour les pointer. Cela n'en rendra le tutoriel que plus compréhensif.

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 à cocher, etc.
N'oubliez pas d'ajouter une description lorsque vous mettrez l'image en ligne.

Conclusion

N'hésitez pas inclure une courte conclusion à votre tutoriel qui résumera ce qui a été fait et introduire ce qui pourrait être fait par la suite.
Vous avez tout ce qu'il faut pour créer vos propres articles ! En complément, vous pouvez aussi consulter notre article sur le style iKoula, et bonne rédaction !




Cet article vous a semblé utile ?

1



Vous n'êtes pas autorisé à publier de commentaire.

Récupérée de « https://fr-wiki.ikoula.com/index.php?title=Comment_formater_son_article&oldid=31750 »