Come formattare articolo
fr:Comment formater son article
Il presente articolo è stato tradotto tramite un software di traduzione automatica. È possibile visualizzare l'origine articolo qui.
fr::de:Artikel formatierenfr:de:Artikel formatieren
In questo articolo viene descritto come formattare il tuo tutorial. Seguendo questa guid stile di scrittura, il tuo tutorial applicherà le raccomandazioni ikoula.
Sintassi wi
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 live 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 live 2 corrisponde al primo titolo del capitolo o della s
Esempio per il titolo di questa sezio :
==Chapitres==
Più ' ll segno intorno il tuo titolo, quanto più si va giù l'albero.
| Esempi | Risultat |
|---|---|
===Titre de niveau 3=== ====Titre de niveau 4==== =====Titre de niveau 5===== |
Titre de niveau 3Titre de niveau 4Titre de niveau 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.
Gra
Ecco come alla fine grassetto nel tuo articolo.
| Esempi | Risultat |
|---|---|
'''testo in gra''' |
texte en gras |
Ecco un elenco di elementi che dovrebbero essere in grassetto.
- Testo visibile di una
- Cambiamento di contesto per un controllo, ad esempio cambiando server o utente
- I nomi host come Server 1
- Gli utenti piacci ikoula
- Rapido
- Elenco dei termini, c :
- MySQL: Paore di database
- Apache: webserver
- Gli elementi che il giocatore non deve perdere, lo rendono senza troppo.
Il cors
Corsivo dovrebbe essere utilizzato solo per introdurre termini tecnici. Ad es. : il Server verrà utilizzato come ng proxy invers.
| Esempi | Risultat |
|---|---|
''in corsivo testo'' |
texte en corsivo |
Not e avvertenze
L'utilizzo di alcuni tag HTML può essere necessario evidenziare alcuni elementi quali note o avvisi.
| Esempi | Risultat |
|---|---|
<div style="background-color: #FFCC99;"> '''Note''': Si tratta di una </div>
<div style="background-color: #FF9999;"> '''Avviso''': Questo è un avvertimento</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 te <pre>. Quindi, il testo verrà formattato in un ambiente con un carattere diverso.
| Esempi | Risultat |
|---|---|
|
Texte important ''italique'' |
Texte important italique ou Texte important ''italique'' |
Come si è notato, l'uso del tag <pre> fatto che qualsiasi formattazione all'interno del blocco verranno ignorati e considerati il testo da visualizzare. Se si utilizza il primo metodo, con lo spazio all'inizio della linea, essere consapevoli che un ritorno alla linea ch
Si consiglia di utilizzare il tag GeSHi o il metodo di Notes e avvisi per visualizzare il codice sorgente o informazioni importanti.
Codice sor
Quando si pubblica il codice sorgente, è necessario applicare il <syntaxhighlight>. Questo permetterà il vostro codice di beneficiare di un'evidenziazione della sintassi, che lo rende più leggibile. Al fine di adeguare la colorazione alla lingua lang="lingua" nel tag.
| Esempi | Risultat |
|---|---|
|
<syntaxhighlight lang="php"> |
<?
$hello = "Hello World";
echo $hello; // comment
?>
|
Troverete sul sito dell'estensione GeSHi l'elenco delle lingue supportate e alcune opzioni aggiuntive, tale aggiunta di numeri di riga o evidenziando una riga nel codice.
Si riferisce a un'applicazion
Quando si parla di un'applicazione, preferisco usare le lettere maiuscole del sito ufficiale. Se il sito web non è coerente, selezionare un modulo e cercare di essere nel tuo articolo.
D'altra parte, non capitalizzare non i nomi dei pacchetti o ordini, se non sono.
Esempi :
Un MySQL database vs. il comando di mysql o il pacchetto mysql-server.
Elenc
Ogni tipo di utilizzo della lista.
Unordered list
Questi elenchi sono utili :
- i prerichiit
- le checklists
| Esempi | Risultat |
|---|---|
* élément 1 * élément 2 |
|
Liste di definizioni
Questi elenchi sono utili :
- termini e spiegazioni
- spiegazioni per le variabili in una riga di comando o file
| Esempi | Risultat |
|---|---|
;mot 1 : définition 1 ;mot 2 : définition 2-1 : définition 2-2 |
|
Elenchi ordinati
Elenchi ordinati devono essere usati con parsimonia. Può essere pratico elencare l'ordine di un processo, ad esempio l'elaborazione di una query DNS.
| Esempi | Risultat |
|---|---|
# élément 1 # élément 2 |
|
Questi elenchi sono utili :
- descrivere un processo
In alcuni casi, l'uso di una tabella sarà preferibile agli elenchi.
Tavoli
Ecco un semplice esempio di una tabella. Questo può essere utile a più facilmente presenti codice di esempio e il suo risultato. Le tabelle sono strutturate come segue.
| {| | all'iniz tabell |
| |+ | Panoramic contenuto, Opzional; uno per ogni tabella posizionata tra l'inizio della matrice e la prima linea |
| |- | inizio riga , Opzionale sulla prima riga -- il motore wiki supporta la prima riga |
| ! | cella intest, opzionale Le intestazioni possono essere posizionate sia sulla stessa riga, separata da punti doppia esclamazioni (!!), sia separato in righe, ciascuna con il suo unico punto esclamativo (!). |
| | | cella di dati , requis! Le celle di dati tabella consecutivi possono essere collocate nella stessa riga, separati da una doppia barra verticale (||), sia separato in linee, ognuna con la barra verticale unica (|). |
| |} | fine dell'arr |
| Esempi | Risultat | ||||||
|---|---|---|---|---|---|---|---|
{|
|Orange
|Apple
|-
|Bread
|Pie
|-
|Butter
|Ice cream
|}
|
|
Per ulteriori informazioni sulle tabelle, si prega di consultare Manuale wikimedia
Script e file
Assicurati di descrivere il ruolo di file o script che hai citato. In questo modo il lettore avrà lo stesso livello di informazioni che tu e sarà più in grado di capire il tuo approccio.
Gli sc
Quando si dà il contenuto di uno script o un file di configurazione, assicurarsi che si che è commentato, preferibilmente a livello delle linee interessate. L'obiettivo è che il lettore di capire tutte le azioni descritte, quindi è importante essere più educativo come possibile. In questo modo, sarà più in grado di personalizzare, aggiornare o diagnosticare problemi con i server a lungo termine.
Se i file che pubblichi sono pezzi lunghi e /o non interessante per il tuo tutorial, è possibile omettere queste parti con l'ellisse (...).
Si consiglia l'uso dei Balise GeSHi per visualizzare il contenuto degli script o file. Quest'ultimo vi permetterà, oltre alla evidenziazione della sintassi, semplicemente indicare i numeri delle linee ed evidenziare i più importanti. È consigliabile utilizzare l'evidenziazione per indicare le righe dove ci sono modifiche da eseguire.
| Esempi | Risultat |
|---|---|
<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
Avete la possibilità di inserire un file o un'immagine nel vostro tutorial. Il modo più semplice per realizzare la cosa è parlare il documento nel tuo articolo, quindi messo online una volta completata la scrittura. Se il file non esiste già, esso verrà essere indicato da un link rosso. Cliccando su questo link, potrete accedere a una pagina che vi permetterà di caricare il tuo file.
| Esempi | Risultat |
|---|---|
[[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.
Immag
Le immagini sono trattate come file. Potete quindi includerli e metterli online nello stesso modo come file.
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]]
Descrizione e opzioni sono facoltative.
| Esempi | Risultat |
|---|---|
[[File:sample_image.jpg|200px|thumb|right|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 raccomand :
- scrivere in lettere mai
- utilizzare il tag <span>
- utilizzare il simb + Se devono essere premuti simultaneamente
| Esempi | Risultat |
|---|---|
Supporto s <span style="background-color: #E6E6E6;">CTRL</span>+<span style="background-color: #E6E6E6;">ALT</span>+<span style="background-color: #E6E6E6;">SUPP</span> Qui '''Task Manager ''' |
Appuyer sur CTRL+ALT+SUPP Qui Task Manager |
Nomi host
Si consiglia di utilizzare i nomi host il più specifico possibile, che è in relazione al ruolo del server.
Esempi :
- dns_serveur
- bdd_master
- proxy_nginx
- ecc.
I nomi di domi
Quando avete a che fare con i nomi di dominio, preferiscono utilizzare i Domain. TL come dominio predefinito.
Se si dispone di più nomi di dominio di menzionare, è possibile utilizzare nomi quali dominio1.TL, dominio2.TLecc. |
Per i sottodomini, si consiglia di utilizzare un nome in relazione al ruolo a cui sarà collegato questo sottodominio, come master.Domaine.tl, slave.Domaine.tl, BDD.Domaine.tlecc. |
Indirizzi
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 blocc 203.0.113.0/24 per tutto ciò che è l'indirizzo pubblico. 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
Screenshots
Se il tuo tutorial descrive le azioni da realizzare su un'interfaccia grafica, è preferibile includere schermate per renderlo più chiaro.
Fate attenzione però a non essere troppo. Non si tratta di avere uno screenshot per ogni casella di testo, pulsante o un collegamento, ma solo quello che serve per successo unità di seguirti.
Se si desidera acquisire evidenziare gli elementi, sentitevi liberi di aggiungere cornici o frecce al punto. Questo sarà solo il solo completo tutorial.
Si consiglia di inserire gli elementi si parla di grassi e che sono nell'interfaccia grafica, che è un pulsante, un link, una casella di controllo, ecc. |
Non dimenticare di aggiungere una descrizione quando si accende l'immagine online.
Conclusio
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 ?
Attivare l'aggiornamento automatico dei commenti