Artikel formatieren

fr:Comment formater son article

Dieser Artikel wurde maschinell übersetzt. Sie können den Artikel Quelle hier ansehen.

fr::nl:Hoe te formatteren van artikelfr:nl:Hoe te formatteren van artikel fr::it:Come formattare articolofr:it:Come formattare articolo fr::pt:Como formatar o artigofr:pt:Como formatar o artigo fr::es:Cómo formato artículofr:es:Cómo formato artículo [[:fr::en:How to format articl]]fr:en:How to format article

Dieser Artikel beschreibt wie Sie Ihr Tutorial zu formatieren. Mit Hilfe dieser Anleitung und einer der Schreibstil, Ihr Tutorial gelten die Empfehlungen der Ikoula.

Wiki-Syntax

Tutorien Ikoula muss formatiert werden, mithilfe der Wiki-syntax. Dieser Artikel gibt Ihnen die häufigsten Beispiele für diese Syntax. Finden Sie weitere Details in der MediaWiki-Hilfe-Bereich wie für die Wiki-Formatierung.

Kapiteln

Um Ihre Tutorials in Kapitel zu schneiden, können Sie die Ebenen der Titel. Sobald Sie einen Titel in die Seite einfügen, werden alle folgenden Elemente als Teil des neuen Kapitels, bis der nächste Titel der gleichen Ebene berücksichtigt.
Dies kann zur Verbesserung der Der barkeit Ihres Artikels durch Herausschneiden der verschiedenen Phasen der Realisierung sehr nützlich sein.

Die verschiedenen Ebenen des Titels

Der Titel der Ebene 1 der Titel des Artikels entspricht. Es wird automatisch erstellt, wenn Sie Ihre Seite erstellen. Die Tracks sind gebaut um Ihre Titel Anzeichen "=". Der Titel der Ebene 2 der erste Titel der Kapitel oder Abschnitt entspricht.
Beispiel für den Titel dieses Abschnitts :

==Kapiteln ==

Mehr werde Sie signieren, um Ihre Titel, desto mehr gehen Sie unten in der Struktur.

Beispiel	Ergebnis
===Stufe Titel 3=== ====Stufe Titel 4==== =====Stufe Titel 5=====	Stufe Titel 3 Stufe Titel 4 Stufe Titel 5

Es sei darauf hingewiesen, dass ein Inhaltsverzeichnis automatisch angezeigt an der Spitze der Artikel wird, sobald es zumindest gibt 4 Kapitel oder Unterkapitel.

Stile

Sie können Ihren Text mit der Wiki-Syntax und ein paar HTML-Tags formatieren.

Fett

Here's How to end Fett in Ihrem Artikel.

Beispiel	Ergebnis
'''fetter Text '''	fetter Text

Hier ist eine Liste von Elementen, die in Fettschrift sein sollten.

• Sichtbaren Text über eine GUI
• Änderung des Kontextes für ein Steuerelement, z. B. ändern, Benutzer oder Server
• Hostnamen als Server - 1
• Nutzer wie Ikoder la
• Schnellen
• Liste von Begriffen, als :
  • MySQL : Datenbankmodul
  • Apache : Webserver
• Elemente, die der Spieler nicht entgehen lassen sollten, machen ohne zu viel.

Italic

Kursiv sollte nur verwendet werden, um Fachbegriffe einzuführen. Z.b. : die Nginx-Server, als verwendet werden Reverse-Proxy .

Beispiel	Ergebnis
''Text kursiv ''	Text kursiv

Hinweise und Warnungen

Die Verwendung von einige HTML-Tags zum Markieren Sie bestimmte Elemente wie Hinweise oder Warnungen möglicherweise erforderlich.

Beispiel	Ergebnis
<div style="backgroder nd-color: #FFCC99;"> '''Note''': Ceci est une note.</div> <div style="backgroder nd-color: #FF9999;"> '''Warning''': Ceci est un avertissement.</div>	Note: Ceci est une note. Warning: Ceci est un avertissement.

Blockquotes

Der Blockquotes Blöcke sind, wo der Text anders formatiert ist. Hierzu einfach setzen ein Leerzeichen an den Anfang des Satzes, oder schließen Sie Ihren Text aus Tags <pre>. Votre texte sera alors formaté dans un cadre avec une police différente.

Beispiel	Ergebnis
Wichtige Textpassagen ''Kursiv '' oder <pre>Texte important ''Kursiv ''</pre>	Wichtige Textpassagen Kursiv oder Texte important ''Kursiv ''

Comme voder s poder vez le noter, l'utilisation de la balise <pre> fait que toder t autre formatage à l'intérieur du bloc sera ignoré et considéré comme du texte à afficher. Si voder s utilisez la première méthode, avec l'espace en début de ligne, sachez qu'un retoder r à la ligne fermera le cadre.
Noder s préconisons d'Verwenden Sie das Tag GeSHi oder la méthode des notes et avertissements poder r afficher du code soder rce oder des informations importantes.

Code soder rce

Lorsque voder s publiez un code soder rce, voder s 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é, ajoder tez l'option lang="langage" dans la balise.

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

Voder s troder verez sur le site de l'extension GeSHi la liste des langages supportés et quelques options supplémentaires, telle l'ajoder t de numéros de ligne oder la mise en évidence d'une ligne dans le code.

Référence à une application

Lorsque voder s 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 oder des commandes, si ces derniers ne le sont pas.
Beispiel :

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 poder r :

• les prérequis
• les checklists

Beispiel	Ergebnis
* élément 1 * élément 2	élément 1 élément 2

Listes de définitions

Ces listes sont utiles poder r :

• les termes et explications
• explications poder r les variables dans une ligne de commande oder un fichier

Beispiel	Ergebnis
;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

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

