תבנית:דף תיעוד/תיעוד

	דף משנה זה הוא דף תיעוד להתבנית {{דף תיעוד}}.
	הדף כולל תיעוד, הסברים, קטלוג בקטגוריות, וכל תוכן אחר שאינו חלק מהתבנית.	התבנית - דף שיחה

תבנית זאת נועדה לשימוש בדפי התיעוד של תבניות. יש להציב אותה בראש דף התיעוד, כך שתוסיף את ההודעה:

	דף משנה זה הוא דף תיעוד להתבנית {{דף תיעוד}}.
	הדף כולל תיעוד, הסברים, קטלוג בקטגוריות, וכל תוכן אחר שאינו חלק מהתבנית.	התבנית - דף שיחה

כמו כן התבנית מוסיפה את דף התיעוד לקטגוריה דפי תיעוד של תבניות.

שימוש

כשדף התיעוד הוא דף משנה של התבנית אותה הוא מתעדת ושמו מהצורה "שם התבנית/תיעוד" התבנית עושה את הכל בצורה אוטומטית וכל שצריך זה להוסיף את הקוד:

{{דף תיעוד}}

לראש הדף.
כאשר שם הדף שונה (לא אמור לקרות בתבניות רגילות ויש לשקול להעביר את הדף לשם הנכון) יש להעביר לתבנית "דף תיעוד" את שם התבנית המתועדת ולהוסיף סביב התבנית תגי "noinclude" כך:

<noinclude>{{דף תיעוד}}</noinclude>

ללא תגי ה"noinclude" ההודעה תופיע גם בדף התבנית וחמור מכך התבנית תועבר לקטגוריה דפי תיעוד של תבניות.

תיעוד חלקי

כאשר התיעוד בדף חלקי או לא מספק, וחסרים בו נתונים, הוראות שימוש או מדניות, הסברים חשובים על פעילות התבנית, או אף אם חסרות בו דוגמאות, יש לסמן זאת בתבנית בעזרת הפרמטר |קצרמר=, באופן הבא:

הקוד:

{{דף תיעוד|קצרמר=כן}}

יוסיף את ההערה הבאה מתחת לתבנית:

	דף משנה זה הוא דף תיעוד להתבנית {{דף תיעוד}}.
	הדף כולל תיעוד, הסברים, קטלוג בקטגוריות, וכל תוכן אחר שאינו חלק מהתבנית.	התבנית - דף שיחה

התיעוד בדף זה סומן כחלקי.

ייתכן שחסרים בו הסברים או דוגמאות, ואף שהוא מיושן ולא מתוארות בו פונקציות חשובות שנוספו לתבנית. אתם מוזמנים לסייע ולתקן את הבעיות, אם יש בידכם את הידע הדרוש לכך.כמו כן ייתכן שתמצאו פירוט בדף שיחה של התבנית.

לשם ציון סיבה, בכדי להסביר לעורכים האחרים מה אתם חושבים שחסר בדף, אפשר גם להחליף את הסבר ברירת המחדל שמופיע בהודעה על ידי הזנת טקסט אחר במקום "כן". למשל הקוד:

{{דף תיעוד|קצרמר=יש להוסיף דוגמאות לפעולת התבנית בערכי קיצון, להבהיר את מדיניות השימוש בה בדפי שורשים ולהציג את פעולת הפרמטר "קטגוריה ראשית".}}

יוסיף את ההערה הבאה מתחת לתבנית:

	דף משנה זה הוא דף תיעוד להתבנית {{דף תיעוד}}.
	הדף כולל תיעוד, הסברים, קטלוג בקטגוריות, וכל תוכן אחר שאינו חלק מהתבנית.	התבנית - דף שיחה

התיעוד בדף זה סומן כחלקי.

יש להוסיף דוגמאות לפעולת התבנית בערכי קיצון, להבהיר את מדיניות השימוש בה בדפי שורשים ולהציג את פעולת הפרמטר "קטגוריה ראשית".

לחלופין אפשר סמן "כן" ולפרט בדף השיחה של התבנית (של התבנית הראשית, לא של דף התיעוד) אליו תוכלו להגיע בלחיצה על הקישור בסוף התבנית.

• הסימון כ"קצרמר" מוסיף את דף התיעוד לקטגוריה קטגוריה:תיעוד חלקי.

מידע נוסף

אפשר להוסיף מידע בתוך תיבת ההודעה במקרה הצורך בעזרה הפרמטר |מידע נוסף=

לדוגמה

{{דף תיעוד|מידע נוסף={{ש}}דף תיעוד זה כולל מספר הערות לעורכים שלא מופיעות בדף התבנית ואתם מתבקשים לא למחוק אותן.}}

תוצאה

	דף משנה זה הוא דף תיעוד להתבנית {{דף תיעוד}}.
	הדף כולל תיעוד, הסברים, קטלוג בקטגוריות, וכל תוכן אחר שאינו חלק מהתבנית. דף תיעוד זה כולל מספר הערות לעורכים שלא מופיעות בדף התבנית ואתם מתבקשים לא למחוק אותן.	התבנית - דף שיחה

ראו גם

• {{תיעוד}}