Hoe te formatteren van artikel

Uit Nl Ikoula wiki
Versie door Ikbot (overleg | bijdragen) op 2 okt 2015 om 10:25 (Nieuwe pagina aangemaakt met '<br /> Dit artikel is vertaald door middel van automatische vertalingssoftware. U kunt het artikel bron hier te bekijken.<br /...')
(wijz) ← Oudere versie | Huidige versie (wijz) | Nieuwere versie → (wijz)
Jump to navigation Jump to search


Dit artikel is vertaald door middel van automatische vertalingssoftware. U kunt het artikel bron hier te bekijken.




In dit artikel wordt beschreven hoe voor het opmaken van je tutorial. Door het volgen van deze gids en een op de schrijfstijl, uw tutorial zal de aanbevelingen van toepassing ikoula.


Wiki syntax

Tutorials ikoula moeten worden geformatteerd met de wiki syntax. In dit artikel krijgt u de meest voorkomende voorbeelden van deze syntaxis. U vindt meer details in de MediaWiki Helpsectie Wat betreft de wiki opmaak.


Hoofdstukken

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.

De verschillende niveaus van titel

De titel van niveau 1 komt overeen met de titel van het artikel. Het wordt automatisch gemaakt wanneer u uw pagina maakt. De tracks zijn gebouwd rond uw titel door tekenen "=". De titel van niveau 2 komt overeen met de eerste titel van hoofdstuk of elke sectie.
Voorbeeld voor de titel van deze sectie :

==Hoofdstukken ==

Plus vous mettrez de signe autour de votre titre, plus vous descendrez dans l'arborescence.

In het volgende voorbeeld Resultaat 
===Niveau titel 3===
====Niveau titel 4====
=====Niveau titel 5=====

Niveau titel 3

Niveau titel 4

Niveau titel 5


Het is vermeldenswaard dat een inhoudsopgave automatisch aan het hoofd van artikel verschijnt zodra er ten minste zijn 4 hoofdstukken of punten.

Stijlen

U kunt uw tekst met behulp van de syntaxis van de wiki en een paar HTML-codes opmaken.

Vet

Hier is hoe om een einde te vet in uw artikel.

In het volgende voorbeeld Resultaat 
'''texte en gras'''

texte en gras


Hier is een lijst met items die vetgedrukt worden moeten.

  • Zichtbare tekst voor een GUI
  • Verandering van context voor een besturingselement, zoals het wijzigen van de gebruiker of de server
  • Hostnamen als Server - 1
  • Gebruikers willen ikoula
  • Snelle
  • Lijst van termen, als :
    • MySQL: database-engine
    • Apache: webserver
  • Elementen die de speler niet mag missen, maken het zonder al te veel.


Cursief

Cursief mag alleen worden gebruikt om technische termen. Bijvoorbeeld : de Server wordt gebruikt als nginx reverse proxy.

In het volgende voorbeeld Resultaat 
''texte en italique''

texte en italique


Opmerkingen en waarschuwingen

Het gebruik van sommige HTML-codes kan nodig zijn om te wijzen op bepaalde elementen, zoals notities of waarschuwingen.

In het volgende voorbeeld Resultaat 
<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

De blockquotes zijn blokken waar uw tekst anders is opgemaakt. Om dit te doen, gewoon plaats een spatie aan het begin van de zin, of uw tekst van tags omsluiten <pre>. Votre texte sera alors formaté dans un cadre avec une police différente.

In het volgende voorbeeld Resultaat

Belangrijke tekst ''italique''
of
<pre>Texte important ''italique''</pre> 

Belangrijke tekst italique

of 

Texte important ''italique''

Zoals u heeft gemerkt, het gebruik van de tag <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'gebruik van de tag GeSHi of la méthode des notes et avertissements pour afficher du code source of 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.

In het volgende voorbeeld Resultaat

<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 of 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 of des commandes, si ces derniers ne le sont pas.
In het volgende voorbeeld :

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
In het volgende voorbeeld Resultaat 
* é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 of un fichier
In het volgende voorbeeld Resultaat 
;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

De 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.

In het volgende voorbeeld Resultaat 
# é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. De 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. De 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! De 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


In het volgende voorbeeld Resultaat 
{|
|Orange 
|Apple 
|-
|Brood 
|Taart 
|-
|Boter 
|Ice cream 
|}
Orange Apple
Brood Taart
Boter Ice cream

Raadpleeg voor meer informatie over tabellen, de Handmatige wikimedia

Scripts en bestanden

N'oubliez pas de décrire le rôle des fichiers of 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 of 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 of diagnostiquer les problèmes de son serveur sur le long terme.

