המכלול:מוסטער
א מוסטער (אין ענגליש: Template; אין העברעאיש: תבנית) איז א וויקי שפראך מעטאד וואס ערמעגליכט צו צייגן איין בלאט אין א צווייטן בלאט, אן דארפן קאפירן פון אנדערע בלעטער. א מוסטער איז א בלאט געשריבן אין (וויקי סינטאקס), וואס מען קען "אריינפלעכטן" אין יעדן בלאט אין המכלול, און ווערט פארגעשטעלט אין עכטע צייט. זיך באניצן מיט א מוסטער צענטראליזירט טעקסט אין איין פלאץ, פארמיידט דאפלטן, פארגרינגערט אויסצופירן אפדעיטס און רעדאגירונגען אויף פילע בלעטער אויפאמאל און היט אויף איינהייטליכקייט אין די המכלול בלעטער.
די באניץ פון דעם מעטאד איז ענליך צו שאפן א לינק, אבער אנשטאט לייגן צוויי פּאָר געקעסטלטע קלאמערן (brackets) ביידע זייטן פונעם ווארט ([[ און ]]) באניצט מען זיך מיט צוויי פּאָר געקרייזלטע קלאמערן (curly brackets) ({{ און }}). מען קען גראדע קאפירן מיט דעם מעטאד די אינהאלט פון סיי וועלכע בלאט אין יעדע געביט, אבער געווענליך וועט מען קאפירן פון די "מוסטער" געביט, וואס איז געווידמעט ספעציעל פאר דעם. די פאלגענדע אנווייזונגען זענען באזירט אויפ'ן באניץ מיט דעם געביט. לגבי זיך באניצן מיט דעם מעטאד פאר אנדערע סארט בלעטער זעט שפעטער.
שאפן א פרישע מוסטער
פאסט אויף: אויף צו שאפן א פרישע מוסטער אין מכלול אדער מאכן אן ערנסטע טויש ביי אן עקזיסטירנדע מוסטער דינט דער המכלול:מוסטער/דיסקוסיע זאל. איידער'ן עפענען א דיסקוסיע, איז כדאי זיך צו באראָטן איבערן מעגליכקייט אז אזא מוסטער עקזיסטירט שוין אדער די געברויך פאר א נייע אין המכלול:הילף טישל.
טעכנישע ערקלערונג
- שאפן א מוסטער
- א מוסטער איז איינס פון די סארטן בלעטער פארהאן אין מכלול: צו שאפן א פרישע מוסטער, שאפט מען א פרישע בלאט און דערין לייגט מען אריין די אינהאלט פונעם מוסטער (זעט אנווייזונגען אין לינק). מוסטערן געהערן אין די "מוסטער:" געביט, ד.ה. אז מען דארף שרייבן אינעם זוך קעסטל "מוסטער:נאמען פון נייע מוסטער" און טון די איבריגע שטאפלען ווי עס שטייט אין לינק.
- אריינשטעלן מוסטער אין ארטיקל
- אין יעדע בלאט וואו איר ווילט אריינפלייגן די (אינהאלט פונעם) מוסטער, שרייבט די טעקסט
{{נאמען פון מוסטער}}וואו עס זאל ווערן אריינגעפלאכטן. די אינהאלט וואס איר האט אריינגעלייגט אין די מוסטער וועט ארויפקומען ביי "זעט אויסקוק" אדער נאכ'ן פובליצירן דעם בלאט.
ביישפיל:
אויב וויל מען זיך באניצן מיט א מוסטער "ניי" – גייט מען צו יעדעס פלאץ מען וויל האבן דעם מוסטער, און מען שרייבט די טעקסט: {{ניי}}
וויבאלד אזא מוסטער עקזיסטירט נישט, וועט איר באקומען די פאלגענדע רעזולטאט:
מוסטער:ניי
דרוקן דעם לינק וועט עפענען א רעדאגירן בלאט צו שאפן א מוסטער מיט'ן נאמען "ניי".
ריכטליניעס ביים בויען מוסטערן
- צו שאפן א פרישע מוסטער אין מכלול אדער צו מאכן אן ערנסטע טויש אין אן עקזיסטירנדע דינט דער "המכלול:מוסטער/דיסקוסיע זאל" בלאט.
- איידער'ן עפענען א דיסקוסיע, איז רעקאמענדירט זיך צו צו באראָטן איבערן עקזיסטענץ פון אזא מוסטער אדער א געברויך פאר א פרישע מוסטער אין "המכלול:דיסקוסיע זאל".
- אין פּרינציפּ, וועלן נאוויגאציע מוסטערן ארויסגעלייגט ווערן צום בלעטער געביט נאר אויב דאס פארגרינגערט טאקע נאוויגעציע, דערפאר וועט א מוסטער וואס האט ווייניגער פון 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>" (חפשו מידע בדף "עזרה:תחביר ויקי") כדי להדגים דרכים שונות להשתמש בתבנית, כפי שנעשה בדף זה. ניתן להיעזר גם בתבנית {{אופן השימוש}}.
אפשרות נוספת היא לעשות שימוש בתבניות {{תיעוד}} או {{תיעוד תבנית}}, הדורשות רישום התיעוד בדף משנה ששמו "תיעוד".
המלצה: פרקטיקה מקובלת היא לכתוב את התיעוד והוראות השימוש אחרי הקוד הטכני של התבנית עצמה.
כדי להקל על המשתמשים בשימוש בתבנית, מומלץ להתאימה לשימוש ב"אשף התבניות" המציג הנחיות למילוי התבנית בחלון קופץ
תבנית שהותאמה לשימוש בבוקמרקלטים מומלץ לעדכן בתיעוד על כך באמצעות התבנית {{יש בוקמרקלט}}, וכך גם לעודד את השימוש בבוקמרקלטים
ראו גם
קישורים חיצוניים
- תבניות לטיפול במחרוזות, דף בויקיפדיה האנגלית. חלק מתבניות אלה נמצא גם במכלול (בקאטעגאריע:תבניות לעיבוד מחרוזות).
cc-by-sa 3.0 ערלויבעניש • אריגינעלער בלאט • ביישטייערער