עזרה:תבניות

מתוך ויקיפדיה, האנציקלופדיה החופשית
קפיצה אל: ניווט, חיפוש

קיצור דרך: וק:עת

עריכת ערכים

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

השימוש בשיטה זו דומה ליצירת קישור, אך במקום להוסיף שני זוגות של סוגריים מרובעים משני צִדי המילה ([[ ו־]]) יש להשתמש בשני זוגות של סוגריים מסולסלים ({{ ו־}}). ניתן להעתיק בצורה זו את תוכנו של כל דף בכל מרחב שם, אך נהוג להעתיק דפים מתוך המרחב "תבנית:", שנוצר לשם כך. ההסברים שלהלן מתבססים על שימוש במרחב שם זה. לגבי שימוש בשיטה זו לדפים מסוגים אחרים ראו בהמשך.

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

יצירת תבנית חדשה[עריכת קוד מקור | עריכה]

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

{{שם התבנית הרצויה}}

או:

[[תבנית:שם התבנית הרצויה]]

כאשר במקום "שם התבנית הרצויה" יש לכתוב את שם התבנית (לדוגמה: "חדש"). רצוי שהשם יהיה בעברית.

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

תבנית:שם התבנית הרצויה

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

דוגמה[עריכת קוד מקור | עריכה]

אם רוצים לכתוב תבנית תחת השם "חדש" יש לכתוב:

[[תבנית:חדש]]

לאחר הכתיבה מקבלים את התוצאה הבאה:

תבנית:חדש

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

בכל מקום בו יש להוסיף את תבנית, יש לכתוב את הטקסט:

{{חדש}}.

לאחר יצירת התבנית[עריכת קוד מקור | עריכה]

לאחר יצירת התבנית יש ליצור תיעוד כראוי על מנת להקל על השימוש בה-להרחבה, ראה סעיף בהמשך.

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

דרכים שונות להוספת תבנית אל דף וקישור אליה[עריכת קוד מקור | עריכה]

קישור מהצורה {{שם התבנית הרצויה}} ישתיל את תוכן התבנית בדף בעוד קישור מהצורה [[תבנית:שם התבנית הרצויה]] יוביל לדף התבנית.

העתקת קוד המקור של התבנית[עריכת קוד מקור | עריכה]

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

{{ס:@}}

והתוצאה תיראה כך:

-at-

והקוד, בזמן עריכה, ייראה כך:

[[file:@@@.svg| -at- |link=|13px]]

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

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

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

השם הלועזי המקורי של ס: הוא subst:.

השוואה[עריכת קוד מקור | עריכה]

להלן השוואה בין תבנית רגילה, ו-"ס:".

צורת הכתיבה תצוגה בגלישה מבט אל דף העריכה

{{אחרי התנגשות}}

הוספתי לאחר התנגשות עריכה -

{{אחרי התנגשות}}

{{ס:אחרי התנגשות}}

הוספתי לאחר התנגשות עריכה -

<span style="font-size: 75%">הוספתי לאחר התנגשות עריכה -</span>

דפי הפניה[עריכת קוד מקור | עריכה]

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

התייחסות לדף רגיל כאל תבנית[עריכת קוד מקור | עריכה]

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

{{:שם ערך}}

אם, לדוגמה, ברצונכם להעתיק את כל תוכן הערך עברית לדף מסוים, כתבו בדף היעד את הטקסט:

{{:עברית}}

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

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

{{ויקיפדיה:דלפק יעוץ}}

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

גם במקרה של שימוש כזה בתבניות ניתן להשתמש ב־"ס:" ובפרמטרים.

עריכת תבנית[עריכת קוד מקור | עריכה]

ניתן לערוך תבנית קיימת על ידי איתור דף התבנית ולחיצה על "עריכה" בראש הדף, כמו כל דף הפתוח לעריכה בויקיפדיה.

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

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

סימנים מיוחדים[עריכת קוד מקור | עריכה]

סימנים אחדים יש צורך לכתוב בצורה מיוחדת כדי שיופיעו בתבנית.

הסימן אופן כתיבתו בתבנית
 :
&#58;
 ;
