テンプレート:Extension
Template documentationThis template should be added to all extension pages on this wiki (but only the main page). It will add a useful infobox (see below) and will automatically add the extension to Category:All extensions, along with the appropriate status and implementation type categories.
目次
Usage[編集]
|
Copy and paste: {{Extension|templatemode =
|name =
|status =
|type1 =
|type2 =
|hook1 =
|hook2 =
|username =
|author =
|description =
|image =
|imagesize =
|version =
|update =
|mediawiki =
|php =
|needs-updatephp =
|schema-registry =
|license =
|download =
|readme =
|changelog =
|parameters =
|tags =
|rights =
|example =
|compatibility =
|bugzilla =
}}
For help with parameter values, see below. |
| ||||||||||||||||||||||||||||||||||||||||||||||||||
Content parameters[編集]
This section describes parameters that govern infobox content. For help with templatemode and other control parameters, please see Control parameters.
| Parameter | Description |
|---|---|
| name | name of the extension |
| status | current release status
One of:
If the status is anything other than the above, it will be ignored and the default value of 'Unknown' will be displayed in the template instead. In cases where the value is omitted, it will be categorized as unknown. In cases where the value is invalid, it will be placed in a special category so that the error can be caught and fixed. |
| type1 type2 type3 type4 type5 type6 |
implementation type
The implementation strategy(s) employed in building this extension. This parameter is used to create categories that help programmers find examples of various MediaWiki specific implementation strategies or patterns. Although the values of this parameter sometimes coincide with the use case or purpose of an extension, that is not reason for this parameter. If the values you have chosen for this parameter do not adequately identify the purpose or possible use cases, we recommend you add additional category links as needed.
We are in the process of revising the values of this page. Types below this point are likely to be deprecated or redefined. We apologize for the inconvenience. See the talk on type taxonomy for more information.
Any other value for 'type' is invalid, and will cause the extension to be placed in Category:Extensions with invalid or missing type. Note: Many extensions have more than one type, if this applies to yours, replace |
| hook1 hook2 hook3 hook4 ... hook30 |
name of each hook used by the extension
Entering values in this field is a good way to get exposure for your extension and help other developers. Each documented hook will automatically add the extension to a category listing extensions that use that hook. This category is autolinked to each hook article so that programmers can easily find examples of extensions that use a particular hook. For built-in hooks:
For custom hooks defined by extensions:
For multiple hooks, assign the first hook to hook1, the second to hook2 and so on. |
| username | The author's username on MediaWiki.org (if they have one). May be omitted, but if present it will be used to link to the author's user & user_talk page. It should be provided without namespace and without [[]]s. |
| The extension author's name, if different from their MediaWiki.org username. Free text. If omitted then the 'username' field will be used (if present). | |
| description | short description |
| image | screenshot or logo of extension. It should be provided without namespace and without [[]]s. |
| imagesize | facultative, size of the image (default size is 220px) |
| version | last version |
| update | date of the last update |
| mediawiki | required version of MediaWiki |
| php | required version of PHP |
| needs-updatephp | yes indicates that the extension requires a database table schema change or a similar action, before the MediaWiki can run. It is a common pitfall: your MediaWiki will stall, if you forgot to run update.php - if the extension requires it.
Extensions which conform to MediaWiki extension standards come with a schema change script which you need to start manually (once) before starting and accessing the MediaWiki through your browser, and after you copied all the extension files to $IP/extensions/ExtensionName and inserted require_once( "$IP/extensions/ExtensionName" ) to $IP/LocalSettings.php: php $IP/maintenance/update.php $IP stands for the Installation Path (or "directory") of your MediaWiki installation, the same directory that holds LocalSettings.php, index.php etc..
|
| schema-registry | yes indicates that the extension's schema changes are registered at Database table and field registration. |
| license | license(s) governing use of this extension, e.g. GPL |
| download | link to the download : SVN, {{WikimediaDownload}} with server=gerrit, or other. If you put the code into page in the MediaWiki wiki, link to it using a full page name and section name, e.g. [[Extension:Example/version_1.22a#Code]] (it must remain valid when bot-copied elsewhere)
|
| readme | external link to the readme file, e.g. http://svn.wikimedia.org/svnroot/mediawiki/trunk/extensions/Sort/README |
| changelog | external link to the changelog file, e.g. Extension:LDAP Authentication/Changelog |
| parameters | available parameters for LocalSettings.php |
| any tags your extension uses (e.g. <tag1>, <tag2>). | |
| rights | rights added by the extension. Not to be confused with the license! Rights are such as makebot or desysop, not such as GFDL or LGPL or GPL - those are licenses! |
| namespace | namespace in which this extension is used |
| example | example, website or screenshot of working extension |
| compatibility | compatibility chart, e.g. Template:Extension Testing |
| bugzilla | Bugzilla MediaWiki extension component name |
| CheckUsageNameOverride | override the page name used for the check usage link. |
Control parameters[編集]
| Parameter | Description |
|---|---|
| templatemode | Controls auto-categorization of host page.
Normally left blank. Alternate values are:
|
Using the infobox[編集]
Existing extension pages[編集]
If you want to add the infobox to an existing page, copy and paste the code at the top of this page.
Create a new extension article[編集]
If you want to create a new extension page, enter the name below and click the button. A new page will be created with the infobox template already in place.
Please replace "MyExtension" with your extension's name:
MediaWiki is an open-source project and users are encouraged to make any MediaWiki extensions under an Open Source Initiative (OSI) approved GPLv2 compatible license (including MIT, BSD, PD). For extensions that have a compatible license, you can request developer access to the MediaWiki source repositories for extensions and get a new repository created for you. Alternatively, you may also post your code directly on your extension's page, although that is not the preferred method.
A developer sharing their code on the MediaWiki wiki or code repository should expect:
- Feedback / Criticism / Code reviews
- Review and comments by other developers on things like framework use, security, efficiency and usability.
- Developer tweaking
- Other developers modifying your submission to improve or clean-up your code to meet new framework classes and methods, coding conventions and translations.
- Improved access for wiki sysadmins
- If you do decide to put your code on the wiki, another developer may decide to move it to the MediaWiki code repository for easier maintenance. You may then request commit access to continue maintaining it.
- Future versions by other developers
- New branches of your code being created by other developers as new versions of MediaWiki are released.
- Merger of your code into other extensions with duplicate or similar purposes — incorporating the best features from each extension.
- Credit
- Credit for your work being preserved in future versions — including any merged extensions.
- Similarly, you should credit the developers of any extensions whose code you borrow from — especially when performing a merger.
Any developer who is uncomfortable with any of these actions occurring should not host their code directly on the MediaWiki wiki or code repository. You are still encouraged to create a summary page for your extension on the wiki to let people know about the extension, and where to download it. You may also add the {{Extension exception}} template to your extension requesting other developers refrain from modifying your code, although no guarantees can be made that an update will be made if deemed important for security or compatibility reasons. You may use the current issues noticeboard if you feel another developer has violated the spirit of these expectations in editing your extension.
Enhancing this template[編集]
If you would like to improve on this template, thanks! This is a complicated template so here is some help along the way:
Fixing documentation[編集]
If you would like to fix documentation, please be aware that documentation and code is split into two files:
- Template:Extension/Doc - stores all documentation.
- Template:Extension - stores only the code for the template and a small amount of non-included material (category links, transcluded documentation link).
In addition, Template:Extension/Sample stores the boiler plate that is preloaded into newly created pages and contains some basic documentation on how to fill in the template parameters. It needs to be kept in sync with Template:Extension/Doc.
The Create extension button[編集]
To improve the create extension button behavior:
- Template:Extension/Sample: The boilerplate extension that is preloaded into newly-created pages.
- Template:Extension/CreateExtensionInputBox: An input box that can be inserted wherever you want users to easily create extensions. For documentation on the
<inputbox>tag, please see Extension:InputBox. - Extension:MyExtension: - Defines a placeholder, in case a user accidentally hits the create button without changing the extension name.
Infobox parameters[編集]
In general:
- To make this template easy to use, each label in the infobox is linked to documentation on the template parameter(s) it displays. If you add a parameter, please be sure to also add it to the content parameter documentation and link its label to that documentation.
To change/correct/add to the implementation type parameters:
- Check the talk page - there have been some extensive discussions about this field.
- Template:Extension/TypeSwitch: Stores the possible values for the type field. Multiple values are implemented by calling this template with Template:Foreach.
- Template:Extension/TypeSwitchNoCats: Does not need to be modified when adding a new type. Used instead of Template:Extension/TypeSwitch when this template is used in
templatemode=nocats. Templates used with Template:Foreach can only take one parameter so we need to wrap the call to Template:Extension/TypeSwitch with another template that sets the mode. - Template:Extension/Doc: Documentation for this template needs to be kept in sync with any changes to the implementation type taxonomy.
To change the behavior of the hook parameters:
- Template:Extension/HookInUse: Adds links and categories for a hook in use. Multiple hooks in use are implemented by calling this template with Template:Foreach.
- Template:Extension/HookInUseNoCats: Used instead of Template:Extension/HookInUse when this template is used in
templatemode=nocats. Templates used with Template:Foreach can only take one parameter so we need to wrap the call to Template:Extension/HookInUse with another template that sets the mode.
Test case[編集]
See if the following pages are still ok, after edited this template.
- Extension:Description2
- Template:Extension
| The above documentation is transcluded from テンプレート:Extension/doc. (edit | history) Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages. Please add categories to the /doc subpage. Subpages of this template. |
| Language: | English • 日本語 |
|---|
