Help:נתוני תבנית

From MediaWiki.org
Jump to: navigation, search
This page is a translated version of the page Help:TemplateData and the translation is 86% complete.

Outdated translations are marked like this.
Other languages:
अङ्गिका • ‎العربية • ‎asturianu • ‎azərbaycanca • ‎تۆرکجه • ‎български • ‎বাংলা • ‎català • ‎čeština • ‎Cymraeg • ‎dansk • ‎Deutsch • ‎Zazaki • ‎Ελληνικά • ‎emiliàn e rumagnòl • ‎English • ‎español • ‎euskara • ‎فارسی • ‎suomi • ‎føroyskt • ‎français • ‎Frysk • ‎galego • ‎עברית • ‎हिन्दी • ‎hrvatski • ‎magyar • ‎Հայերեն • ‎Bahasa Indonesia • ‎Ilokano • ‎italiano • ‎日本語 • ‎ქართული • ‎한국어 • ‎Lëtzebuergesch • ‎lietuvių • ‎मराठी • ‎Nederlands • ‎occitan • ‎Oromoo • ‎polski • ‎پښتو • ‎português • ‎português do Brasil • ‎română • ‎русский • ‎Scots • ‎سنڌي • ‎slovenščina • ‎српски / srpski • ‎svenska • ‎ไทย • ‎Türkçe • ‎українська • ‎Tiếng Việt • ‎ייִדיש • ‎中文
PD הערה: כאשר אתם עורכים דף זה, אתם מסכימים לשחרר את תרומתכם תחת רישיון CC0. ראו את דפי העזרה בנושא נחלת הכלל למידע נוסף.
PD

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

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

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

עורך נתוני תבנית

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

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

Manage template documentation button for TemplateData 2014.png

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

צילום מסך של כלי עריכת נתוני תבנית

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

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

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

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

צילום מסך של כלי עריכת נתוני התבנית, מציג הוספת פרמטר שני

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

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

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

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

מיקום נתוני תבנית

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

מבנה נתוני תבנית

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

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

<templatedata>
{
    ...       // תוכן נתוני התבנית יופיעו כאן
}
</templatedata>

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

דוגמה

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

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

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

תבנית לקישור הערך לקטגוריה בוויקישיתוף

Template parameters

ParameterDescriptionTypeStatus
קטגוריה בוויקישיתוף1

הקטגוריה בויקישיתוף שרוצים לקשר אליה.

Default
Category:CommonsRoot
Example
empty
Auto value
empty
Stringrequired

תיאור ופרמטרים

description התג הראשון הוא "description" שמתאר את מה שהתבנית עושה.
"description": "תבנית לקישור לקטגוריה בוויקישיתוף",
format הבא אחריו הוא "format" שמתאר איך קוד ויקי של התבנית צריך להראות

הערך יכול להיות "inline" (ברירת המחדל) או "block".

אם ערך הפרמטר הוא "inline", אזי התבנית תופיע ללא שטח ריק, באופן הבא:

{{Foo|bar=baz|qux=quux}}

אם ערך הפרמטר הוא "block", אזי התבנית תופיע עם מעברי שורות ורווח אחד בין כל חלק, באופן הבא:

{{Foo
| bar = baz
| qux = quux
}}
"format": inline
params לאחר מכן יופיע תג "params", שמציין שתת הקטע יתאר כל פרמטר ופרמטר מהתבנית.

כל הפרמטרים הבאים כלולים במקטע "params".

"params": {
    ...    // כאן יופיעו הפרמטרים
}
  בתוך המקטע של הפרמטרים, התג הראשון הוא השם של הפרמטר הראשון שבתוך התבנית.

אם לפרמטר יש שם, כמו למשל {{{category-link}}}, התג יהיה "category-link".

אם לפרמטר אין שם, זאת אומרת שהפרמטר הוא על בסיס מיקום, זה אומר ששם הפרמטר הוא מספר כמו {{{1}}}, התג יהיה "1".

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

"1": {     // שם הפרמטר
    ...    // מידע על הפרמטר יופיע כאן
}
label לאחר מכן יש "label", בו יש לכתוב כותרת ברורה וקריאה לפרמטר שתוצג בעורך התבניות.
"label": "קטגוריה בוויקישיתוף",
description לאחר מכן יש "description": הפעם מדובר בתיאור הפרמטר, ולא בתיאור התבנית כולה.
"description": "הקטגוריה בויקישיתוף שרוצים לקשר אליה.",
default לאחר מכן "default". במספר תבניות יש ערך ברירת מחדל שמשתמשים בו, אלא אם משנים אותו. פריט זה אומר למשתמש מהו ערך ברירת המחדל של הפרמטר.