Als de bestanden die u post lange delen hebben en /of non intéressantes pour votre tutoriel, vous pouvez omettre ces parties avec l’ellipse (...).
We raden het gebruik van de Balise GeSHi pour afficher le contenu des scripts of fichiers. Cette dernière vous permettra, en plus de la coloration syntaxique, d'indiquer simplement des numéros de lignes et de surligner la of les plus importantes. Nous vous recommandons d'utiliser le surlignage pour indiquer les lignes où il y a des modifications à effectuer.

In het volgende voorbeeld Resultaat 
<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>


Bestand

Vous avez la possibilité d'insérer un fichier of une image dans votre tutoriel. Le plus simple pour réaliser la chose est de mentionner le document dans votre article, Vervolgens 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.

In het volgende voorbeeld Resultaat 
[[Media:mon_fichier.txt]]

Media:mon_fichier.txt

Het is vermeldenswaard dat de koppeling naar het bestand afhankelijk uitsluitend op de naam van het bestand is. Het is aanbevolen dat u namen als beschrijvende als mogelijk bestanden gebruiken. Vergeet niet te vermelden een beschrijving van het bestand wanneer u online gezet.

Afbeeldingen

De 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.
Het enige verschil met een bestand is dat de afbeelding zal worden weergegeven in de tekst. Wat geeft u meer opties wilt weergeven.

De syntaxis aan is : 

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

De options et la description sont facultatives.

In het volgende voorbeeld Resultaat 
[[File:sample_image.jpg|200px|thumb|right|modèle image]]
  • 200PX  : grootte weer te geven
  • thumb : l'image est encrée dans un cadre qui affichera la description
  • right : uitlijning van de afbeelding rechts
modèle image


U vindt meer informatie over de verschillende opties beschikbaar op de beeldmanipulatie op de MediaWiki handleiding.
Vermijd het gebruik van zwaar beelden en liever gebruik jpg, jpeg en png formaten.

Toetsenbord toetsen

Om te beschrijven de toetsen, volg deze aanbevelingen :

  • Schrijf deze op hoofdletters
  • gebruik van de tag <span>
  • utiliser le symbole + si elles doivent être pressées simultanément
In het volgende voorbeeld Resultaat 
Ondersteuning op <span style="background-color: #E6E6E6;">CTRL</span>+<span style="background-color: #E6E6E6;">ALT</span>+<span style="background-color: #E6E6E6;">SUPP</span> Vervolgens '''Gestionnaire des tâches'''

Ondersteuning op CTRL+ALT+SUPP Vervolgens Gestionnaire des tâches


Hostnamen

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.
In het volgende voorbeeld :

  • dns_serveur
  • bdd_master
  • proxy_nginx
  • enz.


Domeinnamen

Wanneer u te met namen van het domein maken, de voorkeur aan het veld domaine.tld Als het standaarddomein. Hebt u meerdere domeinnamen te vermelden, kunt u namen gebruiken zoals domein - 1.tld, domein - 2.tld, enz.

Voor subdomeinen, is het raadzaam dat u een naam in verband met de rol waarop dit subdomein zal worden aangesloten, gebruiken als master.domaine.tld, slave.domaine.tld, bdd.domaine.tld, enz.

IP-adressen

Om te vermijden om te onthullen uw IP in uw tutorials en zo duidelijk mogelijk worden, wij nodigen u uit om te voldoen aan de gereserveerde adressen de documentatie. In ons geval, we liever met de blok adressen 203.0.113.0/24 voor alles wat openbaar adres. Beide 203.0.113.0 à 203.0.113.255.

Om de adressen van lokale netwerken en localhost kun je de IP die u doorgaans gebruikt. Het betekent :

  • 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



Verwijzigingen

Créer un lien

Screenshots

Als uw zelfstudie worden beschreven acties te realiseren op een grafische interface, is het beter om te nemen screenshots zodat het duidelijker. Attention toutefois à ne pas en faire de trop. Il n'est pas question d'avoir une capture pour chaque bouton, zone de texte of 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 of 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, enz.
Vergeet niet om een beschrijving toevoegen wanneer u de afbeelding online.

Conclusie

Gelieve te omvatten een korte sluiting naar uw tutorial die zal samenvatten wat er is gedaan en invoering van wat kan worden gedaan later.
Hebt u alles wat u nodig hebt om te maken van uw eigen artikelen ! Daarnaast kunt u ook ons artikel raadplegen op de stijl iKoula, en goed schrijven !


Dit artikel leek u nuttig ?

0



U mag niet reageren.

Overgenomen van "https://nl-wiki.ikoula.com/index.php?title=Hoe_te_formatteren_van_artikel&oldid=405"