כיצד לעצב מאמר
fr:Comment formater son article
מאמר זה הוא התוצאה של תרגום אוטומטי המבוצע על ידי תוכנה. אתה יכול להציג את מקור המאמר כאן.
מאמר זה מתאר כיצד לעצב את ערכת לימוד בנושא. לפי המדריך הזה ואחד סגנון הכתיבה, הדרכה שלך יחיל את ההמלצות של ikoula.
תחביר הויקי
הדרכות ikoula חייב להיות מאותחל באמצעות תחביר ויקי. מאמר זה ייתן לך את הדוגמאות הנפוצות של תחביר זה. ניתן למצוא פרטים נוספים בסעיף העזרה מדיה-ויקי לגבי עיצוב wiki.
פרקים
כדי לגזור את הדרכות לפרקים, באפשרותך להשתמש רמות כותרת. ברגע שתכניס כותרת הדף, כל הפריטים הבאים תיחשב כחלק מן הפרק החדש, עד הכותרת הבאה באותה הרמה.
זה יכול להיות מאוד שימושי לשפר את הקריאות של המאמר שלך על ידי חיתוך בשלבים שונים של מימוש.
רמות שונות של כותרת
הכותרת של רמת 1 מקביל הכותרת של המאמר. הוא נוצר באופן אוטומטי בעת יצירת הדף שלך. המסילה בנויות סביב הכותרת שלך על-ידי סימנים "=". הכותרת של רמת 2 מקביל התואר הראשון של הפרק או הסעיף.
דוגמה עבור הכותרת סעיף זה :
==Chapitres==
יותר אתה לחתום סביב את התואר יותר. אתה תלך על העץ
דוגמה | התוצאה |
---|---|
===Titre de niveau 3=== ====Titre de niveau 4==== =====Titre de niveau 5===== |
Titre de niveau 3Titre de niveau 4Titre de niveau 5 |
ראוי לציין כי תוכן עניינים אוטומטי מופיע בראש המאמר ברגע ישנם לפחות 4 פרקים או subchapters.
סגנונות
באפשרותך לעצב את הטקסט באמצעות תחביר הויקי ותגי ה-HTML כמה.
מודגש
הנה איך לסיים מודגש במאמר שלך.
דוגמה | התוצאה |
---|---|
'''טקסט מודגש ''' |
texte en gras |
הנה רשימה של פריטים שאמורים להיות מודגשים.
- טקסט גלוי של GUI
- שינוי ההקשר עבור פקד, כגון שינוי משתמש או שרת
- שפורסמו כמו שרת-1
- משתמשים כמו ikoula
- מהירה
- רשימת מונחים, ככל :
- MySQL: מנוע מסד הנתונים
- אפאצ'י : שרת אינטרנט
- כי לא צריך לפספס השחקן, גורמים בלי יותר מדי.
נטוי
נטוי אמור לשמש רק להכיר מונחים טכניים. למשל : le שרת nginx ישמש בתור להפוך את ה-proxy .
דוגמה | התוצאה |
---|---|
''טקסט נטוי '' |
texte en נטוי |
הערות ואזהרות
השימוש של תגי HTML מסוימים ייתכן שיהיה צורך להדגיש אלמנטים מסוימים כגון הערות או אזהרות.
דוגמה | התוצאה |
---|---|
<div style="background-color: #FFCC99;"> '''הערה ''': זוהי הערה. </div>
<div style="background-color: #FF9999;"> '''אזהרה ''': זה אזהרה. </div>
|
Note: Ceci est une note.
Warning: Ceci est un avertissement.
|
Blockquotes
blockquotes הם רחובות שבו הטקסט יעוצב באופן שונה. כדי לעשות זאת, פשוט מקם רווח בתחילת משפט או הקף את הטקסט של תגיות <pre>. Votre texte sera alors formaté dans un cadre avec une police différente.
דוגמה | התוצאה |
---|---|
טקסט חשוב ''italique'' |
Texte important italique ou Texte important ''italique'' |
כפי שרשמת, השימוש בתג <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'השתמש בתג 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.
דוגמה | התוצאה |
---|---|
<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.
דוגמה :
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
דוגמה | התוצאה |
---|---|
* é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 | ||||||
---|---|---|---|---|---|---|---|
{| |תפוז |אפל |- |לחם |פאי |- |חמאה |גלידה |} |
|
לקבלת מידע נוסף על טבלאות, להתייעץ ויקימדיה ידנית
סקריפטים וקבצי
להיות בטוח לתאר את התפקיד של קבצים או סקריפטים שהזכרת. בדרך זו יהיה הקורא את אותה רמת מידע זה אתה יותר יוכלו להבין את הגישה שלך.
סקריפטים
כאשר אתה נותן את התוכן של קובץ script או קובץ תצורה, לוודא את שזה הוא הגיב, רצוי ברמה של הקווים מודאג. המטרה היא כי הקורא להבין את כל הפעולות המתוארות, לכן חשוב להיות חינוכית יותר ככל האפשר. בדרך זו, תהיה אפשרות להתאים אישית, לעדכן או לאבחן בעיות שלה שרת בטווח הארוך.
אם הקבצים שתפרסם יש חלק גדול ו- /או לא מעניין עבור הדרכה שלך, באפשרותך להשמיט את המסיבות האלה עם האליפסה (...).
אנו ממליצים על השימוש Balise GeSHi כדי להציג את התוכן של קבצי script או קבצים. האחרון יאפשר לך, בנוסף סימון תחביר, פשוט לציין מספרי שורות, לסמן יותר חשוב. מומלץ להשתמש את הסימון כדי לציין את השורות שם יש שינויים לבצע.
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>
|
קובץ
. יש לך את האפשרות של הוספת קובץ או תמונה במדריך שלך... הדרך הפשוטה ביותר כדי להשיג את הדבר היא להזכיר המסמך במאמר שלך, ואז לשים באינטרנט פעם השלמת הכתיבה. אם הקובץ אינו קיים כבר, זה להיות הצביע על-ידי קישור אדום. על ידי לחיצה על קישור זה, תגיעו לדף שיאפשר לך להעלות את הקובץ שלך.
Exemple | Résultat |
---|---|
[[Media:mon_fichier.txt]] |
ראוי לציין כי הקישור לקובץ תלויה אך ורק השם של הקובץ. מומלץ להשתמש בשמות תיאורי כקבצי אפשרי. אל תשכח לכלול תיאור של הקובץ, כשאת מנסחת את זה באינטרנט.
תמונות
תמונות מטופלים כקבצים. לכן ניתן לכלול אותם, מכניסים אותם באינטרנט באותו אופן כמו קבצים.
ההבדל היחיד עם קובץ הוא כי התמונה תוצג בטקסט. מה נותן לך אפשרויות נוספות כדי להציג...
התחביר להיענות :
[[File:sample_image.jpg|options|description]]
אפשרויות ותיאור הן אופציונליות.
Exemple | Résultat |
---|---|
[[File:sample_image.jpg|200px|thumb|right|modèle image]]
|
קובץ:Sample image.jpg modèle image |
אתה יכול למצוא מידע נוסף אודות האפשרויות השונות הזמינות במניפולציה תמונה על מדריך מדיה-ויקי.
הימנע משימוש כבד מדי תמונות, מעדיפים להשתמש בפורמטים jpg, jpeg ו- png.
מקלדת מקשים
כדי לתאר את מקשי לוח המקשים, לעקוב אחר ההמלצות הבאות :
- לכתוב אותם באותיות רישיות
- utiliser la balise <span>
- utiliser le symbole + si elles doivent être pressées simultanément
Exemple | Résultat |
---|---|
תמיכה ב- <span style="background-color: #E6E6E6;">CTRL</span>+<span style="background-color: #E6E6E6;">ALT</span>+<span style="background-color: #E6E6E6;">SUPP</span> ואז '''מנהל המשימות ''' |
Appuyer sur CTRL+ALT+SUPP puis Gestionnaire des tâches |
לארח שמות
אנו ממליצים שתשתמש שמות מארחים ביותר האפשרי ביותר, זה ביחס בתפקיד שרת.
Exemple :
- dns_שרת
- bdd_master
- proxy_nginx
- וכו '.
שמות דומיין
כאשר אתם בתהליך שם תחוםs, מעדיפים להשתמש בשדה domain.tld בתור התחום המוגדר כברירת מחדל.
אם יש לך מספר שם תחום להזכיר, באפשרותך לבחור להשתמש בשמות כגון דומיין - 1.tld, דומיין - 2.tldועוד. |
עבור תחומי משנה, אנו ממליצים שתשתמש שם בקשר לתפקיד שאליו תצורף תחום משנה זו, כמו master.Domaine.tld , slave.Domaine.tld , BDD.Domaine.tld ועוד. |
כתובות IP
כדי להימנע לחשוף את ה-IP שלך ב הדרכות שלך, להיות ברור ככל האפשר, אנו מזמינים אתכם להכיר כתובות שמורות בתיעוד. במקרה שלנו, אנו מעדיפים השתמש בכתובות בלוק 203.0.113.0/24 על הכל וזה כתובת ציבורית. גם 203.0.113.0 à 203.0.113.255.
עבור הכתובות של רשתות מקומיות, localhost, אתה יכול לשמור את ה-IP בדרך כלל להשתמש. זה אומר :
- 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
קישורים
צילומי מסך
אם לימוד שלך מתאר פעולות להבין על ממשק גרפי, עדיף לכלול צילומי מסך כדי שיהיה ברור יותר.
להיזהר עם זאת לא להיות יותר מדי. . זה לא שאלה של בעל מסך עבור כל תיבה לחצן, טקסט או קישור, אך רק מה שדרוש עבור כונן מצליח לעקוב אחריך...
אם ברצונך ללכוד לסמן פריטים, אנא הרגישו חופשי להוסיף חצים או מסגרות עד לנקודה. זה לא להפוך את לימוד מקיף יותר.
אנו ממליצים ששמת את הרכיבים שהזכרת שומן, אשר נמצאים בממשק גרפי, כי זה בלחיצת כפתור, קישור, בתיבת סימון, ועוד. |
לא לשכוח להוסיף תיאור כאשר אתה מפעיל את התמונה באינטרנט.
סיכום
כלול מסקנה קצר כדי שלך הדרכה אשר לסכם מה עשיתם ולהציג מה אפשר היה לעשות לאחר מכן.
יש לך כל מה שאתה צריך כדי ליצור משלך מאמרים ! בנוסף, באפשרותך לעיין גם המאמר שלנו על סגנון iKoula, וכתיבה טובה !
מאמר זה נראה שתהיה שימושית ?
הפעלת רענון אוטומטי של התגובות