Help:TemplateData/he
![]() |
הערה: כאשר אתם עורכים דף זה, אתם מסכימים לשחרר את תרומתכם תחת רישיון CC0. למידע נוסף ראו את דפי העזרה בנושא נחלת הכלל. | ![]() |
TemplateData הוא דרך לשמור מידע על תבנית ויקי והפרמטרים שלה, כך שהעורך החזותי יוכל להציג אותה בעורך התבניות -- ובכך להקל על עריכת הדפים המשתמשים בתבנית הזאת. It also provides a user interface for discovering templates .
החל מאפריל 2019, "נתוני תבנית" היא ברירת מחדל עבור כלל משתמשי ויקי מדיה כאשר הם מוסיפים תבנית, אפילו משתמשים לא רשומים. נתוני תבנית משתלב הן בעריכת קוד מקור והן בעריכה חזותית בצורה כזו או אחרת, וכך גם סקריפטים, כלים וגאדג'טים רבים. אם אתה מעוניין באפשרות הזו בשביל הויקי שלך, התקן את Extension:TemplateData .
הוספת נתוני תבנית לתבנית לשימוש בהרחבה זו כרוכה בהכנסת בלוק קטן ופשוט של JSON (הסבר להלן) לדף התיעוד של התבנית.
ניתן לעשות זאת באופן ידני או באמצעות עורך נתוני התבניות, ממשק משתמש גרפי שניתן לגשת אליו בדפי עריכה
/עריכת קוד מקור
של תבנית באתרי ויקי כאשר ההרחבה TemplateData מותקנת.
קובץ ה-JSON מכיל רשימה של פרמטרי התבנית ומידע על פרמטרים אלה ועל התבנית כולה (ראה פרטים בהמשך).
תבניות המכילות נתוני תבנית יציגו מידע זה בממשק המשתמש כאשר משתמש מוסיף את התבנית. במקרים מסוימים, הדבר ישנה את אופן הפעולה של העורך בעת שימוש בו לעריכה או הוספה של תבנית נתונה, מה שיקל מאוד על המשתמשים לבצע את השלבים הדרושים להוספת תבנית נתונה.
היסטוריה
נתוני התבנית פותחו במקור בתחילת 2013 תוך מחשבה על VisualEditor , אשר היה בשלבי בדיקה של מדיה-ויקי באותה תקופה. העורך החזותי הוא ממשק העריכה החזותית העיקרי עבור אתרי ויקי של ויקימדיה, ונתוני התבניות מאפשרים לו ממשק שימושי יותר בעת הוספת תבניות. הוא נתמך באופן רשמי על ידי העורך החזותי מיידית. כאשר העורך הוויזואלי הוכנס לאתרי הויקי העיקריים השונים של ויקימדיה כתכונה ברירת מחדל בין השנים 2013 ל-2016, גם נתוני התבניות הפכו לחלק מהם.
בדצמבר 2016, ממשק העורך הוויזואלי הועמד לרשות עריכת קוד מקור כגרסת בטא. זה כונה כעורך קוד מקור 2017 . זה הביא את התכונות של נתוני תבנית לעריכת מקורות בפעם הראשונה.
במרץ 2018, סם וילסון פיתח את TemplateWizard , הרחבת עורך תבניות ממשק משתמש גרפי (GUI) עבור עורך המקורות המוגדר כברירת מחדל של ויקימדיה, WikiEditor (הידוע גם כעורך ויקיטקסט משנת 2010), שנועד להקל על תהליך הוספת התבניות באמצעות מידע מנתוני התבניות. באפריל 2019, TemplateWizard הפך לחלק ברירת מחדל בעורך הטקסט של ויקימדיה משנת 2010 בכל אתרי הויקי של ויקימדיה. משמעות הדבר היא שנתוני התבנית הפכו כעת לחלק ברירת מחדל הן בעורך הוויזואלי והן בעורך המקור באתרי ויקי של ויקימדיה.
הוספה או עריכה של נתוני תבנית
כדי להוסיף או לערוך נתוני תבנית, ראשית נווטו לדף של תבנית, הממוקם ב-"/Template:Templatename".
בדיקת המצב הנוכחי
לפני הוספה או עריכה של נתוני תבנית, בדוק האם לתבנית יש דף משנה של תיעוד. לאחר מכן, בדוק האם התבנית כבר מכילה נתוני תבנית, ואם כן, האם היא ממוקמת בדף התבנית או בדף המשנה של התיעוד.
דפי משנה של תיעוד
ישנן שתי דרכים עיקריות בהן תבניות ברוב אתרי הויקי של ויקימדיה מאחסנות את הערות השימוש שלהן ונתונים אחרים שלא צריכים להיכלל בתבנית עצמה, כמו קטגוריות שהתבנית צריכה להיכלל בהן:
- הרוב המכריע של התבניות שומרות הערות שימוש ונתונים אחרים שאינם שייכים לדף התבנית עצמו בדף משנה של תיעוד: "/Template:Templatename/doc". בדפים כאלה, התבנית {{Documentation}} כוללת את כל תוכן הדף /doc בדף התבנית, מה ששומר על קוד המקור של התבנית נקי הרבה יותר.
- מספר דפי תבנית שמרו על מידע זה בדף הראשי של התבנית. ניתן לאתר זאת בדפים אלה על ידי חיפוש הופעה של
{{Documentation|content=
בין תגיות<noinclude>
.
אתרי ויקי שונים עשויים להציג את כל זה בצורה שונה.
לעתים רחוקות, דפי תבנית ראשיים עדיין עשויים להכיל תיעוד גם לאחר שבדקתם את כל האמור לעיל;
כאן, משתמש יוסיף כותרת דף /doc מותאמת אישית בין "{{Documentation|
" ל-"|content=
" ולאחר מכן יוסיף תוכן אחרי "|content=
".
ניתן גם לחפש הודעה בתחתית העמוד בדומה לזו: "התיעוד הנ"ל כלול ב-Template:Templatename/doc".
תבניות ללא דפי משנה של תיעוד
אם לתבנית אין דף משנה של תיעוד, צור אותה והעבר לשם את תיעוד התבנית (או מציין מיקום עבורה). לאחר מכן תוכל להוסיף נתוני תבנית לדף המשנה של התיעוד.
יצירת דף המשנה והעברת התיעוד
כדי ליצור את דף המשנה של התיעוד, לחצו על עריכה
/עריכת קוד מקור
בדף התבנית הראשי; חפשו את התגים <noinclude>
ואת תוכנם (בדרך כלל בתחתית).
זה אמור להיראות בערך כך:
<noinclude>
{{Documentation|content=
== שימוש ==
מידע על השימוש.
== כותרות נוספות לדוגמה ==
תוכן נוסף לדוגמה
[[קטגוריה:קטגוריית דוגמה]]
[[קטגוריה:קטגוריית דוגמה 2]]
}}
</noinclude>
ייתכן שתגלה שהוא כבר מכיל נתוני תבנית. אם כן, זה ייראה בערך כך:
<noinclude>
{{Documentation|content=
...
<templatedata>
{
"description": "",
"params": {
"1": {
"label": "פרמטר לדוגמה",
"description": "תיאור פרמטר לדוגמה",
"type": "string"
}
}
}
</templatedata>
</noinclude>
בחר את כל מה שאחרי "|content=
" ולפני "</noinclude>
" וגזור אותו ללוח או שמור אותו במסמך זמני. מחק את "|content=
", והשאיר רק את הדברים הבאים:
<noinclude>
{{Documentation}}
</noinclude>
שמור את דף התבנית.
כעת, כדי ליצור את דף המשנה החדש, עיין בשורת הכתובת של הדפדפן שלך והוסף /doc לסוף כתובת ה-URL. לחץ על ↵ Enter, לאחר מכן בחר באפשרות ליצור דף חדש.
אם לויקי הזה יש תבנית הודעה של {{Documentation subpage}}, הוסף אותה בראש הדף החדש. ייתכן שתרצו גם להוסיף תבניות אחרות, כגון קישור {{Purge button}} או {{Purge}} (אם נתמך על ידי הויקי המדובר).
הכנס את הטקסט שגזרת או שמרת בטקסט הקודם (מתחת לתבנית ההודעה, אם רלוונטי).
עטוף כל קטגוריה בתגיות <includeonly>
כך שהן יחולו רק על הדף הראשי של התבנית:
<includeonly>
[[Category:Example category]]
[[Category:Example category 2]]
</includeonly>
להרבה אתרי ויקי יש תבניות {{Sandbox other}}
.
השתמש בתבנית זו כאן אם סביר להניח שהתבנית שאתה עורך קיימת בגרסת ארגז חול (הנמצאת ב-"Template:Templatename/sandbox") על מנת למנוע מהקטגוריות להחיל על דף ארגז החול:
<includeonly>{{sandbox other||
[[Category:Example category]]
[[Category:Example category 2]]
}}</includeonly>
לבסוף, פרסמו את הדף.
כעת ניתן להוסיף ולערוך את נתוני התבנית בדף המשנה של התיעוד באמצעות ההוראות המתוארות ב-#גישות.
הוספה ועריכה של נתוני תבנית בדף התבנית הראשי
אם אינך מצליח ליצור את דף /doc, תוכל להוסיף ולערוך נתוני תבנית בדף הראשי של התבנית על ידי ביצוע ההוראות ב-#גישות.
אם לתבנית יש דף משנה של תיעוד, בדקו גם את הדף הראשי וגם את דף המשנה של התיעוד לאיתור נוכחות של נתוני תבנית (התג <templatedata>
ואחריו מערך בתוך סוגריים מסולסלים: {}
).
לחלופין, התוסף TemplateData יכול לבצע בדיקה זו עבורך.
לחץ על עריכה
או עריכת קוד מקור
בכל אחד מהדפים.
אם לתבנית כבר יש נתוני תבנית באחד מהדפים, תראו הודעה צהובה בראש הדף שתציין אחת מהאפשרויות הבאות:
- לתשומת ליבך: כבר יש בלוק נתוני תבנית בדף הקשור "Template:Templatename/doc".
או
- לתשומת ליבך: כבר יש בלוק נתוני תבנית בדף הקשור "Template:Templatename".
אם לתבנית יש נתוני תבנית בדף המשנה של התיעוד שלה
אם לתבנית יש נתוני תבנית בדף המשנה של התיעוד שלה, זהו הדף שעליך לערוך.
ניתן לעשות זאת על ידי לחיצה על "[עריכה]" הממוקם לאחר הכותרת " תיעוד תבנית" (או כדומה), או, אם אתם כבר בדף /doc, על ידי לחיצה על
עריכה
או עריכת קוד מקור
בחלק העליון.
פעל לפי ההנחיות ב#גישות כדי להוסיף או לערוך את נתוני התבנית.
אם לתבנית יש נתוני תבנית בדף הראשי שלה
אם לתבנית יש נתוני תבנית בדף הראשי שלה, שוב יש לך שתי אפשרויות:
- באפשרותך לעבור לדף המשנה של התיעוד שלו. זוהי האפשרות המועדפת.
- לחלופין, ניתן לערוך אותו בדף התבנית הראשי.
העברת נתוני תבנית לדף המשנה של התיעוד
לשם כך, לחצו על עריכה
/עריכת קוד מקור
בדף התבנית הראשי, וחפשו את התגים <templatedata>
, המוקפים בתגים <noinclude>
.
זה אמור להיראות בערך כך:
<noinclude>
{{Documentation}}
<templatedata>
{
"description": "",
"params": {
"1": {
"label": "פרמטר לדוגמה",
"description": "תיאור פרמטר לדוגמה",
"type": "string"
}
}
}
</templatedata>
</noinclude>
גזור רק את התגיות <templatedata>
ואת תוכנן מהקוד, ולאחר מכן שמרו את הדף.
לאחר מכן, ערוך את דף המשנה של התיעוד על ידי לחיצה על "[עריכה]" הממוקם לאחר הכותרת " תיעוד תבנית" (או כדומה).
הקלד כותרת, כמו "נתוני תבנית", ולאחר מכן הדבק מתחתיה את נתוני התבנית.
כעת ניתן לערוך את נתוני התבנית בהתאם להנחיות ב-#גישות.
עריכת נתוני תבנית בדף התבנית הראשי
אם אינך מעוניין להעביר את נתוני התבנית לדף /doc, תוכל לערוך אותם בדף התבנית הראשי. ראה #גישות כיצד לערוך נתוני תבנית.
אם לתבנית עדיין אין נתוני תבנית אך יש לה דף משנה של מסמך
אם לתבנית עדיין אין נתוני תבנית, עליך להוסיף אותם לדף המשנה של התיעוד.
עשה זאת על ידי לחיצה על "[עריכה]" הממוקם לאחר הכותרת " תיעוד תבנית" (או כדומה), או, אם אתה כבר בדף /doc, על ידי לחיצה על
עריכה
או עריכת קוד מקור
בחלק העליון.
הקלד כותרת, כמו "נתוני תבנית", ולאחר מכן הוסף אותה מתחת לכותרת זו.
הסעיף #גישות מסביר כיצד להוסיף נתוני תבנית.
גישות
גישת עורך נתוני תבנית
זוהי דרך פשוטה להוסיף או לערוך נתוני תבנית, מומלצת למשתמשים פחות מנוסים.
עורך נתוני התבניות הוא ממשק משתמש גרפי להוספה ועריכה של נתוני תבניות.
זהו חלק מהרחבת TemplateData, הזמינה בכל דף של תבנית (או דף משנה של תיעוד) על ידי לחיצה על עריכה
או עריכת קוד מקור
.
לאחר לחיצה על עריכה
או עריכת קוד מקור
, תראה כפתור מעל אזור העריכה וכותרת הדף שאומר עריכת נתוני תבנית
.
לחיצה על הכפתור הזה תפתח את עריכת נתוני תבנית. אם הדף שבו אתה נמצא כבר מכיל נתוני תבנית, הוא יופיע כאן באופן אוטומטי.
תכונות בחלון למעלה:
- הפריט העליון בוחר את שפת טקסט הממשק. הוא מאפשר לך להזין תוכן טקסט במספר שפות, המוצג למשתמשים בהתבסס על ההגדרות שלהם בהעדפות, לא בהתבסס על שפת הויקי; לאתרי ויקי שונים יש מסדי נתונים של תבניות שונים לחלוטין. אם לא קיימים נתוני תבנית שפה, הממשק יציע למשתמשים רק את שפת הויקי, אך משתמשים יכולים ללחוץ על
הוספת שפה
כדי להוסיף קלט נוסף. קוד השפה מוצג בסוגריים לצד הפרמטרים שעליהם ניתן להחיל אותו, כגון תיאורים ותוויות. - הפריט הבא הוא תיאור התבנית. זהו תיאור התבנית כולה; הוא מוצג למשתמשים במקומות רבים בעורכי התבניות בעת הוספת תבנית. הפרמטר והשפעותיו מתועדות להלן.
- הפריט השלישי שולט בעיצוב הויקיטקסט של התבנית. פרמטר זה קובע כיצד ייערך הויקיטקסט כאשר המשתמש לוחץ על
החלה
, שני הסוגים העיקריים הם"inline"
(בשורה אחת) ו-"block"
(בשורות חדשות). פרמטר זה והשפעותיו מתועדים להלן.
- אם המשתמש בוחר באפשרות
מיוחד
, הוא יכול להזין טקסט ויקי תחתמחרוזת עיצוב מיוחד
בהתאם לכללי פורמטים מותאמים אישית המתועדים להלן, על מנת ליצור פריסה מותאמת אישית לתבנית כאשר המשתמש לוחץ עלהחלה
.
- הפריט הרביעי מגדיר את הפרמטרים של התבנית. אם פרמטרים כבר הוגדרו בנתוני התבנית, אזור זה מציג אותם ברשימה. אם קוד המקור של התבנית מציין פרמטרים שעבורם לא קיימים נתוני תבנית, ייתכן שתראה כפתור שכותרתו
הוספת 2 פרמטרים מוצעים
. העורך מחלץ את ההצעות הללו מקוד המקור של התבנית על ידי חיפוש אחר{{{parametername}}}
או{{{parametername|}}}
. לחיצה עלהוספת 2 פרמטרים מוצעים
תוסיף פרמטרים אלה באמצעות שמם כפי שהוגדרו בקוד המקור. הודעה ירוקה תופיע גם בחלק העליון, לדוגמה, "נוספו 2 פרמטרים חדשים: שמות של פרמטרים". - בתחתית החלון תראה כפתור של
הוספת פרמטר
. זה מאפשר לך להוסיף פרמטר באופן ידני עם שם מותאם אישית.
המשך לשלב הבא על ידי לחיצה על אחד מהפרמטרים ברשימה. פעולה זו תאפשר לך לערוך את פרטי הפרמטר.
כל התכונות הללו וההשפעות שלהן מפורטות בסעיף #בתוך שם הפרמטר.
- לחיצה על
הסרת המידע על הפרמטר
תמחק את הפרמטר וכל המידע שלו מנתוני התבנית. לא ניתן לאחזר או לבטל זאת בנתוני התבנית אלא אם כן תלחצו על "X" לאחר מכן. ניתן לבטל כל שינוי שבוצע לאחר לחיצה עלהחלה
על ידי לחיצה על Ctrl+Z. - יציאה מעורך נתוני התבנית לאחר ביצוע שינויים תבקש ממך לאשר שברצונך לבטל את השינויים שלך.
כשתסיים, לחץ על החלה
.
פעולה זו תוסיף אוטומטית את נתוני התבנית בתחתית העמוד לפני התג </noinclude>
; או, אם כבר קיים, הוא יעודכן במידע החדש מבלי לשנות את מיקומו.
טקסט נתוני התבנית ייבחר גם כן כשתלחצו על החלה
.
עורך נתוני התבנית יוצר פרמטר "paramOrder"
בתחתית נתוני התבנית (או מעדכן אותו אם הוא כבר קיים).
paramOrder
מכיל את פרמטרי נתוני התבנית הנוכחיים בסדר שבו הם הוצגו על ידי עורך נתוני התבנית.
ניתן לשנות את ה-paramOrder
על ידי גרירת הפרמטרים למעלה ולמטה בעורך נתוני התבנית באמצעות שלושת הפסים האופקיים משמאל.
paramOrder
והשפעותיו מתועדות להלן.
לאחר מכן, לחץ על שמירה
כדי לשמור את הגרסה שלך לדף.
הגישה הידנית
אתה יכול גם להוסיף או לערוך נתוני תבנית באופן ידני.
הקוד של נתוני התבנית כתוב ב-JSON, אבל לא חובה לדעת JSON בשביל ליצור נתוני תבנית.
נתוני התבנית פועלים לפי כמה כללים פשוטים מאוד ומקבלים רק כמה עשרות פרמטרים וערכים מוגדרים מראש, בדרך כלל בפורמט "parameter": "value"
.
הוספת נתוני תבנית באופן ידני
שיקולים:
- אם אתם מוסיפים נתוני תבנית לדף המשנה של התיעוד של תבנית (מומלץ), תוכלו להוסיף אותם בכל מקום בדף; בדקו אם בויקיפדיה בשפה שלכם יש מיקום מועדף עבורם. לדוגמה, בויקיפדיה האנגלית, נתוני התבנית נמצאים בדרך כלל בחלק התחתון של דף התיעוד; בויקיפדיה הגרמנית, הם בדרך כלל נמצאים בחלק העליון.
- אם אתם מוסיפים נתוני תבנית בדף הראשי של תבנית (לא מומלץ; ראו #בדיקות קודמות), עליכם לוודא שאתם ממקמים אותם בתוך התגים
<noinclude>...</noinclude>
.
לחץ על עריכה
או עריכת קוד מקור
בדף המתאים, לאחר מכן עבור למקום בדף שבו ברצונך להוסיף נתוני תבנית וכתוב כותרת: "נתוני תבנית".
אתרי ויקי רבים מציעים תבנית של {{TemplateData header}} שמוסיפה הודעה קצרה בנוגע לנתוני התבנית. אם בויקי שלכם יש הודעה כזו, הוסיפו אותה אחרי הכותרת.
כדי להתחיל להוסיף נתוני תבנית, הקלד תגית פתיחה וסגירה של <templatedata>
וזוג סוגריים מסולסלים בשורות חדשות, כאשר שורה ריקה ביניהם:
<templatedata>
{
}
</templatedata>
לאחר מכן, הוסף כניסה בשורה הריקה בין שני הסוגריים המסתלסלים, והתחל להוסיף פרמטרים. פרטים על הפרמטרים ניתן למצוא בכתובת #פרמטרים של נתוני תבנית. רובם אופציונליים; חלקם מומלצים מאוד.
הפרמטרים יכולים להיות בכל סדר, אך להלן הסדר המתאים ביותר לתיעוד נתוני התבנית והופך את התוכן לקל ביותר לשימוש עבור עורכים:
<templatedata>
{
"description": "",
"format": "",
"params": {
"parameter1": {
"aliases": ["",""]
"label": "",
"description": "",
"type": ""
}
},
"paramOrder": [
""
]
}
</templatedata>
ודא שהפרמטרים, לדוגמה, באובייקט "params"
, נשארים בתוך אותו אובייקט; אחרת תפעיל שגיאת "מאפיין בלתי־צפוי "propertyname"." כשתנסה לשמור.
לדוגמה
הנה כמה דוגמאות לנתוני תבנית עבור תבנית ניקוי היפותטית. תבנית כזו תציג הודעה ותמקם את הדף בקטגוריה מתוארכת בהתבסס על החודש והשנה שהוזנו. ההודעה עשויה להכיל גם קישור לקטע בדף שיחה. נתוני התבנית ייראו בערך כך:
<templatedata>
{
"description": "השתמש בתבנית זו כדי לציין שערך זקוק לניקוי.",
"format": "inline",
"params": {
"date": {
"label": "חודש ושנה",
"description": "החודש והשנה שבהם נוספה התבנית",
"type": "string",
"autovalue": "{{SUBST:CURRENTMONTHNAME}} {{SUBST:CURRENTYEAR}}",
"example": "ינואר 2013",
"suggested": true
},
"reason": {
"aliases": ["1"],
"label": "סיבה",
"description": "הסיבה שהערך זקוק לניקוי",
"type": "string"
},
"talk": {
"aliases": ["קטע שיחה"],
"label": "קטע בדף שיחה",
"description": "החלק של דף השיחה המכיל דיון רלוונטי",
"type": "string"
}
},
"paramOrder": [
"date",
"reason",
"talk"
]
}
</templatedata>
תיעוד נתוני התבנית המתאים יוצג כך:
השתמש בתבנית זו כדי לציין שערך זקוק לניקוי.
Parameter | Description | Type | Status | |
---|---|---|---|---|
חודש ושנה | תאריך | החודש והשנה שבהם נוספה התבנית
| String | suggested |
סיבה | סיבה 1 | הסיבה שהערך זקוק לניקוי | String | optional |
קטע בדף שיחה | שיחה קטע שיחה | החלק של דף השיחה המכיל דיון רלוונטי | String | optional |
פרמטרים של נתוני תבנית
כל פרמטרי נתוני התבנית הזמינים (כלומר, אלו שבין התגים <templatedata>...</templatedata>
של מקור הויקי) מפורטים להלן עם תיאור ודוגמה.
הם רשומים גם בפירוט טכני יותר ב-Extension:TemplateData#Format.
- מידע זה עדכני נכון לנובמבר 2021 ועשוי להשתנות אם יתווספו פרמטרים חדשים או שממשקי עריכת התבניות יקבלו עדכונים כדי לתמוך בפרמטרים קיימים או להתייחס לפרמטרים מסוימים בצורה שונה.
- סימון ויקי לא יעבוד בתיאורים או בתוויות. אלו מחרוזות טקסט רגילות לחלוטין.
- שורות חדשות ("
\n
") בתיאורים, תוויות, דוגמאות או ברירות מחדל לא יופיעו באף אחד מהעורכים הראשיים (TemplateWizard, העורך החזותי או עורך ה-wikitext משנת 2017), למרות שהן מופיעות בתיעוד נתוני התבנית שנוצר אוטומטית. הם מוחלפים במחרוזת null בטפסי קלט וברווח במקומות אחרים.
פרמטר | תיאור | דוגמה |
---|---|---|
description |
הפרמטר השפעות בדף תיעוד התבנית, התיאור יוצג בטקסט רגיל מתחת לכותרת המשנה "נתוני תבנית עבור [שם תבנית]". בכל העורכים הראשיים (VisualEditor , עורך קוד מקור 2017 ו-WikiEditor עם TemplateWizard), התיאור מופיע בשני מקרים עיקריים:
בעורך החזותי ובעורך הויקיטקסט משנת 2017, התיאור מקוצר לכ-50 תווים מתחת לכל הצעת חיפוש, ואחריו מופיע "...", אך התיאור המלא מוצג בחלון עורך התבניות הראשי. שניהם מוצגים בטקסט אפור. בחלון הראשי של עורך התבניות, תיאורים הארוכים מארבע שורות (כ-540 תווים) מקבלים פס גלילה נפרד, והם מוצגים בטקסט שחור. אם לא צוין אם פרמטר התיאור אינו קיים או לא צוין, הטקסט
|
"description": "תבנית לקישור לקטגוריה בויקישיתוף",
|
format |
הפרמטר פרמטר זה אינו חובה, אך מומלץ. אופן הפעולה המוגדר כברירת מחדל כאשר פרמטר זה אינו מסופק הוא שימור העיצוב הקיים עבור פרמטרים קיימים, או עיצוב מוטבע עבור פרמטרים ותבניות שנוספו לאחרונה. השפעות קו מוטבע: ( לאחר הוספת התבנית, היא תפרס את הטקסט הויקי שלה בשורה אחת ללא רווח לבן בין האלמנטים, כך:
בלוק: ( לאחר הוספת התבנית, היא תפזר את הפרמטרים שלה בשורה חדשה, עם רווחים בודדים בין כל אלמנט, כך: {{Foo | bar = baz | longparameter = quux }} עיצוב מותאם אישית: לחלופין, אם הפרמטר מוגדר למחרוזת ויקיטקסט מותאמת אישית, בהתאם לכללים המפורטים ב-#פורמטים מותאמים אישית, התבנית תעצב את ויקיטקסט שלה בהתאם לויקיטקסט הנתון. |
"format": "inline"
|
params |
האובייקט עליו להכיל את השם של כל פרמטר ואחריו קבוצה של תת-פרמטרים של נתוני תבנית המפורטים תחת #בתוך שם הפרמטר. אם יש פרמטרים מרובים, הצב פסיק בין לכל אובייקט פרמטר, אך אל תוסיף אחד אחרי הסוגר המתולתל האחרון (ראה דוגמה). |
"params": {
"parameter1": {
... // מידע על הפרמטרים
}, // פסיק כאן
"parameter2": {
... // מידע על הפרמטר
}, // וכאן
"parameter3": {
... // מידע על הפרמטר
} // אבל לא פה
}
|
paramOrder |
האובייקט איך להשתמש Add the parameter The parameters need not be on new lines (they may be written as We recommend you place You must include every parameter mentioned in the template data; otherwise a "המאפיין הדרוש "propertyname" לא נמצא." error will show. If not specified Without With other parameters In the 2010 wikitext editor with TemplateWizard:
In the visual editor and the 2017 wikitext editor, |
"paramOrder": [
"date",
"reason",
"talk"
]
|
בתוך params
פרמטר | תיאור | דוגמה |
---|---|---|
שם הפרמטר |
הפריט היחיד ברמה הראשונה של האובייקט For example, in a template's source code, You may also see parameters named
Note: a user can still force the use of How to use Each of these |
"1": { // שם הפרמטר
... // מידע על הפרמטר יופיע כאן
}
|
בתוך שם הפרמטר
פרמטר | תיאור | דוגמה |
---|---|---|
aliases |
The optional
או
This means that if the user inserts either of these parameters with a value, they will perform the same function. Literally, it translates to, "Value of parameter1. If parameter1 doesn't exist or have a value: value of parameter2." In the second case, it also means, "If parameter2 doesn't exist or have a value: no value." To insert the |
"aliases": ["1", "talk", "talksection"],
|
inherits |
To use this parameter, type |
"params": {
"נושא1": {
"label": "נושא",
"description": "נושא שמוזכר בדף הפירושונים הזה",
"type": "string"
},
"נושא2": {
"inherits": "נושא1"
},
"נושא3": {
"inherits": "נושא1",
"label" : "A different label"
}
}
|
label |
לאחר מכן יש |
"label": "חודש ושנה",
|
description |
הפעם |
"description": "The month and year that the template was inserted",
|
type |
See the #Type parameter section. |
|
default |
Some template parameters have a default value; the value is used unless overridden by the user.
The השפעות In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), the עם פרמטרים אחרים In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), if |
"default": "Category:CommonsRoot",
|
autovalue |
ניתן להקצות לפרמטר This value can be overwritten by the user in the template editor. עם פרמטרים אחרים In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), |
"autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}"
|
example |
The השפעות In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), this property is displayed below the parameter description (and below the עם פרמטרים אחרים In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), |
"example": "January 2013",
|
suggested values |
The parameter property
Other types (file, page, template, user, date, boolean, URL) are not currently supported because they have special functionalities in the visual editor already, such as autocomplete, which would interfere with the drop-down menu for suggested values in the visual editor. Editing template data as JSON in wikitext To add suggested values to any parameter type, add the new property "suggestedvalues" to the parameter in JSON. The “suggestedvalues” attribute must be a list of strings. Editing template data with the template data editor
השפעות Once the values have been added to template data, the visual editor will display them in a combo box (a dropdown into which users can also enter a custom value) for the parameter types listed above. The user selects the desired value by clicking on it. If the list of values is long -- for example, a list of a country’s states -- the user can begin typing in the field, whereupon the list will be filtered to show only values containing the typed text. To change an entered value, the user must simply clear the field, and the full dropdown list will appear again. If the user needs a value not included in the list (for example, "message in a bottle") they can type it in manually. |
"suggestedvalues": [
"כתב עת",
"ספר",
"עיתון",
"מגזין"
]
|
אפשרות סטטוס | תיאור | דוגמה |
---|---|---|
required |
ניתן להגדיר את הפרמטר הוא קובע אם מילוי הפרמטר הנתון הוא חובה עבור התבנית. השפעות לסטטוס זה יש מספר השפעות בעורך הוויזואלי וב-עורך קוד מקור 2017 :
In the WikiEditor with Extension:TemplateWizard , as in the other editors, it displays the parameter automatically when a user inserts the template, but the parameter cannot be removed using this or any editor.
It also does not display עם פרמטרים אחרים In the visual editor and the 2017 wikitext editor, the |
"required": true
|
suggested |
הפרמטר Use Effects In the visual editor and the עורך קוד מקור 2017 , it causes the parameter to automatically show up when a user inserts a template. If the parameter has an autovalue set, this will also automatically be in the parameter's input box. It has no other effect and doesn't show any additional text or warnings. In the WikiEditor with TemplateWizard, it does not place the parameter in the template automatically but instead causes it to be listed on the side under עם פרמטרים אחרים The |
"suggested": true
|
deprecated |
לסיום ישנו הבחירה הזאת מיועדת לפרמטרים שאינם נמצאים בשימוש, אך עדין קיימים. זה יכול לקרות בגלל שינוי שמות פרמטרים בתבנית, למשל. השפעות The effect of this parameter in the visual editor and the 2017 wikitext editor is that a grey exclamation mark shows next to the parameter's label when it is inserted, and in the parameter's information tooltip, the grey, italic text "השדה מיושן. deprecation reason" is shown below the parameter description. It does not affect the functionality or usability of the parameter or show any additional warnings. Despite the fact that it can take a string, as of January 2020 none of the main editors (the visual editor, the 2017 wikitext editor or the 2010 wikitext editor) display the contents of the string anywhere to users.
Inputting a string has the same effect as In the 2010 wikitext editor with TemplateWizard, setting this value as עם פרמטרים אחרים If you set both this and If you set both this and In the 2010 wikitext editor with TemplateWizard, |
"deprecated": "Please use 'publicationDate' instead."
|
Note: if neither "required"
, "suggested"
nor "deprecated"
are set as true
for a parameter, its status will show as "optional"
in the template data documentation.
בסיום יש ללחוץ על שמירה
. אם נעשו טעויות, לא תתאפשר שמירה (לפעמים זה מטריד אבל לפחות לא ניתן להרוס הכל). אם יש שגיאות, ניתן להסביר בדף המשוב מה ניסיתם לעשות ונשמח לעזור.
Note that if you are abusing a hack template to dynamically generate template data, it cannot be checked for errors before saving.
שימו לב שכל פריט מידע מוקף במרכאות (למעט true
ו-false
) ומופרד מהפריט הבא בפסיק (חוץ מהנתון האחרון).
סוג הפרמטר
הפרמטר "type"
נועד לאותת לעורך תבנית את אופי הערך של פרמטר.
In some cases, template editors have been programmed to modify the user interface for a certain parameter according to this template data value, such as to only allow the user to enter valid values that match the specified type.
This parameter does not have any functional effect on the template parameter or its value; it merely controls how template editors see and treat the parameter in editing mode.
כיצד להשתמש
It is used by adding the "type"
parameter, followed by a colon and a space, then adding any of the values listed in the table below in quotation marks.
דוגמה:
"type": "string",
השפעות
As of February 2020, only 5 of the 13 type values have visible effects in VisualEditor and the 2017 wikitext editor, while 8 have visible effects in TemplateWizard.
The effects of certain values are likely to change as the template editors get updates to support them. One such effort for VisualEditor and the 2017 wikitext editor is tracked in the Phabricator task T55613. A similar effort to get TemplateWizard to support the boolean value is tracked in T200664.
The currently known effects are listed as follows.
ערך | תיאור | |
---|---|---|
unknown |
The השפעות In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
string |
The השפעות In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
line |
The השפעות
| |
content |
The השפעות
| |
unbalanced-wikitext |
The השפעות
| |
wiki-page-name |
The השפעות In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
wiki-file-name |
The השפעות
| |
wiki-template-name |
The השפעות In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
wiki-user-name |
The השפעות In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
number |
The השפעות
עם פרמטרים אחרים
| |
boolean |
The השפעות With the | |
date |
The השפעות
עם פרמטרים אחרים
| |
url |
The השפעות
required " setting, but it does not warn the user if they attempt to insert the template without a valid URL. It also occurs with any status setting (such as "suggested" " or "deprecated ").
עם פרמטרים אחרים
|
פורמטים מותאמים אישית
When editing the "format"
value, you create custom formats by inputting a set of wikitext symbols using some predefined rules.
{{
- תחילת התבנית_
- תוכן (למשל, מחרוזת, מספר שלם או פרמטר). This underscore serves to indicate the minimum length of a value in characters and can be repeated, like_______
. If this length is not reached, it fills the remaining characters with spaces. This can be used to align all equals signs to a specific position after a parameter (if used with\n
for new lines).|
- pipe (separates parameters)=
- equals sign (precedes the value of a parameter)\n
or pressing the enter key - new line (this will display as↵
in the entry field)\n
to indent new lines)}}
- סוף התבנית
The wikitext should at least meet the minimum of {{_|_=_}}
, otherwise there will be an invalid format string error.
מטרה | עיצוב מחרוזת | פלט |
---|---|---|
עיצוב מוטבע | {{_|_=_}} inline |
{{Foo|bar=baz|longparameter=quux}}{{Bar}} |
עיצוב בלוקים | {{_\n| _ = _\n}} block |
{{Foo | bar = baz | longparameter = quux }}{{Bar}} |
No space before the parameter name, each template on its own line | \n{{_\n|_ = _\n}}\n |
{{Foo |bar = baz |longparameter = quux }} {{Bar}} |
Indent each parameter | {{_\n |_ = _\n}} |
{{Foo |bar = baz |longparameter = quux }}{{Bar}} |
Align all parameter names to a given length | {{_\n|_______________ = _\n}}\n | {{Foo |bar = baz |longparameter = quux |veryverylongparameter = bat }} {{Bar}} |
Pipe characters at the end of the previous line | {{_|\n _______________ = _}} |
{{Foo| bar = baz| longparameter = quux}}{{Bar}} |
Inline style with more spaces, must be at start of line | \n{{_ | _ = _}} |
{{Foo | bar = baz | longparameter = quux}} {{Bar }} |
Template at the start of a line, indent-aligned parameters, pipe beforehand | \n{{_ |\n _______________ = _}} |
{{Foo | bar = baz | longparameter = quux}} {{Bar}} |
מבנה ריק
ניתן להעתיק את המבנה הריק שלהלן על מנת להוסיף נתוני־תבנית לתבנית. רק התגים הנפוצים ביותר נכללים בו.
<templatedata>
{
"description": "",
"params": {
"1": {
"label": "",
"description": "",
"type": ""
},
"2": {
"label": "",
"description": "",
"type": ""
}
}
}
</templatedata>
שגיאות
שגיאת תחביר ב־JSON. / פורמט JSON שגוי
These errors occur when saving template data, usually manually edited, with invalid JSON code (duplicate keys/parameters, trailing or missing commas, etc.) in the visual editor or the 2017 wikitext editor.
שגיאת תחביר ב־JSON.
appears in the visual editor and the 2017 wikitext editor; "Bad JSON format" appears when editing in the template data GUI editor.
These errors can be difficult to detect and come in too many forms to list. The best way to avoid them is to edit template data exclusively with the template data editor; the best way to detect them once they've occurred is to use an external JSON validator, such as JSONLint, which will highlight errors and aid in fixing them.
The 2010 wikitext editor does not check for invalid JSON thanks to an old, unfixed bug (T128029).
Pages that contain invalid JSON may throw alarming שגיאה פנימית
messages.
To fix these errors, your best bet is to use a JSON validator (see above).
המאפיין הדרוש "paramOrder[מספר]" לא נמצא.
שגיאה זו מתרחשת אם אתה מציין פרמטר ב-"params"
שאינו מצוין ב-"paramOrder"
.
The number in the square brackets refers to the parameter in "paramOrder"
that is missing. It refers to its order in the sequence, but it is one less than its actual position, since "paramOrder"
is an array; 0 is the first one, 1 is the second, etc.
"params": {
"date": { ...
},
"reason": { ...
},
"talk": { ... // <-- This parameter is not stated in "paramOrder", but it should be.
}
},
"paramOrder": [
"date",
"reason"
]
// Error: Required property "paramOrder[2]" not found.
To fix this, make sure all parameters stated in "params"
are listed in "paramOrder"
.
Alternatively, you can remove the "paramOrder"
object to remove this error.
ערך בלתי־תקין למאפיין "paramOrder[מספר]".
שגיאה זו מתרחשת אם אתה מציין פרמטר ב-"paramOrder"
שאינו מצוין ב-"params"
.
The number in the square brackets refers to the parameter in "paramOrder"
that shouldn't be there. It refers to its order in the sequence, but it is one less than its actual position, since "paramOrder"
is an array; 0 is the first one, 1 is the second, etc.
"params": {
"date": { ...
},
"talk": { ...
}
},
"paramOrder": [
"date",
"reason", // <-- This parameter is not stated in "params", but it should be.
"talk"
]
// Error: Invalid value for property "paramOrder[1]".
To fix this, make sure all parameters stated in "paramOrder"
are listed in "params"
.
Alternatively, you can remove the "paramOrder"
object to remove this error.
המאפיין "params.parametername.required" אמור להיות מסוג "boolean".
"suggested": "true" // <-- These quotation marks shouldn't be here.
These are boolean values, not strings, therefore they require no quotation marks.
To fix this, remove any quotation marks around the values true
or false
for these parameters.
המאפיין "format" צפוי להיות ...
If the "format"
parameter exists but its value is not "inline"
, "block"
or a valid format string, you will see the error message המאפיין "format" אמור להיות "inline" (בשורה) או "block" (בפסקה), או מחרוזת עיצוב תקינה.
.
"format": "notinline"
// Error : Property "format" is expected to be "inline", "block", or a valid format string.
To fix this, make sure the value after "format":
equals "inline"
or "block"
and that there no spelling mistakes. Alternatively, if it's wikitext, make sure it contains a minimum of {{_|_=_}}
and that there are no mistakes in the syntax that would normally cause a template to fail, such as duplicate equals signs or missing/duplicate curly brackets; see the section #Custom formats for the syntax for custom formats.
Alternatively, you can remove the "format"
parameter to remove this error.
מאפיין בלתי־צפוי "parametername".
This error occurs if you state a parameter that is unknown in template data. This is probably due to spelling mistakes or the use of uppercase letters instead of lowercase.
<templatedata>
{
"description": "",
"format": "inline",
"params": {
"1": {
"label": "",
"descriptino": "", // <-- spelling mistake
"type": ""
}
}
}
</templatedata>
It also occurs if you state a parameter in any template data object that is not a parameter of that object. This may be due to spelling mistakes, or you may have written the parameter of one template data object under another object that it doesn't belong to.
For example, you might have written the parameter "label"
under the root template data object instead of inside "params"
:
<templatedata>
{
"description": "",
"format": "inline",
"label": "", // <-- incorrectly placed parameter
"params": {
"1": { // ↓ it should be in here
"description": "",
"type": ""
}
}
}
</templatedata>
Alternatively, if the unexpected parameter is under a template parameter inside "params"
, you'll see its name after "params.parametername." in the error.
To fix this, make sure there aren't any spelling mistakes in the parameter names, and make sure your parameters are in their correct location. Additionally, make sure you don't state any parameters that don't exist for a template data object. You can check which parameters exist for an object in the section #Template data parameters.
המאפיין הדרוש "params" לא נמצא.
This error occurs if there is no "params"
object in the template data.
This is a necessary object, as it contains all the details of each parameter, so to fix this error, make sure it's added and that there are no spelling mistakes.
See the section above on how to add the "params"
parameter.
הגבלות ותגובות
- פונקציונליות חסרה – נתוני תבנית הוא דוגמה לכלי שנוצר עם מספר פונקציות קטן בתקווה שהמשתמשים ינתבו את צוות הפיתוח לפונקציונליות נוספת שהם מעוניינים בה. אם יש לכם בקשה לפונקציונליות חדשה עבור נתוני תבנית, נא ידעו אותנו.
- עיכוב בהצגת מידע בתבניות – כאשר מוסיפים נתוני תבנית לתבנית, הנתונים צריכים להופיע מיידית כאשר פותחים את התבנית בעורך החזותי. אולם לעיתים קורה שלוקח כמה שעות לפני שנתוני התבנית מוצגים. ניתן לכפות את העדכון על ידי ביצוע עריכה ריקה של דף התבנית (ולא לדף המשנה עם התיעוד). על מנת לעשות עריכה ריקה יש לפתוח את הערך לעריכה ולשמור ללא ביצוע שום שינוי וללא תקציר עריכה.
- בעיות פתוחות – רשימת בעיות פתוחות ובקשות לתכונות נוספות ניתן לראות במעקב בבאגים של ויקימדיה.
כלים נוספים
- Help:Extension:TemplateWizard
- חלון דו-שיח בסרגל כלים להזנת טקסט ויקי של תבנית באמצעות טופס שנבנה מנתוני תבנית.
- TemplateData Wizard
- כלי שיוצר נתוני תבנית דרך ממשק אינטרקטיבי.
- Skeleton TemplateData generator
- כלי שקורא את הקוד של התבנית, מנסה למצוא את כל הפרמטרים ויוצר מסמך שלדי עם רשימת הפרמטרים.
- JSONLint
- כלי המאפשר לאשר JSON כתוב בצורה ידנית על מנת לסייע לאתר שגיאות בקוד.
- רשימה של כל התבניות עם נתוני תבנית באתר הויקי הנוכחי
- עם תבנית:נתוני תבנית ההגרמנית נתוני התבנית מופיעים במסגרת והתבנית מתווספת לקטגוריה של תבניות עם נתוני־תבנית.
- https://query.wikidata.org/ ועוזר השאילתות