Artikel formatieren: Unterschied zwischen den Versionen
Ikbot (Diskussion | Beiträge) |
Ikbot (Diskussion | Beiträge) |
||
Zeile 1: | Zeile 1: | ||
+ | <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]] | <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_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]] |
Version vom 5. Oktober 2015, 16:42 Uhr
es:Cómo formato artículo
en:How to format article
fr:Comment formater son article
Dieser Artikel wurde maschinell übersetzt. Sie können den Artikel Quelle hier ansehen.
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 Lesbarkeit 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 3Stufe Titel 4Stufe 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 Ikoula
- 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="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
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 '' |
Texte important italique ou Texte important ''italique'' |
Wie Sie bemerkt haben, die Verwendung des Tags <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 Beginn der ligne, sachez qu'un retour à la ligne fermera le cadre.
Nous préconisons d'Verwenden Sie das Tag 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.
Beispiel | Ergebnis |
---|---|
<syntaxhighlight lang="php"> |
<?
$hello = "Hello World";
echo $hello; // comment
?>
|
Finden Sie auf der Website der Erweiterung GeSHi die Liste der unterstützten Sprachen und einige zusätzlichen Optionen, solche Hinzufügen von Zeilennummern oder Hervorhebung einer Zeile im Code.
Bezeichnet eine Anwendung
Wenn Sie eine Anwendung vergessen haben, die Groß-/Kleinschreibung der offiziellen Website verwenden möchten. Wenn die Website nicht konsistent ist, wählen Sie ein Formular und versuchen Sie, in Ihrem Artikel zu sein.
Auf der anderen Seite großschreiben Sie nicht nicht die Namen der Pakete oder Bestellungen, wenn sie nicht sind.
Beispiel :
Ein MySQL Datenbank Vs. der Mysql-Befehl oder das Paket Mysql-Server.
Listet
Jede Art der Nutzung der Liste.
Ungeordnete Listen
Diese Listen eignen sich für :
- die Voraussetzungen
- Die Checklisten
Beispiel | Ergebnis |
---|---|
* -Element 1 * -Element 2 |
|
Definitionslisten
Diese Listen eignen sich für :
- Begriffe und Erklärungen
- Erklärungen für die Variablen in einer Befehlszeile oder Datei
Beispiel | Ergebnis |
---|---|
;Word 1 : Definition 1 ;Word 2 : Definition 2-1 : Definition 2-2 |
|
Geordneter Listen
Sortierte Listen sollen sparsam verwendet werden. Es ist praktisch, um die Bestellung eines Prozesses, z. B. die Verarbeitung einer DNS-Abfrage auflisten.
Beispiel | Ergebnis |
---|---|
# -Element 1 # -Element 2 |
|
Diese Listen eignen sich für :
- einen Prozess beschreiben
In einigen Fällen wird die Verwendung einer Tabelle Listen vorzuziehen.
Tabellen
Hier ist ein einfaches Beispiel für eine Tabelle. Dies kann zu leichter vorhanden Beispielcode und deren Ergebnis hilfreich sein. Die Tabellen sind wie folgt strukturiert.
{| | début de tableau |
|+ | Übersicht Inhalt, Optionale ; un seul par Tabelle positionné entre le début du tableau et la première ligne |
|- | Zeilenanfang , In der ersten Zeile optional -- die Wiki-Engine unterstützt Front-Line |
! | Zelle Header , optional. Können die Header platziert werden, entweder auf der gleichen Linie durch doppelten Ausrufe Punkte getrennt (!!), entweder bei getrennten Linien, jede mit seiner einzigartigen Ausrufezeichen (!). |
| | Zelle der Daten , erforderliche ! Aufeinander folgende Tabellenzellen entweder platziert werden können, in der gleichen Zeile getrennt durch ein doppelter senkrechter Strich (||), entweder bei getrennten Linien, jede mit seiner einzigartigen vertikalen Balken (|). |
|} | Ende des Array |
Beispiel | Ergebnis | ||||||
---|---|---|---|---|---|---|---|
{| |Orange |Apple |- |Bread |Pie |- |Butter |Ice cream |} |
|
Weitere Informationen zu Tabellen finden Sie in der Manuelle wikimedia
Skripte und Dateien
Achten Sie darauf, um die Rolle der Dateien oder Skripte, die Sie erwähnen zu beschreiben. Auf diese Weise wird der Leser haben das gleiche Maß an Informationen, die Sie und werden mehr in der Lage, Ihr Konzept zu verstehen.
Skripts
Wenn Sie den Inhalt aus einem Skript oder einer Konfigurationsdatei geben, achten Sie, die es, die vorzugsweise auf der Ebene der betroffenen Strecken eingegangen ist. Ziel ist es, dass der Leser verstehen alle Aktionen beschrieben, so ist es wichtig, mehr erzieherische wie möglich sein. Auf diese Weise werden mehr in der Lage, anpassen, aktualisieren oder langfristig Probleme mit seinem Server zu diagnostizieren.
Wenn die Dateien, die Sie veröffentlichen lange Teile und /oder nicht interessant für Ihr Tutorial, können Sie diese Parteien mit der Ellipse weglassen (...).
Wir empfehlen die Verwendung von der Balise GeSHi der Inhalt des Skripts oder Dateien angezeigt. Letzteres erlaubt Ihnen, neben der Syntax-highlighting einfach Zahlen der Leitungen anzugeben und Hervorheben wichtiger. Es wird empfohlen, dass Sie die Hervorhebung verwenden, um die Linien zeigen an, wo gibt es Änderungen durchführen.
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
Sie haben die Möglichkeit, eine Datei oder ein Bild in Ihrem Tutorial einfügen. Die einfachste Möglichkeit, die Sache zu erreichen ist zu erwähnen, dass das Dokument in Ihrem Artikel, dann online gestellt, einmal schriftlich abgeschlossen. Wenn die Datei nicht bereits vorhanden ist, wird es mit roten Link gezeigt werden. Durch diesen Link anklicken, kommen Sie zu einer Seite, die Ihnen erlauben, Ihre Datei hochladen.
Exemple | Résultat |
---|---|
[[Media:mon_fichier.txt]] |
Es ist erwähnenswert, dass der Link zu der Datei ausschließlich auf den Namen der Datei abhängt. Es wird empfohlen, dass Sie Namen als beschreibend als möglichen Dateien verwenden. Vergiss nicht, eine Beschreibung der Datei enthalten, wenn Sie es online zu stellen.
Bilder
Bilder werden als Dateien behandelt. Sie können daher können Sie diese und setzen sie online auf die gleiche Weise als Dateien.
Der einzige Unterschied zu einer Datei ist, dass das Bild im Text angezeigt wird. Was bietet Ihnen weitere Optionen angezeigt.
Ist die Syntax einhalten :
[[File:sample_image.jpg|options|description]]
Optionen und Beschreibung sind optional.
Exemple | Résultat |
---|---|
[[File:sample_image.jpg|200px|thumb|right|modèle image]]
|
Finden Sie weitere Informationen über die verschiedenen Möglichkeiten für die Bildbearbeitung auf dem MediaWiki-Handbuch.
Vermeiden Sie die Verwendung der Bilder zu schwer und es ziehen Sie vor, Jpg, Jpeg und Png Formate verwenden.
Tastatur Tasten
Um die Tasten der Tastatur zu beschreiben, folgen Sie diesen Empfehlungen :
- Schreiben sie in Großbuchstaben
- utiliser la balise <span>
- utiliser le symbole + si elles doivent être pressées simultanément
Exemple | Résultat |
---|---|
Unterstützung auf <span style="background-color: #E6E6E6;">CTRL</span>+<span style="background-color: #E6E6E6;">ALT</span>+<span style="background-color: #E6E6E6;">SUPP</span> Dann '''Task-Manager ''' |
Appuyer sur CTRL+ALT+SUPP Dann Task-Manager |
Hostnamen
Es wird empfohlen, dass Sie Hostnamen die spezifischste möglich verwenden, die in Bezug auf die Rolle des Servers ist.
Beispiel :
- Dns_serveur
- Bdd_master
- Proxy_nginx
- und so weiter.
Domain-Namen
Wenn Sie es mit Domain-Namen, bevorzugen, verwenden Sie das Feld Domain.tld als Standarddomäne.
Haben Sie mehrere Domain-Namen zu erwähnen, Sie können wählen, Namen zu verwenden, wie z. B. Domäne - 1.tld, Domäne - 2.tldEtc. |
Für Sub-Domains, empfehlen wir, dass Sie einen Namen im Zusammenhang mit der Rolle verwenden, diese Sub-Domain angefügt wird, als master.Domaine.tld , slave.Domaine.tld , BDD.Domaine.tld Etc. |
IP-Adressen
Um zu vermeiden, um Ihre IP in Ihre Tutorials weiterzugeben und so klar wie möglich, wir laden Sie zum Treffen der reservierte Adressen in der Dokumentation. In unserem Fall, wir bevorzugen die Blockadressen 203.0.113.0/24 für alles, was öffentliche Adresse ist. Entweder 203.0.113.0 à 203.0.113.255.
Für die Adressen von lokalen Netzen und "localhost" können Sie die IP-Adresse behalten, die Sie normalerweise verwenden. Es bedeutet :
- 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
Screenshots
Wenn Ihr Tutorial beschreibt die Aktionen auf eine grafische Oberfläche zu realisieren, ist es besser, Screenshots zu machen, klarer aufzunehmen.
Sei aber nicht vorsichtig zu sein. Es ist keine Frage des Habens ein Screenshot für jede Schaltfläche, Text oder Link-Box, sondern nur das, was man braucht, für erfolgreiche Laufwerk, dir zu folgen.
Wenn Sie sammeln möchten Elemente zu markieren, wenden Sie sich bitte den Punkt Pfeile oder Rahmen hinzu. Dies wird nur das einzige umfassende Tutorial sein.
Es wird empfohlen, Sie stellen die Elemente, die Sie erwähnen in Fett und die sind in die grafische Oberfläche, es ist eine Schaltfläche, einen Link, eine Checkbox, etc. |
Vergiss nicht, eine Beschreibung hinzufügen, wenn das Bild online zu stellen.
Fazit
Bitte geben Sie eine kurze Zusammenfassung zu Ihr Tutorial das zusammenfassen, was getan wurde und einzuführen, was dann getan werden kann.
Sie haben alles was Sie brauchen, um Ihre eigenen Artikel erstellen ! Darüber hinaus können Sie auch einsehen, unsere Artikel auf der iKoula Stil, und gute Texte !
Dieser Artikel erschien Sie nützlich ?
Die automatische Aktualisierung der Kommentare aktivieren.