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.

Limitations and questions

 * Missing features — TemplateData is an example of a tool that was made available with few features, in hope that users would help to guide development of features that they desired. If you'd like to request new features for TemplateData, please let us know.
 * Delays in showing in templates — After adding TemplateData to a template, the metadata should be visible immediately when the template is opened in VisualEditor. However, it is possible that it will take several hours before the metadata will show. You can force an update by making a null edit to the template page itself (not the documentation subpage). To perform a null edit, open the template page for editing, and save the page without making any change and without adding any edit summary.
 * בעיות פתוחות — רשימת בעיות פתוחות ותכונות נוספות ניתן לראות במעקב בבאגים של ויקימדיה.

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

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

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

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

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

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

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

תיאור ופרמטרים
Once you're done, hit "save". If you've made errors, it will not let you save (which is disruptive, but means you can't break anything). Should you run into errors, explain on the feedback page what you were trying to do, and we will be happy to help.

Note that each bit of information is enclosed in quotation marks (except for  and  ), and separated from the next bit by a comma (unless it's the last one).

Parameter aliases
Some templates allow a same parameter to have different names.

For example,  could also be written as   or.

To add this information to TemplateData, you simply need to add the aliases to the parameter's information:

ערך אוטומטי
You can specify an "autovalue" for a parameter. When users add the template to a page, this value will be added automatically. For example, many clean-up templates need to have the date added; if you specify an autovalue for the template's date parameter, then the date will be filled in automatically.

To add this information to TemplateData, simply add the autovalue to the parameter's information. You will probably want to use the prefix  with the values to make them stick:

ריבוי פרמטרים
If you have multiple parameters, just repeat each section (starting from the "1" tag) and fill it out as you see fit. Note that if a template has multiple parameters, you need to separate them with a comma in the templatedata, like so:

פרמטרים זהים
When a template has multiple parameters, sometimes some of them can be of the same kind. In this case, you only need to provide full properties for the first one, and the others can "inherit" their properties from it.

מבנה ריק
You can copy the blank boilerplate below to add new TemplateData to a template. Only the most common tags are included.

כלים נוספים

 * TemplateDataEditor: A user script that makes the process of adding TemplateData easier. It currently exists in French (contains English, Italian, Japanese and Korean translations), and can easily be translated into other languages.
 * TemplateData Wizard: A tool that generates TemplateData through an interactive interface.
 * Skeleton TemplateData generator: A tool that reads the source wikicode of a template, tries to find all the parameters used and outputs a skeleton document with the parameters listed.
 * JSONLint: A tool that allows you to validate manually-written JSON to help find errors in the syntax.
 * 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