Manual:Developing extensions/fr



Chaque extension se compose de trois parties :


 * 1) Installeur
 * 2) Exécution
 * 3) Emplacement

Une extension minimale se compose de trois fichiers, une pour chaque partie :


 * MyExtension/extension.json: Stocke les instructions de l'installateur. Le nom du fichier doit être "extension.json". (Pour les versions antérieurs à MédiaWiki 1.25 les instructions d'installation se trouvent dans un fichier  nommé d'après l'extension. Plusieurs extensions peuvent avoir des fonctionnalités rétro-compatibles dans ce fichier PHP.)
 * MyExtension/MyExtension_body.php: Stocke le code d'exécution pour l'extension. Le nom de fichier "MonExtension_body.php" est conventionnel mais non requis. Si votre extension est complexe et implique plusieurs fichiers PHP, vous devez suivre la convention de placer son code d'implémentation dans un sous-répertoire nommé  (bien que l'extension Exemple ne suive pas cette convention). Par exemple, regardez l'extension SemanticMediaWiki
 * MyExtension/i18n/*.json: Stocke l'information d'emplacement de l'extension.

Lorsque vous développez une extension, remplacez "MyExtension" ci-dessus par le nom de votre extension. Utilisez les noms UpperCamelCase pour son répertoire et son/ses fichiers PHP; ce sont les conventions générales de nommage des fichiers. (l' est un bon point d'entrée pour commencer les entensions. Vous pouvez aussi prendre en compte l'utilisation de MWStew pour le génération de votre extension boilerplate. Voir aussi le modèle cookiecutter pour les extensions MediaWiki sur GitHub).

Les trois parties d'une extension, la configuration, l'exécution, et l'internationalisation tout comme les types d'extensions, la licence et la publication de votre extension sont décrits dans les sections suivantes de cette page.

Configuration
Votre but en écrivant la partie de configuration est de consolider l'initialisation des paramètres pour que les utilisateurs qui installent votre extension n'aient rien à faire d'autre que d'inclure le fichier de configuration dans leur fichier, comme cela :

Si vous voulez rendre votre extension configurable par l'utilisateur, vous devez définir et documenter certains paramètres de configuration et le setup utilisateur devrait ressembler à ceci :

Pour atteindre cette simplicité, votre fichier setup doit effectuer un certain nombre de tâches (décrites en détails dans les sections suivantes) :


 * enregistrer tout pilote de média, fonction d'analyseur, page spéciale, balise XML personnalisée, et la variable utilisée par votre extension.
 * define and/or validate any configuration variables you have defined for your extension.
 * préparer les classes utilisées par votre extension pour l'auto-chargement
 * determine what parts of your setup should be done immediately and what needs to be deferred until the MediaWiki core has been initialized and configured
 * définir toutes les accroches supplémentaires nécessaires à votre extension
 * créez ou vérifiez toutes les nouvelles tables de la base de données, nécessaires à votre extension.
 * configurez l'internationalisation de votre extension

Enregistrement des fonctionalités avec MediaWiki
MediaWiki lists all the extensions that have been installed on its  page. A titre d'exemple, vous pouvez voir toutes les extensions installées sur ce wiki en Special:Version. It is good form to make sure that your extension is also listed on this page. To do this, you will need to add an entry to for each media handler, parser function, special page, custom XML tag, and variable used by your extension. The entry will look something like this:

Voir pour les détails complets de la signification de ces champs. Beaucoup de ces champs sont optionnels, mais il est encore bon de les remplir. The  refers to the version of the schema the  file is written against. As of now (January 2018) versions available are 1 and 2. See here for the documentation on this feature.

In addition to the above registration, you must also "hook" your feature into MediaWiki. Ce qui figure ci-dessus ne configure que la page Special:Version. La manière dont vous faites cela dépend du type de votre extension. Pour les détails, voyez la documentation de chaque type d'extension :

Rendre votre extension configurable par l'utilisateur
If you want your user to be able to configure your extension, you'll need to provide one or more configuration variables. C'est une bonne idée que de donner à ces variables un nom unique. They should also follow MediaWiki naming conventions (e.g. global variables should begin with $wg).

For example, if your extension is named "Very silly extension that does nothing", you might want to name all your configuration variables to begin  or. It doesn't really matter what you choose so long as none of the MediaWiki core begins its variables this way and you have done a reasonable job of checking to see that none of the published extensions begin their variables this way. Users won't take kindly to having to choose between your extension and some other extensions because you chose overlapping variable names.

It is also a good idea to include extensive documentation of any configuration variables in your installation notes.

Here is an example boiler plate that can be used to get started:

Note that after calling  the global variable   does not exist. If you set the variable, e.g. in  then the value given in the will not be used.

Préparer des classes pour l'auto-chargement
Si vous choisissez des classes pour implémenter votre extension, Mediawiki fournit un mécanisme simplifié pour aider PHP à trouver le fichier source dans lequel se trouve votre classe. Dans la plupart des cas cela évite d'écrire votre propore méthode d'.

Pour utiliser le mécanisme d'auto-chargement de MediaWiki, ajoutez les entrées dan sle champ. La clé de chaque entrée est le nom de la classe; la valeur est le fichier qui héberge la définition de la classe. For a simple one class extension, the class is usually given the same name as the extension, so your autoloading section might look like this (extension is named MyExtension):

The filename is relative to the directory the extension.json file is in.

Définir des accroches supplémentaires
Voir.

Ajouter des tables dans la base de données
If your extension needs to add its own database tables, use the hook. See the manual page for more information on usage.

Configurer l'internationalisation
Voir:
 * Localisation (summary)
 * Localisation (detailed)
 * Namespaces

Ajouter des journaux
On MediaWiki, all actions by users on wiki are tracked for transparency and collaboration. Voir pour savoir comment le faire.

Execution
The technique for writing the implementation portion depends upon the part of MediaWiki system you wish to extend:
 * Balisage Wiki : Extensions that extend wiki markup will typically contain code that defines and implements custom XML tags, parser functions and variables.
 * Reporting and administration: Extensions that add reporting and administrative capabilities usually do so by adding special pages. Pour davantage d'informations, voir.
 * Article automation and integrity: Extensions that improve the integration between MediaWiki and its backing database or check articles for integrity features, will typically add functions to one of the many hooks that affect the process of creating, editing, renaming, and deleting articles. For more information about these hooks and how to attach your code to them, please see.
 * Habillage et convivialité : Extensions that provide a new look and feel to MediaWiki are bundled into skins. For more information about how to write your own skins, see and.
 * Sécurité: Extensions that limit their use to certain users should integrate with MediaWiki's own permissions system. To learn more about that system, please see . Some extensions also let MediaWiki make use of external authentication mechanisms. Pour davantage d'informations, voir . In addition, if your extension tries to limit readership of certain articles, please check out the gotchas discussed in.

Voir aussi ,

Localisation
If you want your extension to be used on wikis that have a multi-lingual readership, you will need to add localisation support to your extension.

Enregistrer les messages dans .json
Enregistrer les définitions de messages dans un fichier d'internationalisation JSON, un par clé de langue dans laquelle votre extension a été traduite. Les messages sont enregistrés avec une clé de message et le message lui-même, en utilisant le format standard JSON. Chaque identifiant de message doit être en minuscules et ne doit pas contenir d'espaces. An example you can find e.g. in extension MobileFrontend. Here is an example of a minimal JSON file (in this case en.json:

en.json

Enregistrer la documentation des messages dans qqq.json
The documentation for message keys can be stored in the JSON file for the pseudo language with code qqq. A documentation of the example above can be:

qqq.json:

Definir des messages

 * Assign each message a unique, lowercase, no space message id; e.g.uploadwizard-desc
 * For any text string displayed to the user, define a message.
 * MediaWiki supports parameterized messages and that feature should be used when a message is dependent on information generated at runtime. Parameter placeholders are specified with $n, where n represents the index of the placeholder; e.g.

Définir la documentation du message
Each message you define needs to have an associated message documentation entry Message documentation; in qqq.json e.g.

Charger le fichier d'internationalisation
In your setup routine, define the location of your messages files (e.g. in directory i18n/):

Utilisation de wfMessage dans PHP
In your setup and implementation code, replace each literal use of the message with a call to. In classes that implement (as well as some others such as subclasses of SpecialPage), you can use   instead. Exemple:

Utiliser mw.message sous JavaScript
Il est aussi possible d'utiliser les fonctions i18n dans JavaScript. Voir pour les détails.

Types d'extensions
Extensions can be categorized based on the programming techniques used to achieve their effect. Most complex extensions will use more than one of these techniques:
 * Sous-classement: MediaWiki expects certain kinds of extensions to be implemented as subclasses of a MediaWiki-provided base class:
 *  – Subclasses of the class are used to build pages whose content is dynamically generated using a combination of the current system state, user input parameters, and database queries. Both reports and data entry forms can be generated. They are used for both reporting and administration purposes.
 *  – Skins change the look and feel of MediaWiki by altering the code that outputs pages by subclassing the MediaWiki class.
 *  – A technique for injecting custom php code at key points within MediaWiki processing. They are widely used by MediaWiki's parser, its localization engine, its extension management system, and its page maintenance system.
 *  – XML style tags that are associated with a php function that outputs HTML code. You do not need to limit yourself to formatting the text inside the tags. You don't even need to display it. Many tag extensions use the text as parameters that guide the generation of HTML that embeds google objects, data entry forms, RSS feeds, excerpts from selected wiki articles.
 *  – A technique for mapping a variety of wiki text string to a single id that is associated with a function. Both variables and parser functions use this technique. All text mapped to that id will be replaced with the return value of the function. The mapping between the text strings and the id is stored in the array $magicWords. The interpretation of the id is a somewhat complex process – see  for more information.
 *  – Variables are something of a misnomer. They are bits of wikitext that look like templates but have no parameters and have been assigned hard-coded values. Standard wiki markup such as or  are examples of variables. They get their name from the source of their value: a php variable or something that could be assigned to a variable, e.g. a string, a number, an expression, or a function return value.
 *  – .  Similar to tag extensions, parser functions process arguments and returns a value. Unlike tag extensions, the result of parser functions is wikitext.
 *  – you can add custom modules to MediaWiki's action API, that can be invoked by JavaScript, bots or third-party clients.
 *  – If you need to store data in formats other than wikitext, JSON, etc. then you can create a new.

Support des autres versions du coeur
There are two widespread conventions for supporting older versions of MediaWiki core:

Extension maintainers should declare with the  parameter of the Extension template which convention they follow.
 * Master: the master branch of the extension is compatible with as many old versions of core as possible. This results in a maintenance burden (backwards-compatibility hacks need to be kept around for a long time, and changes to the extension need to be tested with several versions of MediaWiki), but sites running old MediaWiki versions benefit from functionality recently added to the extension.
 * Release branches: release branches of the extension are compatible with matching branches of core, e.g. sites using MediaWiki need to use the  branch of the extension. (For extensions hosted on gerrit, these branches are automatically created when new versions of MediaWiki are released.) This results in cleaner code and faster development but users on old core versions do not benefit from bugfixes and new features unless they are backported manually.

Publication
To autocategorize and standardize the documentation of your existing extension, please see. To add your new extension to this Wiki:

Deploiement et enregistrement
If you intend to have your extension deployed on Wikimedia sites (including possibly Wikipedia), additional scrutiny is warranted in terms of performance and security. Consulter.

If your extension adds namespaces, you may wish to register its default namespaces; likewise, if it adds database tables or fields, you may want to register those at.

Please be aware that review and deployment of new extensions on Wikimedia sites can be extremely slow, and in some cases has taken more than two years.

Documentation d'aide
You should provide public-domain help documentation for features provided by your extension. est un bon exemple. You should give users a link to the documentation via the function.

Fournir du support / collaborer
Extension developers should open an account on Wikimedia's, and request a new project for the extension. This provides a public venue where users can submit issues and suggestions, and you can collaborate with users and other developers to triage bugs and plan features of your extension.

Voir aussi

 * – implements some example features with extensive inline documentation
 * – une extension Boilerplate fonctionnelle, utile comme point de départ pour votre propre extension
 * Lisez l'extension Example, basez votre propre code sur l'extension BoilerPlate.
 * cookiecutter-mediawiki-extension – a template for the python tool cookiecutter to generate a boilerplate extension (with variables etc.)
 * Vous permet d'avancer rapidement avec votre propre extension. Peut aussi générer l'extension BoilerPlate.
 * - copier le code spécifique à partir d'eux
 * – explique comment votre extension peut fournir une API aux clients
 * Meilleures pratiques pour les extensions
 * Meilleures pratiques pour les extensions
 * Meilleures pratiques pour les extensions
 * Meilleures pratiques pour les extensions
 * Meilleures pratiques pour les extensions