Manual:Developing extensions/it



Ogni estensione consiste in tre parti:


 * 1) Configurazione
 * 2) Esecuzione
 * 3) Localizzazione

Un'estensione minimale consisterà in tre file, uno per ogni parte:


 * MyExtension/extension.json: Salva le istruzioni d'installazione. Il nome del file deve essere extension.json. (In versioni anteriori a MediaWiki 1.25, le istruzioni di installazione stavano in file  con il nome dell'estensione. Molte estensioni hanno ancora retro-compatibilità con questo file PHP.)
 * MyExtension/MyExtension_body.php: Salva il codice di esecuzione dell'estensione. Il nome del file MyExtension_body.php è una convenzione ma non è obligatorio. Se la tua estensione è complessa e coinvolge più file PHP, dovresti seguire la convenzione per inserire il suo codice di implementazione in una sottodirectory denominata  (sebbene l'estensione Esempio non segua questa convenzione). Per esempio, vedi l'estensione.
 * MyExtension/i18n/*.json: Salva le informazioni di localizzazione dell'estensione.

Quando sviluppi un'estensione, sostituisci la scritta MyEstension con il nome della tua estensione. Usa nomi nella convenzione UpperCamelCase per la cartella e per i tuoi file PHP. Questa è la convenzione generale per i nomi dei file. (L' è un buon punto di partenza per la tua estensione.Puoi anche considerare l'utilizzo di MWStew per generare la tua estensione boilerplate. Controlla anche il cookiecutter template per Estensioni MediaWiki su GitHub.)

Le tre parti di un'estensione, installazione, esecuzione e localizzazione così come i tipi di estensione e la licenza e la pubblicazione della tua estensione sono descritte nelle sezioni che seguono in questa pagina.

Installazione
Il tuo obiettivo nello scrivere la parte di configurazione è consolidare l'impostazione in modo che gli utenti che installano la tua estensione non debbano fare altro che includere il file di installazione nel loro file, in questo modo:

Se vuoi rendere l'estensione configurabile all'utente, devi definire e documentare alcuni parametri di configurazione e la configurazione dell'utente dovrebbe assomigliare a questa:

Per raggiungere questa semplicità, il file di installazione deve svolgere una serie di attività (descritte in dettaglio nelle seguenti sezioni):


 * registra qualsiasi gestore multimediale, funzione parser, pagina speciale,  tag XML personalizzato e  variabili utilizzate dalla tua estensione.
 * define and/or validate any configuration variables you have defined for your extension.
 * prepare the classes used by your extension for autoloading
 * 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
 * define any additional hooks needed by your extension
 * create or check any new database tables required by your extension.
 * set up localisation for your extension

Registering features with MediaWiki
MediaWiki lists all the extensions that have been installed on its  page. For example, you can see all the extensions installed on this wiki at 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:

See for full details on what these fields do. Many of the fields are optional, but it's still good practice to fill them out. 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. The above only sets up the Special:Version page. The way you do this depends on the type of your extension. For details, please see the documentation for each type of extension:

Making your extension user configurable
If you want your user to be able to configure your extension, you'll need to provide one or more configuration variables. It is a good idea to give those variables a unique name. 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.

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

Adding database tables
If your extension needs to add its own database tables, use the hook. Vedere la pagina del manuale per più informazione in uso.

Installare localizzazione
Vedi:
 * Localizzazione (riassumono)
 * Localizzazione (detallado)
 * Namespaces

Aggiungere registri
In MediaWiki, tutte le azioni per gli utenti in wiki è seguito per trasparenza e collaborazione. Vedere ferma come farlo.

Esecuzione
The technique for writing the implementation portion depends upon the part of MediaWiki system you wish to extend:
 * Wiki markup: Extensions that extend wiki markup will typically contain code that defines and implements custom XML tags, parser functions and variables.
 * Riporti e amministrazione: Extensions that add reporting and administrative capabilities usually do so by adding special pages. Per più informazzione, vedere.
 * Articolo automazione e l'integrità: 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. Per ulteriori informazioni su questi ganci e come collegare il codice per loro, vedere.
 * Mirare e sentire: Extensions that provide a new look and feel to MediaWiki are bundled into skins. Ferma più informazione approssimativamente come per scrivere le sue pelli proprie, vedere e.
 * Sicurezza: Estensioni che limitano l'uso di determinati utenti dovrebbero integrarsi con proprio sistema di permessi di MediaWiki. Per ulteriori informazioni su questo sistema, vedere . Alcune estensioni consentono anche MediaWiki fanno uso di meccanismi di autenticazione esterni. Per più informazzione, vedere . Inoltre, se l'estensione cerca di limitare lettori di alcuni articoli, si prega di consultare i trucchi discussi in.

Vedi anche ,

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

Caricare il file di localizzazione
In your setup routine, define the location of your messages files (e.g. in directory i18n/):

Uso di 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. Esempio:

Uso di mw.message in Javascript
È possibile di utilizzare i18n funzioni in Javascript anche. Mira per dettagli.

Tipi di estensione
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. Essi sono ampiamente utilizzati dai parser di MediaWiki, il suo motore di localizzazione, il suo sistema di gestione estensione, e il suo sistema pagina di manutenzione.
 *  – XML style tags that are associated with a php function that outputs HTML code. Non è necessario limitarsi a formattare il testo all'interno dei tag. Non c'è nemmeno bisogno di visualizzarlo. 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. Le estensioni delle etichette sono differenti, il risultato delle funzioni è il wikitexto.
 *  – 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.

Pubblicazione
To autocategorize and standardize the documentation of your existing extension, please see. Per aggiungere la tua nuova estensione a questa Wiki:

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

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.

Documentazione del aggiunto
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.

Vedi anche

 * – 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 template for the python tool cookiecutter to generate a boilerplate extension (with variables etc.)
 * Allow you to get going quickly with your own extension. Può anche generare l'estensione Boilerplate.
 * - copiare il codice specifico da loro
 * – spiega come l'estensione in grado di fornire una API per i clienti
 * Best practices for extensions
 * Best practices for extensions
 * Best practices for extensions
 * Best practices for extensions
 * Best practices for extensions