Template:Api help/fr

From mediawiki.org
This page is a translated version of the page Template:Api help and the translation is 100% complete.

Documentation du modèle

Ce modèle transclue Special:ApiHelp/nom-module et décrit ce qui se passe.


[voir · discuter · modifier]

Ceci est la documentation de TemplateData pour ce modèle, utilisée par VisualEditor et autres outils.

Api help

This transcludes the API help page from “Special:ApiHelp” with a message box.

Template parameters[Edit template data]

This template prefers inline formatting of parameters.

API Method Name1

The name of the API method.

You can reference query submodules by using “module”+“submodule” (e.g.: “query+extracts”).

Auto value


{{Api help|query+extracts}} produces

prop=extracts (ex)

(main | query | extracts)

Returns plain-text or limited HTML extracts of the given pages.

Specific parameters:
Other general parameters are available.

How many characters to return. Actual text returned might be slightly longer.

Type: integer
The value must be between 1 and 1,200.

How many sentences to return.

Type: integer
The value must be between 1 and 10.

How many extracts to return. (Multiple extracts can only be returned if exintro is set to true.)

Type: integer or max
The value must be between 1 and 20.
Default: 20

Return only content before the first section.

Type: boolean (details)

Return extracts as plain text instead of limited HTML.

Type: boolean (details)

How to format sections in plaintext mode:

No formatting.
Wikitext-style formatting (== like this ==).
This module's internal representation (section titles prefixed with <ASCII 1><ASCII 2><section level><ASCII 2><ASCII 1>).
One of the following values: plain, raw, wiki
Default: wiki

When more results are available, use this to continue. More detailed information on how to continue queries can be found on mediawiki.org.

Type: integer

Vous ne pouvez pas transclure l'aide de plusieurs modules en une seule fois.