Cum sa format articolul
ro:Cum sa format articolul
he:כיצד לעצב מאמר
ja:記事の書式を設定する方法
ar:كيفية تنسيق المادة
zh:如何设置格式文章
de:Artikel formatieren
nl:Hoe te formatteren van artikel
it:Come formattare articolo
pt:Como formatar o artigo
es:Cómo formato artículo
en:How to format article
ru:Как формат статьи
pl:Jak sformatować art
fr:Comment formater son article
Acest articol este rezultatul unei traduceri automate efectuate de către software-ul. Puteți vizualiza sursa articol aici.
Acest articol descrie cum sa format al tău tutorial. Urmând acest ghid si una stil de scriere, al tău tutorial se vor aplica recomandările ikoula.
Sintaxa wiki
Tutoriale ikoula trebuie să fie formatată utilizând sintaxa wiki. Acest articol vă va oferi cele mai frecvente exemple de această sintaxă. Puteţi găsi mai multe detalii în secţiunea de ajutor MediaWiki pentru formatarea wiki.
Capitolele
Pentru a decupa Tutoriale în capitole, utilizaţi nivelurile de titlu. De îndată ce aţi pus un titlu în filme, toate din următoarele elemente va fi considerată ca parte din nou capitol, până la urmatorul titlu de același nivel.
Acest lucru poate fi foarte util pentru a îmbunătăţi lizibilitatea de articolul dumneavoastră prin tăierea în diferite etape de realizare.
Diferite niveluri de titlu
Titlul de nivel 1 corespunde titlul articolului. Acesta este creat automat când creaţi pagina dvs. Placinta sele sunt construite în jurul titlul de semne "=". Titlul de nivel 2 corespunde la primul titlu de capitol sau secţiune.
Exemplu pentru titlul de această secţiune :
==Chapitres==
Mai voi semna în jurul titlul dvs., mai mult te duci în jos copac.
Exemplu | Rezultatul |
---|---|
===Titre de niveau 3=== ====Titre de niveau 4==== =====Titre de niveau 5===== |
Titre de niveau 3Titre de niveau 4Titre de niveau 5 |
Este demn de remarcat faptul că un cuprins automat apare la capul de articol, de îndată ce există cel puţin 4 capitolele sau subcapitole.
Stiluri
Aveţi posibilitatea să formataţi textul utilizând sintaxa wiki şi câteva etichete HTML.
Îndrăzneţ
Iată cum să pună capăt îndrăzneţ în articolul dumneavoastră.
Exemplu | Rezultatul |
---|---|
'''textul aldin ''' |
texte en gras |
Aici este o listă de elemente care ar trebui să fie aldine.
- Textul vizibil un GUI
- Schimbările de context, de control, cum ar fi schimbarea utilizator sau server
- Nume de host ca Server - 1
- Utilizatorii dori ikoula
- Rapid
- Listă de termeni, ca :
- MySQL: baza de date motor
- Apache: webserver
- Elemente care jucatorul nu trebuie sa lipseasca, fac fără prea mult.
Cursiv
Caractere italice trebuie utilizate numai pentru a introduce termeni tehnici. Ex. : nginx Server va fi folosit ca revers proxy .
Exemplu | Rezultatul |
---|---|
''textul cursiv '' |
texte en cursiv |
Notă şi avertismente
Utilizarea de unele etichete HTML poate fi necesar pentru a evidenţia anumite elemente cum ar fi notele sau avertismente.
Exemplu | Rezultatul |
---|---|
<div style="background-color: #FFCC99;"> '''Note''': Aceasta este o notă. </div>
<div style="background-color: #FF9999;"> '''Avertizare ''': Acesta este un avertisment. </div>
|
Note: Ceci est une note.
Warning: Ceci est un avertissement.
|
Blockquotes
blockquotes sunt blocuri în cazul în care textul este formatat în mod diferit. Pentru aceasta, sau pur şi simplu loc un spaţiu la începutul propoziției, încadraţi textul din Tag-uri <pre>. Votre texte sera alors formaté dans un cadre avec une police différente.
Exemplu | Rezultatul |
---|---|
Important text ''italique'' |
Texte important italique ou Texte important ''italique'' |
Aşa cum aţi menţionat, utilizarea de tag-ul <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'utilizaţi tag-ul 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.
Exemplu | Rezultatul |
---|---|
<syntaxhighlight lang="php"> |
<?
$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 ou 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 ou des commandes, si ces derniers ne le sont pas.
Exemplu :
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
Exemplu | Rezultatul |
---|---|
* é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 ou un fichier
Exemple | Résultat |
---|---|
;mot 1 : définition 1 ;mot 2 : définition 2-1 : définition 2-2 |
|
Listes ordonnées
Les 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.
Exemple | Résultat |
---|---|
# é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. Les 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. Les 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! Les 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 |
Exemple | Résultat | ||||||
---|---|---|---|---|---|---|---|
{| |Orange |Apple |- |Pâine |Pie |- |Unt |Inghetata |} |
|
Pentru mai multe informaţii despre tabele, vă rugăm să consultaţi Manualul wikimedia
Script-uri şi fişiere
Asiguraţi-vă că pentru a descrie rolul de dosar sau script-uri care vă referiţi. În acest fel cititorul va avea acelaşi nivel de informaţii care le va fi mai capabil de a înţelege abordarea ta.
Scripturi
Când dai conţinutul de un script sau un fişier de configurare, asiguraţi-vă că acesta este comentat, preferabil la nivel de liniile respective. Scopul este că cititorul înţelege toate acțiunile descrise, deci este important pentru a fi mai de învăţământ în care este posibil. În acest fel, ea va fi mai capabil de a personaliza, actualizare sau diagnosticarea problemelor cu serverul său pe termen lung.
Dacă fişierele pe care le posta au piese lungi şi /sau nu interesant pentru al tău tutorial, se poate omite aceste partide cu elipsa (...).
Vă recomandăm utilizarea Balise GeSHi pentru a afişa conţinutul de script-uri sau fişiere. Acesta vă va permite, în plus faţă de sintaxa subliniind, pur şi simplu indică un număr de linii şi evidenţia cele mai importante. Este recomandat să utilizaţi subliniind să indice liniile în cazul în care există modificări pentru a efectua.
Exemple | Résultat |
---|---|
<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>
|
Fişier
Aveţi posibilitatea de a insera un fişier sau o imagine în tău tutorial. Cel mai simplu mod pentru a obţine de lucru este de a menţiona documentul în articolul dumneavoastră, apoi pune online o dată completat scris. Dacă fișierul nu există deja, acesta va fi subliniat de o legătură roşie. Făcând clic pe acest link, veţi ajunge la o pagină care vă va permite să încărcaţi fişierul.
Exemple | Résultat |
---|---|
[[Media:mon_fichier.txt]] |
Este demn de remarcat faptul că link-ul de fişier depinde exclusiv pe numele fişierului. Este recomandat să utilizaţi nume descriptiv, ca posibil fişiere. Nu uitaţi să includeţi o descriere a fişierului, atunci când vă pune-l online.
Imagini
Imagini sunt tratate ca fişiere. Prin urmare, puteţi le include şi pune-le online în acelaşi mod ca şi fişiere.
Singura diferenţă cu un fişier este că imaginea va fi afişat în text. Ceea ce vă oferă mai multe opţiuni pentru a afişa.
Sintaxa pentru a se conforma este :
[[File:sample_image.jpg|options|description]]
Opţiuni şi descrierea sunt opţionale.
Exemple | Résultat |
---|---|
[[File:sample_image.jpg|200px|thumb|right|modèle image]]
|
Puteţi găsi mai multe informaţii despre diferitele opţiuni disponibile pe manipularea imaginii pe manuale MediaWiki.
Evitaţi utilizarea imaginilor prea grele şi preferă să utilizeze formatele jpg, jpeg şi png.
Tastatură taste
Pentru a descrie tastele tastaturii, urmaţi aceste recomandări :
- scrie-le în majuscule
- utiliser la balise <span>
- utiliser le symbole + si elles doivent être pressées simultanément
Exemple | Résultat |
---|---|
Suport <span style="background-color: #E6E6E6;">CTRL</span>+<span style="background-color: #E6E6E6;">ALT</span>+<span style="background-color: #E6E6E6;">SUPP</span> Apoi '''Task Conducător ''' |
Appuyer sur CTRL+ALT+SUPP puis Gestionnaire des tâches |
Gazdă nume
Este recomandat să utilizaţi nume de gazdă cele mai specifice posibil, care este în legătură cu rolul de server.
Exemple :
- dns_serveur
- bdd_master
- proxy_nginx
- etc.
Nume de domeniu
Atunci când se ocupă de nume de domenii, preferă să utilizaţi câmpul domain.TLD ca domeniu implicit.
Dacă aveţi mai multe nume de domenii pentru a menţiona, puteţi alege să utilizaţi nume cum ar fi domeniu - 1.TLD , domeniu - 2.TLD etc. |
Pentru subdomenii, vă recomandăm să utilizaţi un nume în legătură cu rolul pentru care va fi ataşat acest subdomeniu, ca master.Domaine.tld , slave.Domaine.tld , BDD.Domaine.tld etc. |
Adrese IP
Pentru a evita să dezvăluie IP-ul dumneavoastra in Tutoriale dumneavoastră şi să fie cât mai clar posibil, va invitam să îndeplinească adrese rezervate documentaţia. În cazul nostru, am prefera să utilizeze adresele bloc 203.0.113.0/24 pentru tot ceea ce este adresa publică. Fie 203.0.113.0 à 203.0.113.255.
Pentru adresele de reţele locale şi localhost, puteţi păstra IP pe care le utilizaţi de obicei. Aceasta înseamnă :
- 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-uri
Capturi de ecran
Dacă al tău tutorial descrie acţiunile pentru a realiza pe o interfaţă grafică, este mai bine să includă capturi de ecran pentru a face mai clară.
Fii atent cu toate acestea nu pentru a fi prea. Nu este problema de a avea un screenshot pentru fiecare cutie buton, text sau link-ul, ci doar ceea ce este nevoie pentru unitate de succes să te urmeze.
Dacă doriţi pentru a captura evidenţia elemente, vă rugăm să nu ezitaţi să adăugaţi săgeţi sau cadre la punct. Aceasta doar va fi numai cuprinzător tutorial.
Vă recomandăm care le pune elementele pe care le menţionezi în grăsime şi care sunt în interfetei grafice că este un buton, un link, o casetă de selectare, etc. |
Nu uitaţi să adăugaţi o descriere atunci când porniţi imagine online.
Concluzia
Vă rugăm să includeţi o scurtă concluzie la al tău tutorial care va rezuma ceea ce a fost făcut şi să introducă ceea ce ar putea fi făcut ulterior.
Ai tot ce ai nevoie pentru a crea propriile articole ! În plus, puteţi consulta, de asemenea, articolul nostru pe stilul iKoula, şi scriere bun !
Acest articol părea să fie util ?
Enable comment auto-refresher