מדריך להרחבות מדיה-ויקי

TemplateData סטטוס שחרור: גרסה יציבהCategory:Stable extensions/he
יישום	Tag Category:Tag extensions/he, ממשק API Category:API extensions/he
Description	מאפשר לאחסן, לאחזר ולהמחיש מידע על תבניות
Author(s)	Timo Tijhof, Moriel Schottlender, James Forrester, Trevor Parscal, Bartosz Dziewoński, Marielle Volz, ...
Latest version	0.2.0 (עדכונים שוטפים)
Compatibility policy	Snapshots releases along with MediaWiki. Master is not backward compatible.
PHP	5.4+
Database changes	No
License	GNU General Public License 2.0 or later
Download	Download extension Git [?]: Browse repository (Phabricator · GitHub) Gerrit code review Git commit log Download source tarball Category:Extensions in Wikimedia version control/he
Parameters $wgTemplateDataEnableDiscovery $wgTemplateDataEnableFeaturedTemplates $wgTemplateDataEnableCategoryBrowser $wgTemplateDataMaxFavorites $wgTemplateDataEditorNamespaces $wgTemplateDataUseGUI
Tags ‎<templatedata>
Hooks used CommunityConfigurationProvider_initList Category:CommunityConfigurationProvider initList extensions/he EditPage::showEditForm:initial Category:EditPage::showEditForm:initial extensions/he GetPreferences Category:GetPreferences extensions/he MultiContentSave Category:MultiContentSave extensions/he OutputPageBeforeHTML Category:OutputPageBeforeHTML extensions/he ParserFetchTemplateData Category:ParserFetchTemplateData extensions/he ParserFirstCallInit Category:ParserFirstCallInit extensions/he ResourceLoaderRegisterModules Category:ResourceLoaderRegisterModules extensions/he SaveUserOptions Category:SaveUserOptions extensions/he SkinTemplateNavigation::Universal Category:SkinTemplateNavigation::Universal extensions/he
Translate the TemplateData extension if it is available at translatewiki.net
Issues	Open tasks · Report a bug

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

התקנה

• Download and move the extracted TemplateData folder to your extensions/ directory.
  Developers and code contributors should install the extension from Git instead, using:

  cd extensions/
  git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/TemplateData
  

• Add the following code at the bottom of your LocalSettings.php file:

  wfLoadExtension( 'TemplateData' );
  

• בוצע – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

עריכת מידע

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

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

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

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

עבור ערכי autovalue, הבעיה T4700 מונעת מ-subst: לעבוד בכל תבנית שנמצאת בתוך התג, כולל התגיות ‎<ref> ו-‎<gallery>. התוסף TemplateData יישמר כראוי, אך הקוד ויקי שיתקבל לא ינותח כראוי בעת השימוש בתבנית.

יש להימנע משימוש ב-{{#tag:templatedata}} מאחר ולא יהיה ניתן להשתמש בעורך התבניות.

{
	"proveit": {
		"main": "title",
		"textarea": [
			"quote"
		]
	},
	"citoid": {
		"title": "title",
		"url": "url",
		"publisher": "publisher",
		"publicationTitle": "work",
		"date": "date",
		"ISSN": [
			"issn"
		],
		"ISBN": [
			"isbn"
		],
		"contributor": "others",
		"author": [
			[
				"first",
				"last"
			],
			[
				"first2",
				"last2"
			],
			[
				"first9",
				"last9"
			]
		],
		"editor": [
			[
				"editor-first",
				"editor-last"
			]
		]
	}
}

<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": "{{subst:#time:Y-m-d}}"
        },
        "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"
            ]
        }
    }
}
</templatedata>

ממשק תוכנה (API)

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

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

הגדרות

ר' גם

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

This extension is being used on one or more Wikimedia projects. This probably means that the extension is stable and works well enough to be used by such high-traffic websites. Look for this extension's name in Wikimedia's CommonSettings.php and InitialiseSettings.php configuration files to see where it's installed. A full list of the extensions installed on a particular wiki can be seen on the wiki's Special:Version page.

This extension is included in the following wiki farms/hosts and/or packages: BlueSpice Category:Extensions included in BlueSpice/he Canasta Category:Extensions included in Canasta/he Debian Category:Extensions available as Debian packages/he Fandom Category:Extensions included in Fandom/he Miraheze Category:Extensions included in Miraheze/he MyWikisCategory:Extensions included in MyWikis/he ProWikiCategory:Extensions included in ProWiki/he semantic::coreCategory:Extensions included in semantic::core/he ShoutWiki Category:Extensions included in ShoutWiki/he wiki.gg Category:Extensions included in wiki.gg/he WikiForgeCategory:Extensions included in WikiForge/he This is not an authoritative list. Some wiki farms/hosts and/or packages may contain this extension even if they are not listed here. Always check with your wiki farms/hosts or bundle to confirm.