Beispiel	Ergebnis
# élément 1 # élément 2	élément 1 élément 2

Ces listes sont utiles poder r :

• 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 poder r présenter plus facilement un code exemple et son résultat. Der 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. Der entêtes peuvent être mises soit sur la même ligne séparées par des doder bles points d'exclamations (!!), soit sur des lignes séparées, chacune ayant son unique point d'exclamation (!).
|	cellule de donnée , requis! Der cellules de données consécutives d'un tableau peuvent être soit mises sur la même ligne séparées par une doder ble barre verticale (||), soit sur des lignes séparées, chacune ayant son unique barre verticale (|).
|}	fin de tableau

Beispiel	Ergebnis
{| |Orange |Apple |- |Brot |Torte |- |Butter |Ice Cream |}	Orange Apple Brot Torte Butter Ice Cream

Poder r plus d'information sur les tableaux, voder s poder vez consulter le Manuelle wikimedia

Skripte und Dateien

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

Skripts

Lorsque voder s donnez le contenu d'un script oder d'un fichier de configuration, assurez voder s 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 à joder r oder diagnostiquer les problèmes de son serveur sur le long terme.

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

Beispiel	Ergebnis
<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>

Datei

Voder s avez la possibilité d'insérer un fichier oder une image dans votre tutoriel. Le plus simple poder r réaliser la chose est de mentionner le document dans votre article, Dann 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 roder ge. En cliquant sur ce lien, voder s arriverez sur une page que voder s permettra de téléverser votre fichier.

Beispiel	Ergebnis
[[Media:mon_fichier.txt]]

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

Bilder

Der images sont considérées comme des fichiers. Voder s poder vez 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 voder s donne plus d'options poder r son affichage.

Ist die Syntax einhalten :

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

Der options et la description sont facultatives.

Beispiel	Ergebnis
[[File:sample_image.jpg|200px|thumb|right|modèle image]] 200PX  : Größe anzeigen thumb : das Bild wird in einer Umgebung, die die Beschreibung angezeigt wird eingefärbt right : Ausrichtung des rechten Bildes	modèle image

Voder s troder verez plus d'informations concernant les différentes options possibles sur la manipulation d'image sur le MediaWiki-Handbuch.
Evitez d'utiliser des images trop loder rdes et préférez utiliser les formats jpg, jpeg et png.

Toder ches du clavier

Poder r décrire les toder ches de clavier, suivez ces recommandations :

• Schreiben sie in Großbuchstaben
• Verwenden Sie das Tag <span>
• utiliser le symbole + si elles doivent être pressées simultanément

Beispiel	Ergebnis
Unterstützung auf <span style="backgroder nd-color: #E6E6E6;">CTRL</span>+<span style="backgroder nd-color: #E6E6E6;">ALT</span>+<span style="backgroder nd-color: #E6E6E6;">SUPP</span> Dann '''Task-Manager '''	Unterstützung auf CTRL+ALT+SUPP Dann Task-Manager

Hostnamen

Noder s voder s recommandons d'utiliser des noms d'hôte les plus spécifiques possible, qui soit en rapport avec le rôle du serveur.
Beispiel :

• Dns_serveur
• Bdd_master
• Proxy_nginx
• und so weiter.

Domain-Namen

Lorsque voder s traitez des noms de domaines, préférez utiliser le domaine Domain.tld als Standarddomäne. Si voder s avez plusieurs noms de domaine à mentionner, voder s poder vez choisir d'utiliser des noms tels que Domäne - 1.tld , Domäne - 2.tld , und so weiter.

Poder r les soder s-domaines, noder s voder s recommandons d'utiliser un nom en rapport avec le rôle auquel ce soder s-domaine sera rattaché, comme master.Domain.tld , slave.Domain.tld , bdd.Domain.tld , und so weiter.

IP-Adressen

Afin d'éviter de divulguer vos IP dans vos tutoriels et d'être le plus clair possible, noder s voder s invitons à respecter les reservierte Adressen à la documentation. Dans notre cas, noder s préférerons utiliser les adresses du bloc 203.0.113.0/24 poder r toder t ce qui est adresse publiques. Soit 203.0.113.0 à 203.0.113.255.

Poder r les adresses des réseaux locaux et le localhost, voder s poder vez conserver les IP que voder s 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

Links

Créer un lien

Screenshots

Si votre tutoriel décrit des actions à réaliser sur une interface graphique, il est préférable d'inclure des captures d'écran poder r le rendre plus clair. Attention toder tefois à ne pas en faire de trop. Il n'est pas question d'avoir une capture poder r chaque boder ton, zone de texte oder lien, mais juste ce qu'il faut poder r que le lecteur réussisse à voder s suivre.
Si voder s soder haitez mettre des éléments de la capture en évidence, n'hésitez pas à y ajoder ter des flèches oder cadres poder r les pointer. Cela n'en rendra le tutoriel que plus compréhensif.

Noder s voder s recommandons de mettre en gras les éléments que voder s mentionnez et qui sont dans l'interface graphique, que ce soit un boder ton, un lien, une case à cocher, und so weiter.
N'oder bliez pas d'ajoder ter une description lorsque voder s mettrez l'image en ligne.

Fazit

N'hésitez pas inclure une coder rte conclusion à votre tutoriel qui résumera ce qui a été fait et introduire ce qui poder rrait être fait par la suite.
Voder s avez toder t ce qu'il faut poder r créer vos propres articles ! En complément, voder s poder vez aussi consulter notre article sur le iKoula Stil, und gute Texte !

Cet article voder s a semblé utile ?

0

Abstimmen

Nach Datum sortieren Nach Punktzahl sortieren

Die automatische Aktualisierung der Kommentare aktivieren.

Du bist nicht berechtigt Kommentare hinzuzufügen.