Extension:TemplateData/he

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

התקנה


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

כאשר התג נכלל בדף, התוסף TemplateData מבצע את הבדיקות הבאות כאשר הדף נשמר:


 * 1) התוכן חייב להיות כתוב ב-JSON.
 * 2) כל פריט בתוך מבנה ה-JSON חייב להיות מהסוג כמפורט להלן (למשל אובייקט, מערך או פרימיטיבי).
 * 1) עבור אותם פריטים שלהם רשימה מוגדרת של ערכים אפשריים (לדוגמה,  ), הערך באובייקט JSON חייב להיות תואם לאחד מהערכים הללו.

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

עבור ערכים אוטומטיים, באג 2700 מונע מ- לעבוד בכל תבנית שנמצאת בתוך $3, כולל התגיות  ו-. התוסף TemplateData יישמר כראוי, אך הקוד ויקי שיתקבל לא ינותח כראוי בעת השימוש בתבנית.

שימו לב כי לא ניתן להשתמש ב- במקום Special:MyLanguage/Help:TemplateData#Template data editor method.

פורמט
להלן גרסה חזותית של נתוני ה-JSON כפי שניתן להגדיר בדף התבנית המוקף בתגיות . המפרט הפורמלי זמין במאגר TemplateData. לגרסה העדכנית ביותר, ראו Specification.md.



אובייקט TemplateData
האובייקט TemplateData הוא שורש JSON המוקף באלמנט בדף התבנית.



פרמטרים


סטים


מפות


InterfaceText (מחרוזת או אובייקט)
טקסט חופשי בקוד ויקי או אובייקט המכיל את המחרוזות הללו הממוקמות לפי קוד שפת ויקי.

ערך ברירת המחדל עבור שדות InterfaceText הוא.



סוג מחרוזת
אם זו מחרוזת, היא חייבת להכיל מחרוזת לא מקומית בשפת התוכן של הוויקי המקומית.



סוג אובייקט
אם זה אובייקט, האובייקט חייב להיות ממופה כך:

דוגמה
להלן דוגמה למבנה TemplateData כפי שנכתב בקוד ויקי של התבנית.

להלן כיצד הדוגמה תיראה בדף התבנית.

{   "description": "Label unsigned comments in a conversation.", "params": { "user": { "label": "User's name", "type": "wiki-user-name", "required": true, "description": "User name of person who forgot to sign their comment.", "aliases": ["1"] },       "date": { "label": "Date", "suggested": true, "description": { "en": "Timestamp of when the comment was posted, in YYYY-MM-DD format." },           "aliases": ["2"], "autovalue": "" },       "year": { "label": "Year", "type": "number" },       "month": { "label": "Month", "inherits": "year" },       "day": { "label": "Day", "inherits": "year" },       "comment": { "required": false }   },    "sets": [ {           "label": "Date", "params": ["year", "month", "day"] }   ],    "maps": { "ExampleConsumer": { "foo": "user", "bar": ["year", "month", "day"], "quux": [ "date", ["day", "month"], ["month", "year"], "year" ]       }    } }

ממשק תוכנה (API)
לעזרה בנושא ראו Special:ApiHelp/templatedata. קריאה לדוגמה (מעוצבת לקריאות אנושית) היא:

זה מחזיר את נתוני התבנית עבור התבנית Template:Cite web. הבלוק  עבור תבנית זו נמצא בדף התיעוד של התבנית.



תוספות ושינויים ל-JSON כפי שהתקבלו מה-API
מבנה ה-JSON שמסופק כחלק מבקשת HTTP Get API שונה באופן משמעותי מזה המוגדר בבלוק . בתגובה לבקשת ה-API, הרחבה TemplateData מבצעת את השינויים הבאים באובייקט JSON:


 * מוסיפה שני אובייקטי עטיפה:
 * אובייקט דפים המכיל לפחות אובייקט עמוד אחד או יותר.
 * אובייקט עם מפתח מספרי: אובייקט עמוד.
 * תוספות/שינויים בפועל לאובייקט TemplateData.
 * מוסיף את המפתח  עם שם העמוד שממנו נתבקשו הנתונים (למשל "Template:Cite web").
 * מוסיף את המפתח.
 * משנה את כל מופעי TemplateText שהם רק מחרוזות לאובייקטים עם מפתח יחיד עבור קוד שפת הוויקי של מיזם הוויקימדיה הנוכחי.
 * מסיר את כל המפתחתות שהוגדרו כ-.
 * מוסיף את כל המאפיינים מפרמטר שממנו הוגדרה ירושה שאינם מוחלפים על ידי מפתחות מוגדרים במפורש בפרמטרים של היורש.
 * מוסיף ערכי ברירת מחדל עבור כל המפתחות בכל הפרמטרים שלא הוגדרו או לא עברו בירושה.



הבדלים חזותיים באובייקט TemplateData JSON שנמסר על ידי ה-API
<span id="Example_of_JSON_object_provided_by_API">

דוגמה לאובייקט JSON שמסופק על ידי API
ניתן לראות את אובייקט ה-JSON כפי שמסופר על ידי ה-API עבור המבנה TemplateData שמופיע בפסקה זו (מופיע למעלה):
 * בפורמט HTML ראו: https://www.mediawiki.org/w/api.php?action=templatedata&titles=Extension:TemplateData&format=jsonfm
 * כפי שמוצג על פי ה-API ראו: https://www.mediawiki.org/w/api.php?action=templatedata&titles=Extension:TemplateData

הגדרות
<span id="See_also">

ראו גם

 * – ממשק משתמש לבחירה והכנסת קוד ויקי של תבניות, וכל זאת בהתבסס על ה-TemplateData שלהן.
 * GitHub: jeblad/TemplateData – גרסה חלופית בסגנון Lua.
 * Translatable template
 * Wikibase/Maps_TemplateData