Help:TemplateData/he

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

הרחבת נתוני תבנית (TemplateData) מותקנת בכל מיזמי קרן ויקימדיה. אם יש לך אתר ויקי משלך, עליך להתקין Extension:TemplateData.

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

עורך נתוני תבנית
יש כלי מובנה לעריכת נתוני תבנית בצורה קלה.

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

לחיצה על הכפתור הזה תפתח ממשק חזותי לעריכת נתוני תבנית.

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

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

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



לאחר שתיעוד כל הפרמטרים הושלם יש ללחוץ "לעדכן" על מנת להוסיף נתוני־תבנית בפורמט המתאים לתוך חלון עריכה פתוח. עדיין נדרש לשמור את הדף על ידי לחיצה על לחצן "שמירה" מתחת לחלון העריכה.

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

הגבלות ושאלות

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

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

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

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

זה מציין לתוכנה שכל מה שנמצא בין שני התגים הוא נתוני תבנית וצריך יהיה להתיחס אליו כאשר ישתמשו בתבנית.

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

התצוגה בדף התבנית תראה כך:

{   "description": "תבנית לקישור הערך לקטגוריה בוויקישיתוף", "params": { "1": {           "label": "קטגוריה בוויקישיתוף", "description": "הקטגוריה בויקישיתוף שרוצים לקשר אליה.", "default": "Category:CommonsRoot", "type": "string", "required": true }   } }

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

Note that if you are abusing a hack template to dynamically generate TemplateData, it cannot be checked for errors before saving.

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

Custom formats
When editing custom format strings in the TemplateData editor you can either type  or press the enter key to represent a newline; in either case it will display as   in the entry field.

{| class="wikitable" ! style="width:25%" | Objective ! Format string ! Output each template on its own line
 * + Examples of formats you can use
 * Inline formatting
 * Block formatting
 * No space before the parameter name,
 * Block formatting
 * No space before the parameter name,
 * Block formatting
 * No space before the parameter name,
 * No space before the parameter name,
 * No space before the parameter name,
 * No space before the parameter name,
 * Indent each parameter
 * Align all parameter names to a given length
 * Align all parameter names to a given length
 * Align all parameter names to a given length
 * Align all parameter names to a given length
 * Align all parameter names to a given length
 * Pipe characters at the end of the previous line
 * Inline style with more spaces, must be at start of line
 * Inline style with more spaces, must be at start of line
 * Inline style with more spaces, must be at start of line
 * Inline style with more spaces, must be at start of line
 * Inline style with more spaces, must be at start of line
 * Template at the start of a line, indent-aligned parameters, pipe beforehand
 * יכול להכתב גם  או.
 * יכול להכתב גם  או.

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

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

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

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

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

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

Syntax Error in JSON / Bad JSON format
Due to a long standing bug, users using the old wikitext editor are able to save pages which have certain types of invalid JSON, such as duplicate keys or trailing commas (details: ). However if you attempt to save this page in a Javascript based editor, such as VisualEditor or the 2017 Wikitext editor, you will see an error message "Syntax error in JSON," as the Javascript parser is stricter and doesn't allow invalid JSON. Additionally, if you attempt to open up such invalid JSON with the Template Data GUI editor, you will see the error message, "Bad JSON format." To fix these errors, you can enter the JSON block into an external JSON validator, such as https://jsonlint.com/, and it will highlight the problematic commas and keys so they can be removed.

כלים נוספים

 * : A toolbar dialog window for entering template wikitext via an form built from TemplateData.
 * TemplateData Wizard: כלי שיוצר נתוני־תבנית דרך ממשק אינטרקטיבי.
 * Skeleton TemplateData generator: כלי שקורא את הקוד של התבנית, מנסה למצוא את כל הפרמטרים ויוצר מסמך שלדי עם רשימת הפרמטרים.
 * JSONLint: כלי המאפשר לאשר JSON כתוב בצורה ידנית על מנת לסייע לאתר שגיאות בקוד.
 * רשימה של כל התבניות עם נתוני־תבית באתר ויקי הזה.
 * עם תבנית:נתוני תבנית ההגרמנית נתוני התבנית מופיעים במסגרת והתבנית מתווספת לקטגוריה של תבניות עם נתוני־תבנית.