Come formattare articolo

pt:Como formatar o artigo es:Cómo formato artículo en:How to format article fr:Comment formater son article

Il presente articolo è stato tradotto tramite un software di traduzione automatica. È possibile visualizzare l'origine articolo qui.

In questo articolo viene descritto come formattare il tuo tutorial. Seguendo questa guida e uno stile di scrittura, il tuo tutorial applicherà le raccomandazioni di ikoula.

Sintassi wiki

Tutorial ikoula deve essere formattata utilizzando il sintassi wiki. Questo articolo vi darà gli esempi più comuni di questa sintassi. Si possono trovare maggiori dettagli nei sezione di aiuto di MediaWiki per quanto riguarda la formattazione wiki.

Capitoli

Per tagliare il tuo tutorial in capitoli, è possibile utilizzare i livelli di titolo. Non appena si inserisce un titolo nella pagina, tutti gli elementi seguenti sarà considerati come parte del nuovo capitolo, fino al titolo successivo dello stesso livello.
Questo può essere molto utile per migliorare la leggibilità del tuo articolo tagliando fuori le diverse fasi di realizzazione.

I diversi livelli di titolo

Il titolo di livello 1 corrisponde al titolo dell'articolo. Viene creato automaticamente quando si crea la tua pagina. Le tracce sono costruite intorno il tuo titolo di segni "=". Il titolo di livello 2 corrisponde al primo titolo del capitolo o della sezione.
Esempio per il titolo di questa sezione :

==Capitoli ==

Più ' ll segno intorno il tuo titolo, quanto più si va giù l'albero.

Esempio	Risultato
===Titolo di livello 3=== ====Titolo di livello 4==== =====Titolo di livello 5=====	Titolo di livello 3 Titolo di livello 4 Titolo di livello 5

Vale la pena notare che un sommario appare automaticamente a capo dell'articolo, non appena ci sono almeno 4 capitoli o paragrafi.

Stili

È possibile formattare il testo utilizzando la sintassi wiki e alcuni tag HTML.

Grassetto

Ecco come alla fine grassetto nel tuo articolo.

Esempio	Risultato
'''testo in grassetto '''	testo in grassetto

Ecco un elenco di elementi che dovrebbero essere in grassetto.

• Testo visibile di una GUI
• Cambiamento di contesto per un controllo, ad esempio cambiando server o utente
• I nomi host come Server - 1
• Gli utenti piacciono ikoula
• Rapido
• Elenco dei termini, come :
  • MySQL : motore di database
  • Apache : webserver
• Gli elementi che il giocatore non deve perdere, lo rendono senza troppo.

Il corsivo

Corsivo dovrebbe essere utilizzato solo per introdurre termini tecnici. Ad es. : il Server verrà utilizzato come nginx proxy inverso .

Esempio	Risultato
''in corsivo testo ''	in corsivo testo

Note e avvertenze

L'utilizzo di alcuni tag HTML può essere necessario evidenziare alcuni elementi quali note o avvisi.

Esempio	Risultato
<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.

Blockquote

Il blockquote sono isolati dove il testo viene formattato in modo diverso. Per effettuare questa operazione, inserire uno spazio all'inizio della frase o racchiudere il testo dai tag <pre>. Votre texte sera alors formaté dans un cadre avec une police différente.

Esempio	Risultato
Testo importante ''corsivo '' o <pre>Texte important ''corsivo ''</pre>	Testo importante corsivo o Texte important ''corsivo ''

Come si è notato, l'uso del 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'utilizzare il tag GeSHi o la méthode des notes et avertissements pour afficher du code source o 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.

Esempio	Risultato
<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 o 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 o des commandes, si ces derniers ne le sont pas.
Esempio :

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

Esempio	Risultato
* é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 o un fichier

Esempio	Risultato
;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

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

Esempio	Risultato
# élément 1 # élément 2	élément 1 é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. Il 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. Il 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! Il 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

Esempio	Risultato
{| |Orange |Apple |- |Pane |Torta |- |Burro |Ice cream |}	Orange Apple Pane Torta Burro Ice cream

Per ulteriori informazioni sulle tabelle, si prega di consultare il Manuale wikimedia

Script e file

N'oubliez pas de décrire le rôle des fichiers o 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.

Gli script

Lorsque vous donnez le contenu d'un script o 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 o diagnostiquer les problèmes de son serveur sur le long terme.