ניתן להתעלם מהפרמטר הזה אם אין ערך ברירת מחדל.

"default": "Category:CommonsRoot",
type לאחר מכן יש "type", ששולט על הצורה בה עורך התבניות יפענח את הפרמטר. זה יכול להיות:
  • "string": סדרה של תווים, למשל משפט;
  • "number": סדרה של ספרות;
  • "boolean": '0' for false, '1' for true, '' for unknown;
  • "wiki-user-name": סדרה של תווים המתארים שם של משתמש;
  • "wiki-page-name": סדרה של תווים המתארים כותרת של דף;
  • "wiki-file-name": שם של קובץ.

Other types include "unknown", "date", "url", "wiki-template-name", "content", "unbalanced-wikitext", "content", and "line".

"type": "string",
required לאחר מכן יש "required", שיכול להיות או true או false.

פרמטר זה שולט האם הפרמטר הוא פרמטר חובה או לא. אם לא מוגדר כלום, מניחים שהפרמטר הוא לא חובה (false).

"required": true
suggested ואז "suggested", גם פרמטר זה יכול להיות או true או false.

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

"suggested": true
deprecated

לסיום ישנו "deprecated" שיכול להיות true, false או כל מחרוזת שמתארת מה המשתמש צריך לעשות במקום.

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

"deprecated": "Please use 'publicationDate' instead."

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

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


Custom formats

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

Examples of formats you can use
Objective Format string Output
Inline formatting {{_|_=_}}
inline
{{Foo|bar=baz|qux=quux}}{{Bar}}
Block formatting {{_\n| _ = _\n}}
block
{{Foo
| bar = baz
| qux = quux
}}{{Bar
}}
No space before the parameter name,

each template on its own line

\n{{_\n|_ = _\n}}\n
{{Foo
|bar = baz
|qux = quux
}}
{{Bar
}}
Indent each parameter {{_\n |_ = _\n}}
{{Foo
 |bar = baz
 |qux = quux
}}{{Bar
}}
Align all parameter names to a given length {{_\n|_______________ = _\n}}\n
{{Foo
|bar             = baz
|qux             = quux
|veryverylongparameter = bat
}}
{{Bar
}}
Pipe characters at the end of the previous line {{_|\n _______________ = _}}
{{Foo|
  bar             = baz|
  qux             = quux}}{{Bar}}
Inline style with more spaces, must be at start of line \n{{_ | _ = _}}
{{Foo | bar = baz | qux = quux}}
{{Bar }}
Template at the start of a line, indent-aligned parameters, pipe beforehand \n{{_ |\n _______________ = _}}
{{Foo |
  bar             = baz |
  qux             = quux}}
{{Bar}}

כינויים לפרמטר

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

למשל, {{Commons|category=Apples}} יכול להכתב גם {{Commons|Apples}} או {{Commons|link=Apples}}.

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

    "params": {
        "קטגוריה": {
            ...
            "aliases": ["1", "קישור"]
        }

ערך אוטומטי

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

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

    "params": {
        "תאריך": {
            ...
            "autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}"
        }

ריבוי פרמטרים

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

"params": {
    "1": {
        ...
    },      // יש לשים לב לפסיק כאן
    "2": {
        ...
    },      // וכאן
    "3": {
        ...
    }
}

פרמטרים זהים

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

    "params": {
        "נושא1": {
            "label": "נושא",
            "description": "נושא שמוזכר בדף הפירושונים הזה",
            "type": "string"
        },
        "נושא2": {
            "inherits": "נושא1"
        },
        "נושא3": {
            "inherits": "נושא1"
        },
    }

מבנה ריק

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

<templatedata>
{
    "description": "",
    "params": {
        "1": {
            "label": "",
            "description": "",
            "type": ""
        },
        "2": {
            "label": "",
            "description": "",
            "type": ""
        }
    }
}
</templatedata>

כלים נוספים

TemplateData Wizard
כלי שיוצר נתוני־תבנית דרך ממשק אינטרקטיבי.
Skeleton TemplateData generator
כלי שקורא את הקוד של התבנית, מנסה למצוא את כל הפרמטרים ויוצר מסמך שלדי עם רשימת הפרמטרים.
JSONLint
כלי המאפשר לאשר JSON כתוב בצורה ידנית על מנת לסייע לאתר שגיאות בקוד.