Search translations

See name examples.

See alias examples.

{{PLURAL:$1|Example|Examples}}:

[$1 Schema], [$2 parameter examples]

Show examples of task parameters

Examples for using the function

Here are some hints and examples for accomplishing common tasks:

How does it work? Provide examples of this function's behavior.

Fetch the JSON of all navigation examples sourced from the StructuredNavigation extension

Further information and examples can be found on this [https://www.semantic-mediawiki.org/wiki/Help:Type_$1 help page].

This is an auto-generated MediaWiki API documentation page.

Documentation and examples: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

Retrieves the JSON of all navigation examples sourced from the StructuredNavigation extension. This will be from the version of the extension software that the wiki has installed.

Get the list of pages to work on by executing the specified query module.

<strong>Note:</strong> Generator parameter names must be prefixed with a "g", see examples.

#<!-- leave this line exactly as it is --> <pre>
# If a page contains one of these templates then its search score is multiplied by the configured percentage.
# Changes to this take effect immediately.
# The syntax is as follows:
#  * Everything from a "#" character to the end of the line is a comment.
#  * Every non-blank line is the exact template name to boost, namespace, case and everything, followed by a "|" character followed by a number followed by a "%" character.
# Examples of good lines:
# Template:Good|150%
# Template:Very Very Good|300%
# Template:Bad|50%
# Examples of non-working lines:
# Template:Foo|150.234234% <-- no decimal points allowed!
# Foo|150% <--- technically works, but for transclusions of the Foo page from the main namespace
# You can test configuration changes by performing a query prefixed with boost-templates:"XX" where XX is all of the templates you want to boost separated by spaces instead of line breaks.
# Queries that specify boost-templates:"XX" ignore the contents of this field.
 #</pre> <!-- leave this line exactly as it is -->

#<!-- leave this line exactly as it is --> <pre>
# This message lets you configure the settings of the "more like this" feature.
# Changes to this take effect immediately.
# The syntax is as follows:
#  * Everything from a "#" character to the end of the line is a comment.
#  * Every non-blank line is the setting name followed by a ":" character followed by the setting value
# The settings are:
#  * min_doc_freq (integer): Minimum number of documents (per shard) that need a term for it to be considered.
#  * max_doc_freq (integer): Maximum number of documents (per shard) that have a term for it to be considered.
#                  High frequency terms are generally "stop words".
#  * max_query_terms (integer): Maximum number of terms to be considered. This value is limited to $wgCirrusSearchMoreLikeThisMaxQueryTermsLimit (100).
#  * min_term_freq (integer): Minimum number of times the term appears in the input to doc to be considered. For small fields (title) this value should be 1.
#  * minimum_should_match (percentage -100% to 100%, or integer number of terms): The percentage of terms to match on. Defaults to 30%.
#  * min_word_len (integer): Minimal length of a term to be considered. Defaults to 0.
#  * max_word_len (integer): The maximum word length above which words will be ignored. Defaults to unbounded (0).
#  * fields (comma separated list of values): These are the fields to use. Allowed fields are title, text, auxiliary_text, opening_text, headings.
# Examples of good lines:
# min_doc_freq:2
# max_doc_freq:20000
# max_query_terms:25
# min_term_freq:2
# minimum_should_match:30%
# min_word_len:2
# max_word_len:40
# fields:text,opening_text
# </pre> <!-- leave this line exactly as it is -->

<div class="hlist plainlinks api-main-links">
* [[mw:Special:MyLanguage/API:Main_page|Documentation]]
* [[mw:Special:MyLanguage/API:Etiquette|Etiquette & usage guidelines]]
* [[mw:Special:MyLanguage/API:FAQ|FAQ]]
* [https://lists.wikimedia.org/postorius/lists/mediawiki-api.lists.wikimedia.org/ Mailing list]
* [https://lists.wikimedia.org/postorius/lists/mediawiki-api-announce.lists.wikimedia.org/ API Announcements]
* [https://phabricator.wikimedia.org/maniphest/query/GebfyV4uCaLd/#R Bugs & requests]
</div>
<strong>Status:</strong> The MediaWiki API is a mature and stable interface that is actively supported and improved. While we try to avoid it, we may occasionally need to make breaking changes; subscribe to [https://lists.wikimedia.org/hyperkitty/list/mediawiki-api-announce@lists.wikimedia.org/ the mediawiki-api-announce mailing list] for notice of updates.

<strong>Erroneous requests:</strong> When erroneous requests are sent to the API, an HTTP header will be sent with the key "MediaWiki-API-Error" and then both the value of the header and the error code sent back will be set to the same value. For more information see [[mw:Special:MyLanguage/API:Errors_and_warnings|API: Errors and warnings]].

<p class="mw-apisandbox-link"><strong>Testing:</strong> For ease of testing API requests, see [[Special:ApiSandbox]].</p>

#<!-- leave this line exactly as it is --> <pre>
# This message lets you configure the settings of the "Did you mean" suggestions.
# See also https://www.elastic.co/guide/en/elasticsearch/reference/current/search-suggesters-phrase.html
# Changes to this take effect immediately.
# The syntax is as follows:
#  * Everything from a "#" character to the end of the line is a comment.
#  * Every non-blank line is the setting name followed by a ":" character followed by the setting value
# The settings are :
#  * max_errors (integer): the maximum number of terms that will be considered misspelled in order to be corrected. 1 or 2.
#  * confidence (float): The confidence level defines a factor applied to the input phrase's score, which is used as a threshold for other suggestion candidates. Only candidates that score higher than the threshold will be included in the result. For instance, a confidence level of 1.0 will only return suggestions that score higher than the input phrase. If set to 0.0, the best candidate will be returned.
#  * min_doc_freq (float 0 to 1): The minimal threshold in number of documents a suggestion should appear in.
#                  High frequency terms are generally "stop words".
#  * max_term_freq (float 0 to 1): The maximum threshold in number of documents in which a term can exist in order to be included.
#  * prefix_length (integer): The minimal number of prefix characters that must match a term in order to be a suggestion.
#  * suggest_mode (missing, popular, always): The suggest mode controls the way suggestions are included.
# Examples of good lines:
# max_errors:2
# confidence:2.0
# max_term_freq:0.5
# min_doc_freq:0.01
# prefix_length:2
# suggest_mode:always
#
# </pre> <!-- leave this line exactly as it is -->