&#59;
*
&#42;
#
&#35;

הסימן | מפריד בין פרמטרים בתבנית. כאשר יש לתת סימן זה בתוך פרמטר, יש לכתוב במקומו {{!}}. דוגמה: כדי לכלול בתבנית את הטקסט "האולימפיאדה || מדליית זהב לספורטאי ישראלי" יש לכתוב "האולימפיאדה {{!}}{{!}} מדליית זהב לספורטאי ישראלי".

הגדרת פרמטרים לתבנית[עריכת קוד מקור | עריכה]

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

פרמטר שמי[עריכת קוד מקור | עריכה]

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

{{{פרמטר1}}}

השימוש בפרמטר בדף היעד ייעשה על פי הסדר הבא:

  • שם התבנית
  • תו מפריד (|)
  • שם הפרמטר
  • הסימן =
  • ערך הפרמטר.

תחביר לדוגמה:

{{שם תבנית|פרמטר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" כאל המידע שמוזן לו. כדי לעקוף בעיה זו, ניתן להזין את הקוד הבא במקום סימני שווה:

&#61;

לחלופין, ניתן להתייחס לפרמטר המספרי כאילו היה פרמטר שמי, ולציינו במפורש בעת השימוש בתבנית: {{חדש|פרפר.jpg|‏2=משפחת הפרפרים = butterfly family}}

בעיה זו נמנעת אם מגדירים את התבנית מלכתחילה עם פרמטרים שמיים. כלומר, התבנית {{חדש|תמונה=פרפר.jpg|שם=משפחת הפרפרים = butterfly family}} תעבוד מצוין.

ניתן "לערבב" בתבנית אחת את הפרמטרים מסוג שם ומסוג מספר ביחד.

שינויי פרמטרים בתבנית קיימת[עריכת קוד מקור | עריכה]

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

כדאי לתת על כך את הדעת בזמן שמשנים את התבנית ובכך ניתן למנוע את הבעיה לפני שנוצרה.

הגדרת ברירת מחדל לפרמטר[עריכת קוד מקור | עריכה]

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

{{{שם הסרט|טקסט ברירת מחדל}}}

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

{{{שם הסרט| {{שם הדף בלי הסוגריים|}} }}}

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

בדיקת קיום פרמטר[עריכת קוד מקור | עריכה]

בכדי לבדוק האם לתבנית הוזן פרמטר, ניתן לעשות בדיקה באמצעות משפט תנאי הבא:

{{#if: {{{param|}}} | Hooray...! | Darn...! }}

תוצאה:Darn...!

או בעברית

{{#תנאי: {{{פרמטר|}}} | יש ערך...! | אין ערך...! }}

תוצאה: אין ערך...!

בפרמטר הראשון מקבלים את התוצאה כאשר יש ערך, ובפרמטר השני כאשר אין ערך.

הערה מוסתרת בתבנית[עריכת קוד מקור | עריכה]

בתבנית מסובכת רצוי לשבץ הערות, שיסבירו למתכנת המתחזק את התבנית מה עושה קטע מסוים. כתיבת הערה תיעשה באופן הבא:
<noinclude><!-- טקסט ההערה --></noinclude>

תכנים שיופיעו בתבנית בלבד או שיופיעו רק בדפים המכילים את התבנית[עריכת קוד מקור | עריכה]

לעתים יש צורך שתוכן מסוים יוצג בתבנית בלבד, ולא בדפים המכילים אותה (כגון הסברים לשימוש בתבנית, הקטגוריה של התבנית, קישורי בינוויקי, או הצבעת מחיקה על תבנית). במקרים אלו יש להשתמש בתג <noinclude> באופן הבא:

<noinclude>תוכן שמופיע בתבנית בלבד, ולא בדפים המכילים אותה.</noinclude>

לעתים מעוניינים במצב ההפוך; שתוכן יוצג או יוכלל בדפים המכילים את התבנית, אך לא בתבנית עצמה (למשל, קטגוריות תחזוקה-אין צורך שהתבנית תופיע ברשימת הדפים שיש לתחזק, אלא רק הדפים שבהם היא נוספה). במקרים אלו יש להשתמש בתג <includeonly> באופן הבא:

<includeonly>תוכן שלא מופיע בתבנית, אבל מופיע בדפים המכילים אותה.</includeonly>

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

טבלאות[עריכת קוד מקור | עריכה]

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

{{{שם הסרט}}}
ז'אנר {{{ז'אנר}}}
אורך {{{אורך}}}
תאריך השקה {{{תאריך השקה}}}
{{{אתר אינטרנט}}}

הטבלה משתמשת בשני אמצעים עיקריים: בתבנית {{!}}, שמציגה קו אנכי (|) ובהוראת תנאי מסוג {{#תנאי:הפרמטר לבדיקה|מה לכתוב אם הפרמטר קיים|מה לכתוב אם הפרמטר אינו קיים}}. נמחיש כיצד לבנות טבלה מסודרת באמצעות דוגמה: אנו מעוניינים ליצור את הטבלה שמשמאל עבור ערכי סרטים. כפי שניתן לראות, כל התאים בטבלה זו מוצגים. כעת נשנה את כל הפרמטרים, מלבד הפרמטר "שם הסרט", כך שאם יהיו ריקים, לא תוצג השורה שלהם כלל.

עבור כל שורה שבה שתי עמודות, יש להשתמש בקוד הבא:

{{#תנאי:{{{פרמטר|<noinclude>-</noinclude>}}} |
{{!}} פרמטר
{{!}} {{{פרמטר}}}
{{!}}-
}}

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

{{#תנאי:{{{פרמטר|<noinclude>-</noinclude>}}} |
{{!}} colspan="2" סגנון {{!}} {{{פרמטר}}}
{{!}}-
}}

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

{| class="wikitable" align="left"
! colspan="2" | {{{שם הסרט| {{שם הדף}} }}}
{{!}}-
{{#תנאי:{{{ז'אנר|<noinclude>-</noinclude>}}} |
{{!}} ז'אנר
{{!}} {{{ז'אנר}}}
{{!}}-
}}
{{#תנאי:{{{אורך|<noinclude>-</noinclude>}}} |
{{!}} אורך
{{!}} {{{אורך}}}
{{!}}-
}}
{{#תנאי:{{{תאריך השקה|<noinclude>-</noinclude>}}} |
{{!}} תאריך השקה
{{!}} {{{תאריך השקה}}}
{{!}}-
}}
{{#תנאי:{{{אתר אינטרנט|<noinclude>-</noinclude>}}} |
{{!}} colspan="2" style="text-align: center;" {{!}} {{{אתר אינטרנט}}}
}}
|}
תבניות
ז'אנר {{{ז'אנר}}}
אורך {{{אורך}}}
תאריך השקה {{{תאריך השקה}}}
{{{אתר אינטרנט}}}

אם תשתמשו בקוד זה בתוך תבנית, ולאחר מכן תשתמשו בתבנית זו, תראו כי אם לא תמלאו את הפרמטרים "ז'אנר", "אורך", "תאריך השקה" ו"אתר אינטרנט", לא תוצג השורה שלהם. דוגמה "חיה" לשימוש זה ניתן למצוא בתבנית {{סרט}}. שימו לב שבתבנית זו סגנונות בכל התאים שלו (לכל התאים יש גבול עליון מקווקו).

תיעוד תבנית[עריכת קוד מקור | עריכה]

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

התיעוד נחלק לתיעוד עבור המתכנת, המסביר את הקוד ומשולב בתוכו כהערות מוסתרות (ראה סעיף רלוונטי) ותיעוד עבור המשתמש בתבנית, המתאר דרכים שונות להשתמש בה.

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

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

אפשרות נוספת היא לעשות שימוש בתבניות {{תיעוד}} או {{תיעוד תבנית}}, הדורשות רישום התיעוד בדף משנה ששמו "תיעוד".

כדי להקל על המשתמשים בתבנית, מומלץ להתאימה לשימוש באשף התבניות. להרחבה בנושא יש לעבור לדף עזרה:אשף התבניות.

ראו גם[עריכת קוד מקור | עריכה]