Manual:Developing extensions/ru



Каждое расширение состоит из трех частей:


 * 1) Установка
 * 2) Выполнение
 * 3) Локализация

Минимальное расширение будет состоять из трех файлов, по одному для каждой части:

вы должны следовать соглашению размещать свой код реализации в подкаталоге с именем  (хотя расширения Example не следует этому соглашению). Например, смотрите расширение SemanticMediaWiki.
 * MyExtension/extension.json: Хранит инструкции установки. Имя файла должно быть extension.json. (До MediaWiki 1.25 инструкции установки были в файле, (?)с таким же именем как у расширения. Многие расширения имеют прослойки обратной совместимости в этом PHP файле.)
 * MyExtension/MyExtension.php: Хранит код выполнения расширения Имя файла MyExtension.php является традиционным, но не обязательным. Если ваше расширение является сложным и включает в себя несколько PHP файлов,
 * MyExtension/i18n/*.json: Хранит информацию локализации для расширения.

При разработке расширения, замените MyExtension на имя вашего расширения. Используйте имена в стиле UpperCamelCase для директории и PHP файлов; это общее соглашение по именованию файлов. ( является хорошей отправной точкой для вашего расширения. Вы также можете рассмотреть возможность использования MWStew для генерации вашего шаблона расширения. Также посмотрите cookiecutter template для расширений MediaWiki на GitHub.)

Установка
Your goal in writing the setup portion is to make installing the extension as easy as possible, so users only have to add this line to LocalSettings.php:

Если вы хотите, чтобы ваше расширение было конфигурируемо, необходимо определить и документировать некоторые параметры конфигурации, и настройки ваших пользователей должны выглядеть следующим образом:

Для достижения этой простоты, ваш файл установки должен выполнить ряд задач (подробно описано в следующих разделах):


 * зарегистрировать все media handler, функции парсера, special page, тэги расширений, и переменные, используемые вашим расширением.
 * определить и/или проверить все(?any?) переменные конфигурации, которые вы определили для вашего расширения.
 * подготовить классы, используемые вашим расширением, для автозагрузки
 * определить, какие части вашей установки должны быть сделаны немедленно, и что должно быть отложено до тех пор, пока ядро ​​MediaWiki не будет инициализировано и сконфигурировано
 * определить дополнительные прерывания, требующиеся для вашего расширения
 * создать или проверить любые новые таблицы базы данных, необходимые для вашего расширения
 * установить локализацию для расширения

Регистрирующие функции в MediaWiki
MediaWiki перечисляет все установленные расширения на странице. Например, вы можете посмотреть все расширения, установленные на этой вики в Special:Version. Полезно также убедиться, что ваше расширение присутствует на этой странице.

Для этого вы должны добавить запись в $wgExtensionCredits для каждого media handler, функции парсера, специальной страницы, custom XML tag, и переменной, используемой вашим расширением. Запись будет выглядеть примерно так: См. что бы узнать, что эти поля делают.

To do this in newer versions, add the extension details to extension.json. The entry will look something like this:

Многие поля опциональные, но все-таки будет хорошо, если вы их заполните. ссылается на схему файла. As of now (January 2018) versions available are 1 and 2. See here for the documentation on this feature.

В дополнение к вышеописанной регистрации вы должны подцепить ваши фичи в MediaWiki. То, что описано устанавливает только страницу Special:Version. Способ, которым вы это делаете, зависит от типа вашего расширения. Детали смотри в документации для каждого типа расширения:

Делаем расширение конфигурируемым
Если вы хотите, чтобы пользователь мог настроить ваше расширение, вы должны предоставить некоторые конфигурационные переменные. А также хорошо бы им дать уникальные имена. Они также должны следовать соглашению по именованию в MediaWiki (например, глобальные переменные должны начинаться с $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.

For more details on how to use global variable inside custom extensions, please refer to.

Preparing classes for autoloading
If you choose to use classes to implement your extension, MediaWiki provides a simplified mechanism for helping PHP find the source file where your class is located. In most cases this should eliminate the need to write your own  method.

To use MediaWiki's autoloading mechanism, you add entries to the field. The key of each entry is the class name; the value is the file that stores the definition of the class. 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.

Defining additional hooks
See.

Adding database tables
Make sure the extension doesn't modify the core database tables. Instead, extension should create new tables with foreign keys to the relevant MW tables.

If your extension needs to add its own database tables, use the hook. See the manual page for more information on usage.

Set up localisation
См.:
 * Localisation (summary)
 * Localisation (detailed)
 * Namespaces

Add logs
On MediaWiki, all actions by users on wiki are tracked for transparency and collaboration. See for how to do it.

Локализация
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.

Store messages in .json
Store message definitions in a localisation JSON-file, one for each language key your extension is translated in. The messages are saved with a message key and the message itself using standard JSON format. Each message id should be lowercase and may not contain spaces. 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

Store message documentation in 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:

Define 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.

Define message documentation
Each message you define needs to have an associated message documentation entry Message documentation; in qqq.json e.g.

Load the localisation file
In your setup routine, define the location of your messages files (e.g. in directory i18n/):

Use wfMessage in 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. Пример:

Use mw.message in JavaScript
It's possible to use i18n functions in JavaScript too. Look at for details.

Extension types
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:
 * Subclassing: 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 other core versions
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.

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

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

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.

Help documentation
You should provide public-domain help documentation for features provided by your extension. is a good example. You should give users a link to the documentation via the function.

Providing support / collaboration
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.

См. также

 * – implements some example features with extensive inline documentation
 * – a functioning boilerplate extension, useful as a starting point for your own extension
 * Read the Example extension, base your own code on the BoilerPlate extension.
 * cookiecutter-mediawiki-extension – a cookiecutter template which generates a boilerplate extension (with variables etc.)
 * Allows you to get going quickly with your own extension.
 * Can also generate the BoilerPlate extension.
 * - copy specific code from them
 * – explains how your extension can provide an API to clients
 * Best practices for extensions
 * Best practices for extensions
 * Best practices for extensions
 * Best practices for extensions
 * Best practices for extensions