Se i file che pubblichi sono pezzi lunghi e /o non intéressantes pour votre tutoriel, vous pouvez omettre ces parties avec l’ellipse (...).
Si consiglia l'uso dei Balise GeSHi pour afficher le contenu des scripts o fichiers. Cette dernière vous permettra, en plus de la coloration syntaxique, d'indiquer simplement des numéros de lignes et de surligner la o les plus importantes. Nous vous recommandons d'utiliser le surlignage pour indiquer les lignes où il y a des modifications à effectuer.

Esempio	Risultato
<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

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

Esempio	Risultato
[[Media:mon_fichier.txt]]

Vale la pena notare che il collegamento al file dipende esclusivamente il nome del file. È consigliabile utilizzare un nome descrittivo come file possibili. Non dimenticare di includere una descrizione del file quando messo online.

Immagini

Il 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.
L'unica differenza con un file è che l'immagine verrà visualizzata nel testo. Che cosa ti dà più opzioni per la visualizzazione.

La sintassi da rispettare è :

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

Il options et la description sont facultatives.

Esempio	Risultato
[[File:sample_image.jpg|200px|thumb|right|modèle image]] 200PX  : dimensione per visualizzare thumb : l'immagine è inchiostrata in un'impostazione che consente di visualizzare la descrizione right : allineamento dell'immagine destra	modèle image

Troverete ulteriori informazioni sulle diverse opzioni disponibili sulla manipolazione di immagine sulla Manuale di MediaWiki.
Evitare di utilizzare immagini troppo pesanti e preferisce utilizzare formati jpg, jpeg e png.

Tastiera tasti

Per descrivere i tasti della tastiera, seguire queste raccomandazioni :

• scrivere in lettere maiuscole
• utilizzare il tag <span>
• utiliser le symbole + si elles doivent être pressées simultanément

Esempio	Risultato
Supporto su <span style="background-color: #E6E6E6;">CTRL</span>+<span style="background-color: #E6E6E6;">ALT</span>+<span style="background-color: #E6E6E6;">SUPP</span> Quindi '''Task Manager '''	Supporto su CTRL+ALT+SUPP Quindi Task Manager

Nomi host

Si consiglia di utilizzare i nomi host il più specifico possibile, che è in relazione al ruolo del server.
Esempio :

• dns_serveur
• bdd_master
• proxy_nginx
• ecc.

I nomi di dominio

Quando avete a che fare con i nomi di dominio, preferiscono utilizzare il campo Domain. TLD come dominio predefinito. Se si dispone di più nomi di dominio di menzionare, è possibile utilizzare nomi quali dominio - 1.TLD , dominio - 2.TLD , ecc.

Per i sottodomini, si consiglia di utilizzare un nome in relazione al ruolo a cui sarà collegato questo sottodominio, come master.Domain. TLD , slave.Domain. TLD , bdd.Domain. TLD , ecc.

Indirizzi IP

Per evitare di rivelare il tuo IP nel tuo tutorial ed essere il più chiaro possibile, vi invitiamo a incontrare il indirizzi riservati la documentazione. Nel nostro caso, noi preferiamo utilizzare gli indirizzi di blocco 203.0.113.0/24 per tutto ciò che è l'indirizzo pubblico. Entrambi 203.0.113.0 à 203.0.113.255.

Per gli indirizzi di reti locali e localhost, è possibile mantenere l'IP che si utilizza in genere. Vuol 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

Link

Créer un lien

Screenshots

Se il tuo tutorial descrive le azioni da realizzare su un'interfaccia grafica, è preferibile includere schermate per renderlo più chiaro. Attention toutefois à ne pas en faire de trop. Il n'est pas question d'avoir une capture pour chaque bouton, zone de texte o 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 o 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, ecc.
Non dimenticare di aggiungere una descrizione quando si accende l'immagine online.

Conclusione

Si prega di includere una breve conclusione per il tuo tutorial che riassumere quanto è stato fatto e introdurre che cosa potrebbe essere fatto successivamente.
Avete tutto il necessario per creare i tuoi articoli ! Inoltre, potete anche consultare il nostro articolo sulla stile iKoulae buona scrittura !

Questo articolo sembrava poter essere utile ?

0

Vota

Ordina per data Ordina per punteggio

Attivare l'aggiornamento automatico dei commenti

Non si dispone dei permessi necessari per inviare commenti.