עזרה:תבניות
תבנית (באנגלית: Template) היא שיטת עריכה במכלול, המאפשרת הצגה של תוכן של דף מסוים בתוך דף אחר, ללא הצורך לבצע העתקה ושכפול של התוכן בין הדפים. תבנית היא דף שנכתב באמצעות (תחביר ויקי), שאפשר "לשתול" בכל דף במכלול, ומוצג כפי שהוא בזמן אמת. השימוש בתבנית מרכז טקסט במקום אחד, מונע כפילויות, מקל על ביצוע עדכונים ושינויים בדפים רבים בו-זמנית ושומר על אחידות בדפי המכלול.
השימוש בשיטה זו דומה ליצירת קישור, אך במקום להוסיף שני זוגות של סוגריים מרובעים משני צִדי המילה ([[ ו־]]) יש להשתמש בשני זוגות של סוגריים מסולסלים ({{ ו־}}). ניתן להעתיק בצורה זו את תוכנו של כל דף בכל מרחב שם, אך נהוג להעתיק דפים מתוך המרחב "תבנית", שנוצר לשם כך. ההסברים שלהלן מתבססים על שימוש במרחב שם זה. לגבי שימוש בשיטה זו לדפים מסוגים אחרים ראו בהמשך.
יצירת תבנית חדשה
שימו לב: ליצירת תבנית חדשה במכלול ולהכנסת שינוי מהותי בתבנית קיימת משמש הדף המכלול:תבנית/אולם דיונים. טרם פתיחת דיון, מומלץ להתייעץ לגבי קיומה של תבנית או הצורך בתבנית חדשה בהמכלול:דלפק ייעוץ.
הסבר טכני
- יצירת תבנית
- תבנית היא אחד מסוגי הדפים הקיימים במכלול: כדי ליצור תבנית חדשה, יש ליצור דף חדש שבו יוכנס תוכן התבנית (ראו הסבר בקישור). תבנית נמצאת במרחב שם "תבנית:", כך שיש לכתוב בשורת החיפוש "תבנית:שם התבנית הרצויה" ולפעול לפי ההוראות שבקישור.
- שילוב תבנית בערך
- בכל דף אחר בו תרצו להוסיף את (תוכן) התבנית, כתבו את הטקסט
{{שם התבנית הרצויה}}במקום הרצוי. התוכן שהזנתם לתבנית יופיע שם בתצוגה המקדימה או לאחר שמירת הדף.
דוגמה:
אם רוצים להשתמש בתבנית בשם "חדש" – בכל מקום בו רוצים להוסיף את התבנית, יש לכתוב את הטקסט: :{{חדש}}
מכיוון שתבנית כזו אינה קיימת, לאחר הכתיבה מקבלים את התוצאה הבאה:
תבנית:חדש
לחיצה על הקישור תפתח דף עריכה ליצירת תבנית בשם "חדש".
קווים מנחים בתכנון תבניות
- ליצירת תבנית חדשה במכלול או להכנסת שינוי מהותי בתבנית קיימת משמש הדף "המכלול:תבנית/אולם דיונים".
- טרם פתיחת דיון, מומלץ להתייעץ לגבי קיומה של תבנית כזו או הצורך בתבנית חדשה ב"המכלול:דלפק ייעוץ".
- ככלל, תבניות ניווט תוכנסנה למרחב הערכים רק כאשר יש בהן תועלת לניווט, לכן תבנית שאין בה לפחות 5 ערכים קיימים (כחולים) לא תוצג במרחב הערכים. כמו כן, עליהן לענות על הכללים של המכלול:לולאת נושא.
- עבור פרמטרים שנפוצים בתבניות רבות נהוג להשתמש בשמות זהים על מנת להקל על העורכים ולאפשר שימוש אחיד לדוגמה:
תמונה, כיתוב 
תצלום, צילום מסך, תמונה מייצגת, כיתוב, כותרת תמונה, תיאור תמונה- סמל, כיתוב סמל לוגו, סמליל, תמונה, כיתוב, כיתוב לוגו
- מפה, כיתוב מפה תצלום, תמונה, כיתוב, כותרת מפה, תיאור מפה
- המלצות הנוגעות לשילוב מידע מוויקינתונים - ובפרט יש לאפשר לדרוס בצורה מקומית שדות שנלקחים מוויקינתונים.
- בתבניות ניווט שאותן נהוג לשלב בתחתית הערכים, נהוג להשתמש בתבנית:ניווט או תבנית:ניווט קבוצות שמאפשרות השגת אחידות במראה של ניווטים ומסגרת ברורה היוצרת הבחנה ברורה בין התבנית לתוכן הערך.
לאחר יצירת התבנית
לאחר יצירת התבנית, יש ליצור תיעוד כראוי, על מנת להקל על השימוש בה. להרחבה, ראה סעיף בהמשך.
את התבנית החדשה יש לקטלג תחת הקטגוריה המתאימה. יש לשים לב שקטגוריה מסוימת נדרשת לקטלוג התבנית בין קטגוריות התבניות, וקטגוריה אחרת עשויה להתווסף לתבנית רק בדפים שבהם הוסיפו אותה (למשל, דפים לתחזוקה).
כדי ללמוד כיצד להוסיף קטגוריה רק בדפים שבהם התבנית משולבת, לחצו על הקישור.
סיכום התהליך
הערה – זהו סדר השלבים המומלץ. אין צורך ללכת בהכרח לפי הסדר המוגדר, אך על מנת לאשר שימוש בתבנית יש לקבל אישור באולם התבניות.
- בדיקת הצורך - דלפק ייעוץ
- הצעה בהמכלול:תבנית/אולם דיונים – חובה (דגש חשוב – אין בהכרח צורך בידע טכני כדי לפתוח דיון. הדיון נועד לפתור בעיה)
- יצירת פתרון טכני (רצוי קודם כל בדף טיוטה או בדף משנה)
- תיעוד למשתמשים ולעורכים נוספים
- הכנה לשימוש נרחב – התאמה למערכת בדיקת הפרמטרים
- הנגשת התבנית – התאמה לאשף התבניות, פרסומה בדפים רלוונטים
דרכים שונות להוספת תבנית אל דף וקישור אליה
קישור מהצורה {{שם התבנית הרצויה}} ישתול את תוכן התבנית בדף, בעוד קישור מהצורה [[תבנית:שם התבנית הרצויה]] יהווה קישור פנימי, המוביל אל דף התבנית.
העתקת קוד המקור של התבנית
הוספת הכיתוב ס: לפני שם של תבנית (או שם של דף, כאשר הוא מוקף בסוגריים מסולסלים) גורמת להעתקת הדף בשלמותו מתוך דף המקור, באופן חד-פעמי ולא מתעדכן, כך שבעיון חוזר בדף העריכה לא ניתן יהיה לדעת שנעשה שימוש בתבנית כלשהי. לדוגמה, אם ניקח את התבנית {{@}}, הוספת ה-ס: תיראה כך:
{{ס:@}}
והתוצאה תיראה כך:
והקוד, בזמן עריכה, ייראה כך:
[[קובץ:@@@.svg| -at- |link=|13px]]
להמחשת הרעיון, ניתן לגשת לארגז החול, להוסיף שם את התבנית {{@}}, ואז לשמור את הדף. תבנית זו מוסיפה תמונה קטנה בצורת סימן "@". אם נערוך את ארגז החול בשנית, נמצא את הטקסט שהוספנו (כלומר, את שם התבנית) ללא שינוי. כעת נוסיף ס: אחרי הסוגריים המסולסלים ולפני שם התבנית (במקרה זה, שם התבנית הוא "@") ונשמור את הדף בפעם השנייה. הדף עדיין מוצג ונראה ללא שינוי, אולם אם ניכנס שוב למצב עריכה של הדף, נמצא כי הטקסט שנשמר שונה, ועכשיו מופיע הטקסט עצמו שגורם לתמונה להופיע – הטקסט שמופיע בקוד המקור בדף התבנית {{@}}.
ניתן לעשות באפשרות זו שימוש במקרים שבהם אין צורך לעדכן שנית את הטקסט, וכל המטרה היא לחסוך פעולת "העתק-הדבק". שימוש מאסיבי ב-ס: היכן שאין צורך שתהיה תבנית מעודכנת עשוי להקטין את העומס על שרתי המכלול. מנגד, החסרון הוא חוסר הדינמיות של תכונה זו: אם תתבצע עריכה בדף התבנית, השינוי לא ישתקף (יתעדכן) בדף אליו הועתקה התבנית. שימוש בתכונה זו לא מומלץ אפוא בתבניות ניווט בערכים.
קיים גם מספר מועט של תבניות שמחייבות שימוש בתכונה זו, כדוגמת {{הבהרת חשיבות}} או {{ציר זמן}}, אשר בהיעדר שימוש בתכונה זו לא יוצגו כראוי.
השם הלועזי המקורי של ס: הוא subst:.
השוואה
להלן השוואה בין תבנית רגילה, ותבנית עם התחילית ס::
| צורת הכתיבה | תצוגה בגלישה | מבט אל דף העריכה |
|---|---|---|
|
|
הוספתי לאחר התנגשות עריכה: |
{{אחרי התנגשות}} |
|
|
הוספתי לאחר התנגשות עריכה: |
<span style="font-size: 75%">הוספתי לאחר התנגשות עריכה -</span> |
דפי הפניה
ברגע שיוצרים דף הפניה מתבנית אחת לתבנית אחרת, המכלול תתייחס לתבנית שביעד דף ההפניה. לדוגמה, רישום התבנית {{עריכה}} או התבנית {{לערוך}} המפנה אליה, יגרמו לאותה תוצאה.
התייחסות לדף רגיל כאל תבנית
אפשר להתייחס לכל דף כאילו היה תבנית, באמצעות תחימת שמו בשני סוגריים מסולסלים והקדמת : (נקודתיים) לשם:
{{:שם ערך}}
לדוגמה, אם ברצונכם להעתיק את כל תוכן הערך "עברית" לדף מסוים, כתבו בדף היעד את הטקסט:
{{:עברית}}
שימו לב לסימן הנקודתיים ( : ) המופיע לפני שם הערך ("עברית", במקרה זה). אם יתבצע שינוי בערך "עברית", השינוי ישתקף (יתעדכן) בצורה אוטומטית גם בדף היעד, בלי שנעשה בו אף שינוי.
בדרך דומה ניתן להעתיק את תוכנם של דפים אחרים, שאינם נמצאים במרחב הראשי (מרחב הערכים). לדוגמה, כדי להעתיק את כל תוכנו של דף דלפק הייעוץ לדף מסוים, יש לכתוב בו את הטקסט הבא:
{{המכלול:דלפק יעוץ}}
שימו לב, שבמקרה זה לא נוספו נקודתיים לפני המילה "המכלול:". ניתן להעתיק בצורה דומה טקסטים ממרחבי שם אחרים, כדוגמת "משתמש:", "קטגוריה:", "שיחת המכלול:" וכדומה.
שיבוץ דף משנה בדף האב
ישנו תחביר מקוצר לשילוב של דף משנה בדף האב שלו. במקום לרשום את שם הדף המלא, ניתן לרשום רק את שם דף המשנה, לאחר / (לוכסן). שימושי במיוחד עם דפי תיעוד ודוגמאות של תבניות, הכתובים בדפי משנה.
לדוגמה, כדי לשבץ בדף "תבנית:ניווט קבוצות" את תוכן דף המשנה "תבנית:ניווט קבוצות/הוראות שימוש", די לכתוב בו:
{{/הוראות שימוש}}
גם במקרה של שימושים כאלו בתבניות, ניתן להשתמש ב-ס: ובפרמטרים.
אשף התבניות
ערך מורחב – עזרה:אשף התבניות
אחת הדרכים הפשוטות ביותר להוספת תבנית (מורכבת) לדף כלשהו היא באמצעות "אשף התבניות"; בפרט אם הוספו לתבנית תיעוד ותמיכה ייעודיים עבור האשף (ראו "אשף התבניות" תחת פרק "תיעוד תבנית"):
- כדי להיעזר באשף, כאשר נמצאים במצב עריכה, יש ללחוץ על הכפתור
שבסרגל הכלים העליון. האשף יפתח חלון, שמאפשר להזין את שם התבנית הרצויה מתוך רשימה. לאחר לחיצה על "אישור", תגיעו לאשף עצמו. - לחלופין, ניתן לסמן את התבנית כולה, כולל כל הפרמטרים שכבר מולאו בה. האשף יאסוף את הערכים הללו מהדף, ימלא את השדות המתאימים ויציג בפניכם את האשף.
מידע נוסף ניתן לקרוא בערך המורחב.
עריכת תבנית
ניתן לערוך תבנית קיימת על ידי איתור דף התבנית ולחיצה על "עריכת קוד מקור" בראש הדף, כמו כל דף הפתוח לעריכה במכלול.
דרך נוספת לעריכת תבנית היא על ידי עריכת דף המכיל את התבנית: מתחת לאזור העריכה (מתחת לכפתורי השמירה והתצוגה המקדימה), לחיצה על הכותרת "תבניות המופיעות בדף זה:" תפתח רשימה של כל התבניות המופיעות בדף (גם אלו שלא כלולות וכתובות מפורשות בדף!; דהיינו, תבניות שנמצאות בתוך הקוד של תבניות שכתובות בדף).
שימו לב: יש לקחת בחשבון שהכנסת שינוי בתבנית קיימת תשפיע על דפים רבים, ולכן, יש לוודא היטב שהשינוי לא פוגע בהצגת התבנית או בתפקודה!
סימנים מיוחדים
סימנים אחדים יש צורך לכתוב בצורה מיוחדת כדי שיופיעו בתוכן תבנית:
| הסימן | אופן כתיבתו בתבנית |
|---|---|
| : | : |
| ; | ; |
| * | * |
| # | # |
הסימן | (קו ניצב) מפריד בין פרמטרים בתבנית (ראו להלן). כאשר רוצים להוסיף סימן זה לתוכן התבנית, יש לכתוב במקומו את הצירוף {{!}}. דוגמה: כדי לכלול בתבנית את הטקסט "האולימפיאדה || מדליית זהב לספורטאי ישראלי", יש לכתוב האולימפיאדה {{!}}{{!}} מדליית זהב לספורטאי ישראלי.
דרך נוספת היא לעשות שימוש בתגית <nowiki>, או בתבנית:ללא קוד ויקי.
הגדרת פרמטרים לתבנית
ניתן ליצור תבניות פשוטות, הכוללות טקסט מוגדר קבוע וללא אפשרות של המשתמש להשפיע על תוכנן ואופן הצגתן. אפשרות מתקדמת יותר היא ליצור תבניות בעלות פרמטרים, לשימוש כללי יותר, שניתן להשפיע על תוכנן או עיצובן באופן שונה בכל דף בו מופיעה התבנית (ליתר דיוק – בכל 'מופע' של התבנית, מאחר שאותה תבנית יכולה לשמש ולהופיע מספר פעמים באותו הדף). אופן יצירת תבנית פרמטרית זהה ליצירת תבנית רגילה, ולפיכך, יש לבצע את כל השלבים המתוארים בסעיף "יצירת תבנית חדשה". ישנם שני סוגי פרמטרים: פרמטר שמי ופרמטר מספרי.
פרמטר שמי
לאחר שנוצר דף התבנית, יש לכתוב בתוכה שם לפרמטר, כאשר הוא ממוקף בשלושה סוגריים מסולסלים משני צדדיו {{{ }}}.
שימו לב: הוספת שני סוגריים מסולסלים תוביל ליצירת תבנית חדשה נוספת, ועל כך יש להקפיד ולספור היטב את מספר הסוגריים). דוגמה לצורת כתיבת פרמטר:
{{{שם הפרמטר}}}
השימוש בפרמטר בדף היעד ייעשה על פי הסדר הבא:
- שני סוגריים מסולסלים פותחים (ימניים) (
}}) - שם התבנית
- תו מפריד - קו ניצב (
|) - שם הפרמטר
- הסימן שווה (
=) - ערך הפרמטר
- שני סוגריים מסולסלים סוגרים (שמאליים) (
{{)
עבור כל פרמטר נוסף, יש לחזור על השלבים 3–6.
תחביר לדוגמה של תבנית עם שלושה פרמטרים:
{{שם תבנית|פרמטר1=ערך1|פרמטר2=ערך2|פרמטר3=ערך3}}
דוגמה מעשית של תבנית עם שני פרמטרים:
{{חדש|תמונה=פרפר.jpg|שם=משפחת הפרפרים}}
ניתן לפרוס את הטקסט הנ"ל גם במאונך, במקרה שישנם פרמטרים רבים או שערכיהם ארוכים, על מנת לשפר את קריאות הקוד ולהקל על ההתמצאות בה. אין לכך שום השפעה על התוצאה ואופן הצגתה הסופי של התבנית. מומלץ לדאוג שהקווים המפרידים (|) ימוקמו בתחילת כל שורה של פרמטר. תחביר לדוגמה:
{{שם תבנית
|פרמטר1=ערך1
|פרמטר2=ערך2
|פרמטר3=ערך3
}}
פרמטר מספרי
ניתן לכתוב ולהוסיף לתבנית פרמטרים גם ללא שם. במקרה כזה, יש לתת לכל פרמטר מספר סידורי, שיופיע תחום בין שלושה סוגריים מסולסלים. לדוגמה:
{{{1}}}
בתבנית בה מופיעים הפרמטרים {{{1}}}, {{{2}}} ו-{{{3}}}, צורת הכתיבה הרגילה בדף היעד (להוציא מקרים מיוחדים (ראו בהמשך)) לא תהיה:
{{שם התבנית|1=ערך1|2=ערך2|3=ערך3}}
אלא:
{{שם תבנית|ערך1|ערך2|ערך3}}
לדוגמה:
{{חדש|פרפר.jpg|משפחת הפרפרים}}
החסרון בשימוש בתבנית כזו הוא שבריבוי פרמטרים, קשה לזכור מה ייעודו ומיקומו הנכון של כל פרמטר, וקל להתבלבל בסדר. מאידך, תבנית זו מהירה יותר לשימוש (יש פחות תווים להקלדה) וחוסכת "ביורוקרטיה" מיותרת. מומלץ להשתמש בצורה זו רק כאשר יש שימוש בפרמטרים ספורים. חסרון נוסף בשימוש בפרמטרים מספריים הוא שלא ניתן להזין את הסימן שווה (=). לדוגמה, בתבנית {{חדש|פרפר.jpg|משפחת הפרפרים=butterfly family}} אין פרמטרים שמיים, ואולם, התבנית תתייחס ל-"משפחת הפרפרים" כאל שם של פרמטר, ול-"butterfly family" כאל הערך שמוזן לו, אך היא כמובן לא תמצא פרמטר בשם "משפחת הפרפרים" ותחזיר הודעת שגיאה. כדי לעקוף בעיה זו, ניתן להזין את הקוד הבא במקום סימני שווה:
=
או להשתמש בתבנית ששמה "=":
{{=}}
לחלופין, ניתן להתייחס לפרמטר המספרי כאילו היה פרמטר שמי, ולציינו במפורש בעת השימוש בתבנית: {{חדש|פרפר.jpg|2=משפחת הפרפרים = butterfly family}}
ניתן לשלב בתבנית אחת פרמטרים שמיים ופרמטרים מספריים ביחד. לדוגמה:
{{שם תבנית|חיה=חתול|2=שחור|מין=זכר|מבוית}}
הגדרת ברירת מחדל לפרמטר
ניתן להגדיר ברירת מחדל לפרמטר, כך שאם לא יוכנס ערך לפרמטר, יופיע טקסט ברירת המחדל. כדי להגדיר ברירת מחדל לפרמטר כלשהו, לדוגמה, ל-{{{שם הסרט}}}, יש להוסיף קו אנכי (|) אחרי שם הפרמטר ולאחריו את טקסט ברירת המחדל באופן הבא:
{{{שם הסרט|טקסט ברירת מחדל}}}
דוגמה נפוצה לשימוש בברירת המחדל היא באמצעות שימוש בתבניות קבועות של המערכת, כגון {{שם הדף בלי הסוגריים|}} המחזיר את שם הדף. הקוד:
{{{שם הסרט| {{שם הדף בלי הסוגריים|}} }}}
מאפשר לעורכים למלא את שם הסרט, ואם פרמטר זה נותר ריק, ישמש שם הדף (בלי הסוגריים) במקומו של הפרמטר.
בדיקת קיום פרמטר
- ערך מורחב – עזרה:הוראות תנאי#תנאי
כדי לבדוק האם לתבנית הוזן פרמטר, ניתן לעשות בדיקה באמצעות הוראת התנאי הבא:
{{#if: {{{param|}}} | Hooray...! | Darn...! }}
תוצאה: Darn...!
או בעברית:
{{#תנאי: {{{פרמטר|}}} | יש ערך...! | אין ערך...! }}
תוצאה: אין ערך...!
בפרמטר הראשון מקבלים את התוצאה כאשר יש ערך, ובפרמטר השני כאשר אין ערך.
שינוי פרמטרים בתבנית קיימת
שימו לב: במקרה שמשנים בתבנית קיימת את מספר הפרמטרים, או שמשנים את הסדר שלהם, השינוי יבוא לידי ביטוי בכל הדפים שבהם הוכנסה התבנית לפני השינוי, וזה עלול ליצור תוצאות לא צפויות ובלתי רצויות, כגון: הוצאת דברים מהקשרם, הופעת טקסט מיותר, הפרעות בפריסת התבנית והטקסט ואף שגיאה ואי-הצגה מוחלטת של התבנית. כדאי לתת על כך את הדעת בכובד ראש בזמן שמשנים את התבנית, ובכך ניתן למנוע את הבעיה לפני שנוצרה. לפי כללי המכלול, גם נדרש להתייעץ על כך בהמכלול:תבנית/אולם דיונים.
הגדרת תבנית כפרמטר
במקרה שיש פרמטרים החוזרים על עצמם במספר תבניות, או בחלק מורכב טכנית (כגון מפת מיקום), ניתן ליצור תבנית חדשה שתשמש כפרמטר ובכך תקל על המשתמשים בתבנית. התבנית החדשה היא למעשה מודול, מעין "קופסה שחורה" שאפשר להכניס לה פרמטרים ולא מעניין את המשתמשים איך היא עובדת. התבנית המקבלת תבנית כפרמטר מכונה תבנית מודולרית (לדוגמה: התבנית המודולרית {{משגר}} עם המודול {{שלב במשגר}}).
תכנים שיופיעו בדף התבנית בלבד או שיופיעו רק בדפים המכילים את התבנית
תכנים שיופיעו בדף התבנית בלבד
לעיתים, יש צורך שתוכן מסוים יוצג בדף התבנית בלבד, ולא בדפים המכילים אותה (כגון הסברים לשימוש בתבנית, הקטגוריה של התבנית, קישורי בינוויקי, או הצבעת מחיקה על תבנית). במקרים אלו, יש להשתמש בתגית <noinclude> (בעברית: לא/אל תכלול) באופן הבא:
<noinclude>תוכן שמופיע בתבנית בלבד, ולא בדפים המכילים אותה.</noinclude>
שימו לב: בעת שימוש בתגית <noinclude>, יש לוודא כי היא ממוקמת בצמוד לתו האחרון שרוצים שייכלל בדפים המכילים את התבנית. לדוגמה, מיקום תגית <noinclude> לאחר ירידת שורה יוביל להכללת שורת רווח מיותרת בדפים המכילים את התבנית, ואף עלול לגרום לבעיות עימוד בין מלל הערך לטבלה שמקורה בתבנית.
הערה מוסתרת בתבנית
כמקרה פרטי, בתבנית מסובכת רצוי לשבץ הערות (מעין תיעוד פנימי בקוד) (זאת בנוסף לתיעוד רגיל), שיסבירו למתכנת המתחזק את התבנית מה עושה קטע מסוים. כתיבת הערה מוסתרת תיעשה באופן הבא:
<noinclude><!-- טקסט ההערה --></noinclude>
וזאת כדי למנוע את הכללת הטקסט המוסתר (המיועד למתכנת) בכל הטמעה של התבנית בדפי המכלול.
תכנים שיופיעו רק בדפים המכילים את התבנית
לעיתים, מעוניינים במצב ההפוך; שתוכן מסוים יוצג או ייכלל בדפים המכילים את התבנית, אך לא בדף התבנית עצמה (למשל, קטגוריות תחזוקה – אין צורך שהתבנית עצמה תופיע ברשימת הדפים שיש לתחזק, אלא רק הדפים שבהם היא נוספה (לצורך כך, ניתן להיעזר גם בתבנית: {{קטגוריה בתבנית}})). במקרים אלו יש להשתמש בתגית <includeonly> (בעברית: כְּלוֹל רק) באופן הבא:
<includeonly>תוכן שלא מופיע בדף התבנית, אבל מופיע בדפים המכילים אותה.</includeonly>
המלצה: ככלל, מאחר שאת דף התבנית נהוג לפתוח ישר עם קוד התבנית (לפני התיעוד והוראות השימוש), מומלץ לפתוח כל כתיבת תבנית בתגית <includeonly>.
בדיקת השפעות השינויים בתבנית על דפים אחרים עוד בטרם שמירתה
- ערך מורחב – עזרה:ארגז חול לתבניות
לעיתים, ואולי אפילו ברוב המקרים, מומלץ להיות זהירים ולבחון כיצד השינויים שהוכנסו בתבנית משפיעים ומשתקפים בדפים שונים במכלול (כולל בדף התבנית עצמו, שאמור להכיל תיעוד של התבנית ולהציג דוגמאות העושות שימוש בה). לשם כך, פותחו במכלול שני כלים המסייעים לבדוק קוד של תבנית בטרם שמירתו:
- תצוגה מקדימה של הדף עם התבנית הזאת – אפשרות חדשה, שנוספה בעת עריכת דפים במרחב התבניות, ומופיעה בתחתית דף העריכה (מתחת לכפתורי השמירה הרגילים). אפשרות זו היא הפשוטה והמהירה מבין השתיים.
- ארגז חול של תבניות – זהו דף מיוחד, המאפשר לבחון תבניות השמורות בטיוטה הפרטית של המשתמש. אפשרות זו מורכבת יותר, אך שימושית במיוחד עבור בחינת שינויים בתבניות רבות בו-זמנית.
הכלי הראשון מאוד פשוט לשימוש: בעת עריכת תבנית, מתחת לכפתורי השמירה בתחתית העמוד תופיע תיבה נוספת תחת הכותרת "תצוגה מקדימה של הדף עם התבנית הזאת". בתיבה זו יש שדה יחיד – "כותרת הדף", שבו ניתן להזין שם של ערך או דף בו התבנית נמצאת בשימוש ולראות כיצד השינוי שנעשה בה משתקף ומשפיע על הדף.
- למידע נוסף והוראות שימוש גם בכלי השני, ראו בדף הערך המורחב: "עזרה:ארגז חול לתבניות".
טבלאות
- ערך מורחב – עזרה:טבלאות
פעמים רבות, יש צורך ליצור טבלה בתוך תבנית, אך לעיתים, יש גם צורך להסתיר את התאים שאינם בשימוש. לפני קריאת פרק זה, מומלץ להכיר כיצד לבנות טבלאות בשפת ויקי.
| {{{שם הסרט}}} | |
|---|---|
| ז'אנר | {{{ז'אנר}}} |
| אורך | {{{אורך}}} |
| תאריך השקה | {{{תאריך השקה}}} |
| {{{אתר אינטרנט}}} | |
הטבלה משתמשת בשני אמצעים עיקריים: בתבנית {{!}}, שמציגה קו אנכי (|) ובמשפט תנאי מסוג {{#תנאי:הפרמטר לבדיקה|מה לכתוב אם הפרמטר קיים|מה לכתוב אם הפרמטר אינו קיים}} (ראו סעיף "בדיקת קיום פרמטר").
נמחיש כיצד לבנות טבלה מסודרת באמצעות דוגמה: אנו מעוניינים ליצור את הטבלה שמשמאל עבור ערכי סרטים. כפי שניתן לראות, כל התאים בטבלה זו מוצגים. כעת נשנה את כל הפרמטרים, מלבד הפרמטר "שם הסרט", כך שאם יהיו ריקים, לא תוצג השורה שלהם כלל.
• עבור כל שורה שבה שתי עמודות, יש להשתמש בקוד הבא:
{{#תנאי:{{{פרמטר|<noinclude>-</noinclude>}}} |{{!}} פרמטר{{!}} {{{פרמטר}}}{{!}}-}}
כאשר את הכיתוב "פרמטר" יש לשנות לשם הפרמטר.
• בשורה האחרונה, עם הפרמטר "אתר אינטרנט", ישנה עמודה אחת בלבד, שתוכנה מיושר לאמצע. עבור שורות מסוג זה, נשתמש בקוד הבא:
{{#תנאי:{{{פרמטר|<noinclude>-</noinclude>}}} |{{!}} colspan="2" סגנון {{!}} {{{פרמטר}}}{{!}}-}}
כאשר את הכיתוב "פרמטר" יש לשנות לשם הפרמטר, ואת הכיתוב "סגנון" יש להחליף בסגנון הרצוי; במקרה שלנו - יישור לאמצע.
• לבסוף, לגבי הפרמטר הראשון, נשתמש בברירת המחדל, כך שאם לא ניתן שם הסרט, נשתמש בשם הערך במקום. הקוד המלא לדוגמה זו ותוצאותו, להלן:
|
| ||||||||||
אם תשתמשו בקוד זה בתוך תבנית, ולאחר מכן תשתמשו בתבנית זו, תראו כי אם לא תמלאו את הפרמטרים "ז'אנר", "אורך", "תאריך השקה" ו"אתר אינטרנט", לא תוצג השורה שלהם. דוגמה "חיה" לשימוש זה ניתן למצוא בתבנית {{סרט}}. שימו לב, שבתבנית זו נעשה שימוש בסגנונות בכל התאים (לכל התאים יש גבול עליון מקווקו).
בדיקת הפרמטרים
- ערך מורחב – המכלול:מערכת בדיקת פרמטרים
המכלול:מערכת בדיקת פרמטרים מאפשרת להוסיף לתבנית תיאור של הפרמטרים שהיא מצפה לקבל, ובדרך זו לאתר שימוש שגוי בתבנית (מספר לא נכון של פרמטרים, השמטה של פרמטר שחובה לדווחו ועוד).
עדכוני תבניות, קטגוריות ודפים מקושרים
לעיתים, כשמעדכנים תבניות, עלולות לקרות שלוש תקלות:
- התבניות, בעיקר אם הן תבניות המוכללות בתבניות, לא מתעדכנות.
- הדף מופיע בקטגוריות שהוא הוסר מהן.
- הדף מופיע בדפים המקושרים לדף, או לתמונה, שהקישור אליהם הוסר מהתבנית. דבר זה גם גורם לכך שאי אפשר לדעת עד כמה באמת משתמשים בתמונות מיושנות, כגון Stop hand.png.
הבעיה נגרמת כתוצאה מחוסר עדכון של הרשימות הנחוצות.
היא תיפתר לאחר שתתבצע עריכה נוספת של הדף, ואם אתם לא רוצים לחכות, פתחו את דף העריכה, אל תשנו כלום בטקסט ושלחו אותו. השינוי שלכם לא אמור להופיע בהיסטוריית הדף, אך הוא כן אמור לתקן את הבעיה. ואם תהיה בעיה, מקסימום תשחזרו (או אחרים ישחזרו) את עריכתכם, אך הערך ממילא יתעדכן.
תיעוד תבנית
חלק בלתי נפרד מיצירת תבנית הוא התיעוד שלה, שכן ללא תיעוד, לא ידעו כיצד להשתמש בה. בעיה זו מחריפה ככל שהתבנית יותר מורכבת (בדרך כלל, בהתאם למספר הפרמטרים שבה). אם נתקלתם בתבנית ללא תיעוד, ניתן לשאול בדף השיחה של התבנית או לפנות אל יוצר התבנית (חפשו את שמו בדף "גרסאות קודמות") בבקשה שיכתוב תיעוד.
התיעוד נחלק לתיעוד עבור המתכנת, המסביר את הקוד ומשולב בתוכו כהערות מוסתרות (ראו סעיף "הערה מוסתרת בתבנית") ותיעוד עבור המשתמש ("הפשוט") בתבנית, המתאר ומדגים דרכים שונות להשתמש בה.
את ההסבר לאופן השימוש בתבנית ניתן להכניס בדף התבנית עצמו, כאשר דואגים כי כל התוכן לא יופיע בדפים שבהם ישלבו את התבנית (ראו סעיף "תכנים שיופיעו בדף התבנית בלבד"). רצוי לא לרשום את ההסבר בדף השיחה של התבנית. פרקטיקה מקובלת נוספת היא לרשום את ההסבר בדף משנה לדף התבנית ולשלב את תוכנו בדף התבנית על ידי שילוב דף המשנה:
<noinclude>{{תבנית:שם התבנית/שם דף המשנה}}</noinclude>
כחלק מההסבר, ניתן לעשות שימוש בתגיות "<code>" ו-"<nowiki>" (חפשו מידע בדף "עזרה:תחביר ויקי") כדי להדגים דרכים שונות להשתמש בתבנית, כפי שנעשה בדף זה. ניתן להיעזר גם בתבנית {{אופן השימוש}}.
אפשרות נוספת היא לעשות שימוש בתבניות {{תיעוד}} או {{תיעוד תבנית}}, הדורשות רישום התיעוד בדף משנה ששמו "תיעוד".
המלצה: פרקטיקה מקובלת היא לכתוב את התיעוד והוראות השימוש אחרי הקוד הטכני של התבנית עצמה.
כדי להקל על המשתמשים בשימוש בתבנית, מומלץ להתאימה לשימוש ב"אשף התבניות" המציג הנחיות למילוי התבנית בחלון קופץ
תבנית שהותאמה לשימוש בבוקמרקלטים מומלץ לעדכן בתיעוד על כך באמצעות התבנית {{יש בוקמרקלט}}, וכך גם לעודד את השימוש בבוקמרקלטים
ראו גם
- עזרה:ארגז חול לתבניות
- המכלול:תבנית
- המכלול:רשימת תבניות
- עזרה:אשף התבניות
- עזרה:מילות מפתח
- עזרה:הוראות תנאי
- המכלול:תבנית/אולם דיונים
- תבנית:קטגוריה בתבנית
- המכלול:מגבלות המפענח
קישורים חיצוניים
- תבניות לטיפול במחרוזות, דף בויקיפדיה האנגלית. חלק מתבניות אלה נמצא גם במכלול (בקטגוריה:תבניות לעיבוד מחרוזות).
