راهنمای واسط برنامه‌نویسی کاربردی مدیاویکی

این یک صفحهٔ مستندات برای واسط برنامه‌نویسی کاربردی مدیاویکی است که به‌طور خودکار ایجاد شده‌است.

مستندات و نمونه‌ها: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

list=search (sr)

(main | query | search)
  • این پودمان نیازمند اختیارات خواندن است.
  • This module can be used as a generator.
  • منبع: MediaWiki
  • مجوز: GPL-2.0-or-later

Perform a full text search.

پارامترها:
srsearch

Search for page titles or content matching this value. You can use the search string to invoke special search features, depending on what the wiki's search backend implements.

این پارامتر الزامی است.
srnamespace

Search only within these namespaces.

مقدارهای (جداشده با | یا جایگزین‌های آن): 0، 1، 2، 3، 4، 5، 6، 7، 8، 9، 10، 11، 12، 13، 14، 15، 710، 711، 828، 829، 2300، 2301، 2302، 2303، 3002، 3003، 3004، 3005
برای تعیین همهٔ مقدارها از * استفاده کنید.
پیش‌فرض: 0
srlimit

How many total pages to return.

نوع: عدد صحیح یا max
The value must be between ۱ and ۵۰۰.
پیش‌فرض: 10
sroffset

When more results are available, use this to continue.

نوع: عدد صحیح
پیش‌فرض: 0
srqiprofile

Query independent profile to use (affects ranking algorithm).

classic
رتبه‌بندی بر پایهٔ تعداد پیوندهای دریافتی، تعدادی از الگوها، میان‌ویکی و تازه‌ساخت‌ها (templates/language/recency ممکن است در این ویکی تعریف نشده‌باشد).
classic_noboostlinks
رتبه بندی براساس برخی الگوها، زبان صفحه و زمان فعال شدن در این ویکی.
empty
رتبه بندی صرفا براساس ویژگی های جستجو (فقط برای دیباگ)
wsum_inclinks
جمع وزنی برپایه پیوندهای ورودی
wsum_inclinks_pv
Weighted sum based on incoming links and weekly pageviews
popular_inclinks_pv
رتبه‌بندی برپایهٔ بازدید صفحه
popular_inclinks
رتبه‌بندی برپایهٔ تعداد پیوند
engine_autoselect
اجازه بده موتور جستجو بهترین نمایه را برای به‌کارگیری تعیین کند.
یکی از مقدارهای زیر: classic، classic_noboostlinks، empty، engine_autoselect، popular_inclinks، popular_inclinks_pv، wsum_inclinks، wsum_inclinks_pv
پیش‌فرض: engine_autoselect
srwhat

Which type of search to perform.

یکی از مقدارهای زیر: nearmatch، text، title
srinfo

Which metadata to return.

مقدارهای (جداشده با | یا جایگزین‌های آن): rewrittenquery، suggestion، totalhits
پیش‌فرض: totalhits|suggestion|rewrittenquery
srprop

Which properties to return:

size
اندازهٔ صفحه به بایت را اضافه می‌کند.
wordcount
Adds the word count of the page.
timestamp
Adds the timestamp of when the page was last edited.
snippet
Adds a snippet of the page, with query term highlighting markup.
titlesnippet
Adds the page title, with query term highlighting markup.
redirecttitle
Adds the title of the matching redirect.
redirectsnippet
Adds the title of the matching redirect, with query term highlighting markup.
sectiontitle
Adds the title of the matching section.
sectionsnippet
Adds the title of the matching section, with query term highlighting markup.
isfilematch
Adds a boolean indicating if the search matched file content.
categorysnippet
Adds the matching category name, with query term highlighting markup.
score
منسوخ‌شده. Ignored.
hasrelated
منسوخ‌شده. Ignored.
extensiondata
Adds extra data generated by extensions.
مقدارهای (جداشده با | یا جایگزین‌های آن): categorysnippet، extensiondata، isfilematch، redirectsnippet، redirecttitle، sectionsnippet، sectiontitle، size، snippet، timestamp، titlesnippet، wordcount، hasrelated، score
پیش‌فرض: size|wordcount|timestamp|snippet
srinterwiki

Include interwiki results in the search, if available.

نوع: بولی (جزئیات)
srenablerewrites

Enable internal query rewriting. Some search backends can rewrite the query into another which is thought to provide better results, for instance by correcting spelling errors.

نوع: بولی (جزئیات)
srsort

Set the sort order of returned results.

یکی از مقدارهای زیر: create_timestamp_asc، create_timestamp_desc، incoming_links_asc، incoming_links_desc، just_match، last_edit_asc، last_edit_desc، none، random، relevance، user_random
پیش‌فرض: relevance