How to format article

From EN Ikoula wiki
⧼vector-jumptonavigation⧽ ⧼vector-jumptosearch⧽

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.

Retrieved from "https://en-wiki.ikoula.com/index.php?title=How_to_format_article&oldid=12293"