עזרה של MediaWiki API

זהו דף תיעוד של API שנוצר באופן אוטומטי.

תיעוד ודוגמאות: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

action=parse

(main | parse)
  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0-or-later

מפענח את התוכן ומחזיר פלט מפענח.

ר' את יחידת ה־prop השונות של action=query כדי לקבל מידע על הגרסה הנוכחית של הדף.

יש מספר דרכים לציין טקסט לפענוח:

  1. ציון דף או גרסה באמצעות page‏, pageid, או oldid.
  2. ציון התוכן במפורש, באמצעות text‏, title, ו־contentmodel.
  3. ציון רק של התקציר לפענוח. ל־prop צריך לתת ערך ריק.
פרמטרים:
title

שם הדף שהטקסט שייך אליו. אם זה מושמט, יש לציין את contentmodel, ו־API ישמש ככותרת.

text

הטקסט לפענוח. יש להשתמש ב־title או ב־contentmodel.

revid

מזהה גרסה, עבור {{REVISIONID}} ומשתנים דומים.

סוג: מספר שלם
summary

התקציר שצריך לפענח.

page

פענוח תוכן הדף הזה. לא יכול לשמש יחד עם text ו־title.

pageid

לפענח את התוכן של הדף הזה. דורס את page.

סוג: מספר שלם
redirects

אם page או pageid מוגדרים להפניה, לפתור אותה.

סוג: בוליאני (פרטים)
oldid

לפענח את התוכן של הגרסה הזאת. דורס את page ואת pageid.

סוג: מספר שלם
prop

אילו פריטי מידע לקבל:

text
נותן טקסט מפוענח של קוד הוויקי.
langlinks
נותן קישורי שפה בקוד הוויקי המפוענח.
categories
נותן קטגוריות בקוד ויקי מפוענח.
categorieshtml
נותן את גרסת ה־HTML של הקטגוריות.
links
נותן קישורים פנימיים בקוד הוויקי המפוענח.
templates
נותן תבניות בקוד הוויקי המפוענח.
images
נותן תמונות בקוד הוויקי המפוענח.
externallinks
מתן קישורים חיצוניים בקוד הוויקי המפוענח.
sections
מתן הפסקאות בקוד הוויקי המפוענח.
revid
הוספת מזהה הגרסה של הדף המפוענח.
displaytitle
הוספת הכותרת של קוד הוויקי המפוענח.
headhtml
נותן doctype מפוענח, תג <html> פותח, רכיב <head>, ותג <body> פותח של הדף.
modules
מתן יחידות ResourceLoader שמשמשות בדף. כדי לטעון, יש להשתמש בmw.loader.using(). יש לבקש את jsconfigvars או את encodedjsconfigvars יחד עם modules.
jsconfigvars
נותן משתני הגדרות של JavaScript שייחודיים לדף הזה. כדי להחיל, יש להשתמש בmw.config.set().
encodedjsconfigvars
נותן משתני הגדרות של JavaScript שייחודיים לדף הזה בתור מחרוזת JSON.
indicators
נותן את ה־HTML של מחווני מצב דף שמשמשים בדף.
iwlinks
מתן קישורי בינוויקי בקוד הוויקי המפוענח.
wikitext
מתן קוד הוויקי המקורי שפוענח.
properties
נותן מאפיינים שונים שמוגדרים בקוד הוויקי המפוענח.
limitreportdata
נותן דו"ח הגבלות בדרך מובנית. לא נותן שום נתונים כאשר מוגדר disablelimitreport.
limitreporthtml
נותן את גרסת ה־HTML של דו"ח ההגבלות. לא נותן שום נתונים כאשר מוגדר disablelimitreport.
parsetree
עץ פענוח XML של תוכן הגרסה (דורש מודל תוכן wikitext)
parsewarnings
נותן אזהרות שאירעו בזמן פענוח התוכן.
headitems
מיושן. נותן פריטים לשים ב־<head> של הדף.
ערכים (מופרדים באמצעות "|" או or תו חלופי): categories, categorieshtml, displaytitle, encodedjsconfigvars, externallinks, headhtml, images, indicators, iwlinks, jsconfigvars, langlinks, limitreportdata, limitreporthtml, links, modules, parsetree, parsewarnings, properties, revid, sections, templates, text, wikitext, headitems
ברירת המחדל: text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle|iwlinks|properties|parsewarnings
wrapoutputclass

מחלקה של CSS שתשמש לעטיפת פלט המפענח.

ברירת המחדל: mw-parser-output
pst

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

סוג: בוליאני (פרטים)
onlypst

לעשות התמרה לפני שמירה (pre-save transform‏, PST) על הקלט, אבל לא לפענח אותו. מחזיר את אותו קוד הוויקי אחרי החלת PST. תקף רק בשימוש עם text.

סוג: בוליאני (פרטים)
effectivelanglinks
מיושן.

כולל קישור שפה שמספקות הרחבות (לשימוש עם prop=langlinks).

סוג: בוליאני (פרטים)
section

לפענח רק את התוכן של הפסקה שזה מספרה.

כשצוין new, לפענח את text ואת sectiontitle כאילו נוספת פסקה חדשה לדף.

מותר להשתמש ב־new רק בעת שימוש ב־text.

sectiontitle

כותרת פסקה חדשה כאשר section הוא new.

בניגוד לעריכת דף, זה לא מתגבה ל־summary כשזה מושמט אם ריק.

disablepp
מיושן.

יש להשתמש ב־disablelimitreport במקום.

סוג: בוליאני (פרטים)
disablelimitreport

להשמיט את דו"ח הקדם־מעבד ("NewPP limit report") מפלט המפענח.

סוג: בוליאני (פרטים)
disableeditsection

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

סוג: בוליאני (פרטים)
disablestylededuplication

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

סוג: בוליאני (פרטים)
generatexml
מיושן.

יצירת עץ פענוח של XML (נדרש מודל תוכן wikitext; מוחלף ב־prop=parsetree).

סוג: בוליאני (פרטים)
preview

לפענח במצב תצוגה מקדימה.

סוג: בוליאני (פרטים)
sectionpreview

לפענח במצב תצוגה מקדימה של פסקה (מדליק גם את מצב תצוגה מקדימה).

סוג: בוליאני (פרטים)
disabletoc

להשמיט את תוכן העניינים בפלט.

סוג: בוליאני (פרטים)
useskin

להחיל את העיצוב שנבחר לפלט המפענח. יכול להשפיע על המאפיינים הבאים: langlinks, headitems, modules, jsconfigvars, indicators.

אחד מהערכים הבאים: monobook, timeless, vector
contentformat

תסדיר הסדרת תוכן שישמש לטקסט הקלט. תקף רק עם text.

אחד מהערכים הבאים: application/json, text/css, text/javascript, text/plain, text/x-wiki
contentmodel

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

אחד מהערכים הבאים: css, javascript, json, text, wikitext