Help:TemplateData/he

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

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

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

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

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

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

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

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

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

You can list the name of the parameter, any aliases for it, the label and the description that will display to users. You can also provide an example how to use the parameter. The only required field is Name (the first field in each row), which is where you record the exact, case-sensitive name of the parameter. In the "Type" dropdown menu, you can choose the type of content that the parameter should receive, such as a string (for plain-text answers), page (for links to other pages), or dates. If the template will produce an error if this parameter is left blank, please mark it as "Required". If the parameter is commonly used or recommended, then mark it as "Suggested". The "Remove parameter information" button will delete the parameter's entry from TemplateData.



When you are finished documenting each of the parameters, click "Apply" to insert the pre-formatted TemplateData into the open editing box. You must still save the page, using the normal "Save" button underneath the editing window.

Caution: The TemplateData editor will place TemplateData on either the template page or on a documentation subpage. You determine where the TemplateData will be added by opening (editing) the page that you want the TemplateData to be placed on. However, if multiple TemplateData blocks are placed on the same template, then only one of those TemplateData blocks will be used. If there is already TemplateData on a page, then you need to edit the page where the TemplateData was previously placed to avoid accidentally creating multiple blocks of TemplateData.

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

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

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

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

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

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

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

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

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

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

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

כינויים לפרמטר
מספר תבניות מאפשר שלפרמטר מסויים יהיו כמה שמות.

למשל,  יכול להכתב גם   או.

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

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

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

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

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

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

כלים נוספים

 * TemplateDataEditor: סקריפט אישי שהופך את תהליך הוספת נתוני־תבנית לפשוטה יותר. הסקריפט קיים בצרפתית (ומכיל תרגום לאנגלית, איטלקית, יפנית וקוראנית), וניתן בקלות לתרגמו ללשונכם.
 * TemplateData Wizard: כלי שיוצר נתוני־תבנית דרך מנשק אינטרקטיבי.
 * Skeleton TemplateData generator: כלי שקורא את הקוד של התבנית ומנסה למצוא את כל הפרמטרים ויוצר מסמך שלדי עם רשימת הפרמטרים.
 * JSONLint: כלי שמאפשר לאשר JSON כתוב בצורה ידנית על מנת לסייע לאתר שגיאות בקוד.
 * List of all templates with TemplateData on this wiki
 * With dewiki template TemplateData template data is shown in a box, and the template is added to a category of templates with template data