עזרה של MediaWiki API
זהו דף תיעוד של API שנוצר באופן אוטומטי.
תיעוד ודוגמאות: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
action=expandtemplates
(main | expandtemplates)
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0-or-later
פורס את כל התבניות בתוך קוד הוויקי.
פרמטרים ייעודיים:
זמינים פרמטרים כלליים אחרים.
- title
כותרת הדף.
- text
איזה קוד ויקי להמיר.
- הפרמטר הזה נדרש.
- revid
מזהה גרסה, עבור
{{REVISIONID}}
ומשתנים דומים.- סוג: מספר שלם
- prop
אילו חלקי מידע לקבל.
יש לשים לכך שאם לא נבחרו ערכים, התוצאה תכיל את קוד הוויקי, אבל הפלט יהיה בתסדיר מיושן.
- wikitext
- קוד הוויקי הפרוס.
- categories
- קטגוריות כלשהן שקיימות בקלט ואינן מיוצגות בפלט הוויקיטקסט.
- properties
- מאפייני דף המוגדרים במילות קסם פרוסות בקוד ויקי.
- volatile
- האם הפלט הוא נדיף ולא מיועד לשימוש במקום אחר בדף.
- ttl
- הזמן המרבי שאחריו המטמונים של התוצאה צריכים לפוג.
- modules
- כל יחידות ה־ResourceLoader שפונקציות מפענח ביקשו לוסיף לפלט. יש לבקש את jsconfigvars או את encodedjsconfigvars יחד עם modules.
- jsconfigvars
- נותן משתני הגדרות של JavaScript שייחודיים לדף הזה.
- encodedjsconfigvars
- נותן משתני הגדרות של JavaScript שייחודיים לדף הזה בתור מחרוזת JSON.
- parsetree
- עץ פענוח XML של הקלט.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): categories, encodedjsconfigvars, jsconfigvars, modules, parsetree, properties, ttl, volatile, wikitext
- includecomments
האם לכלול הערות HTML בפלט.
- סוג: בוליאני (פרטים)
- showstrategykeys
האם לכלול מידע על אסטרטגיית מיזוג פנימית ב־jsconfigvars.
- סוג: בוליאני (פרטים)
- generatexml
- מיושן.
יצירת עץ פענוח XML (מוחלף ב־prop=parsetree).
- סוג: בוליאני (פרטים)
דוגמה:
- לפרוס את קוד הוויקי {{Project:Sandbox}}.
- api.php?action=expandtemplates&text={{Project:Sandbox}} [פתיחה בארגז חול]