תבנית:דף תיעוד
המידע מטה מוצג מתוך הדף תבנית:דף תיעוד/תיעוד
תבנית זאת נועדה לשימוש בדפי התיעוד של תבניות. יש להציב אותה בראש דף התיעוד, כך שתוסיף את ההודעה:
 |
||
כמו כן התבנית מוסיפה את דף התיעוד לקטגוריה דפי תיעוד של תבניות.
שימוש
[עריכה]כשדף התיעוד הוא דף משנה של התבנית אותה הוא מתעדת ושמו מהצורה "שם התבנית/תיעוד" התבנית עושה את הכל בצורה אוטומטית וכל שצריך זה להוסיף את הקוד:
{{דף תיעוד}}
לראש הדף.
כאשר שם הדף שונה (לא אמור לקרות בתבניות רגילות ויש לשקול להעביר את הדף לשם הנכון) יש להעביר לתבנית "דף תיעוד" את שם התבנית המתועדת ולהוסיף סביב התבנית תגי "noinclude" כך:
<noinclude>{{דף תיעוד}}</noinclude>
ללא תגי ה"noinclude" ההודעה תופיע גם בדף התבנית וחמור מכך התבנית תועבר לקטגוריה דפי תיעוד של תבניות.
תיעוד חלקי
[עריכה]כאשר התיעוד בדף חלקי או לא מספק, וחסרים בו נתונים, הוראות שימוש או מדניות, הסברים חשובים על פעילות התבנית, או אף אם חסרות בו דוגמאות, יש לסמן זאת בתבנית בעזרת הפרמטר |קצרמר=, באופן הבא:
הקוד:
{{דף תיעוד|קצרמר=כן}}
יוסיף את ההערה הבאה מתחת לתבנית:
 התיעוד בדף זה סומן כחלקי.
|
לשם ציון סיבה, בכדי להסביר לעורכים האחרים מה אתם חושבים שחסר בדף, אפשר גם להחליף את הסבר ברירת המחדל שמופיע בהודעה על ידי הזנת טקסט אחר במקום "כן". למשל הקוד:
{{דף תיעוד|קצרמר=יש להוסיף דוגמאות לפעולת התבנית בערכי קיצון, להבהיר את מדיניות השימוש בה בדפי שורשים ולהציג את פעולת הפרמטר "קטגוריה ראשית".}}
יוסיף את ההערה הבאה מתחת לתבנית:
| התיעוד בדף זה סומן כחלקי.
|
לחלופין אפשר סמן "כן" ולפרט בדף השיחה של התבנית (של התבנית הראשית, לא של דף התיעוד) אליו תוכלו להגיע בלחיצה על הקישור בסוף התבנית.
- הסימון כ"קצרמר" מוסיף את דף התיעוד לקטגוריה קטגוריה:תיעוד חלקי.
מידע נוסף
[עריכה]אפשר להוסיף מידע בתוך תיבת ההודעה במקרה הצורך בעזרה הפרמטר |מידע נוסף=
- לדוגמה
- {{דף תיעוד|מידע נוסף={{ש}}דף תיעוד זה כולל מספר הערות לעורכים שלא מופיעות בדף התבנית ואתם מתבקשים לא למחוק אותן.}}
- תוצאה
|
||
ראו גם
[עריכה]- {{תיעוד}}
תבנית לסימון דפי תיעוד לתבניות. יש להציב בראש הדף.
| פרמטר | תיאור | סוג | מצב | |
|---|---|---|---|---|
| התבנית | 1 | שם התבנית – כאשר הוא שונה מברירת המחדל (שהיא דף משנה של התבנית בשם "תיעוד") לרוב אין בכך צורך. | שם דף | לא חובה |
| מידע נוסף | מידע נוסף | מאפשר להוסיף הסברים או מידע נוסף, בתוך התבנית, לאחר התוכן הקבוע. | תוכן | לא חובה |
| קצרמר | קצרמר | סימון דף התיעוד כחלקי, במקרה שפרטי מידע חשובים לגבי התבנית לא נמצאים בו. לשם כך יש להזין "כן". אפשר לציין סיבה שתחליף את הסבר ברירת המחדל שמופיע בהודעה. לחלופין אפשר לסמן "כן" ולפרט בדף השיחה של התבנית (של התבנית הראשית, לא של דף התיעוד). | מחרוזת | לא חובה |
| ללא קטגוריה | ללא קטגוריה | אין תיאור | בלתי־ידוע | לא חובה |
| הצג | הצג | אין תיאור | בלתי־ידוע | לא חובה |