Difference between revisions of "Template:Extension/doc"
Jump to navigation
Jump to search
→Content parameters: add, extend and update docu
>Shirayuki m (Undo revision 833601 by 166.182.3.144 (talk)) |
>Kghbln (→Content parameters: add, extend and update docu) |
||
| Line 181: | Line 181: | ||
| <span id="php">php</span>|| required version of PHP | | <span id="php">php</span>|| required version of PHP | ||
|- | |- | ||
| <span id="needs-updatephp">needs-updatephp</span>|| ''''' | | <span id="needs-updatephp">needs-updatephp</span>|| '''''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. '''''No''''' should be set as a value since this assures that the extension does not need update.php to be run and thus avoids uncertainty | ||
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 < | 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 <code>$IP/extensions/ExtensionName</code> and inserted <code>require_once "$IP/extensions/ExtensionName";</code> to "LocalSettings.php": | ||
php $IP/maintenance/update.php | php $IP/maintenance/update.php | ||
{{$IP}} | {{$IP}} | ||
|- | |||
| <span id="php">composer</span>|| '''''Yes''''' indicates that the extension supports and/or requires [[Composer]] for the installation process. '''''No''''' as a value should not be set since it is presently still the common procedure to do it without. | |||
|- | |- | ||
| <span id="table1">'''table1'''</span><br/>''table2''<br/>''table3''<br/>''table4''<br/>...<br/>''table30'' || '''name of each ''non-core'' table used by the extension''' | | <span id="table1">'''table1'''</span><br/>''table2''<br/>''table3''<br/>''table4''<br/>...<br/>''table30'' || '''name of each ''non-core'' table used by the extension''' | ||
| Line 195: | Line 197: | ||
| <span id="license">license</span>|| license(s) governing use of this extension, e.g. GPL | | <span id="license">license</span>|| license(s) governing use of this extension, e.g. GPL | ||
|- | |- | ||
| <span id="download">'''download'''</span>|| '''link to the download''' : [ | | <span id="download">'''download'''</span>|| '''link to the download''' : [https://git.wikimedia.org/project/mediawiki Git], {{tl|WikimediaDownload}} with server=svn in case it was not migrated from [http://svn.wikimedia.org/svnroot/mediawiki/trunk/extensions/ SVN]. If you put the code into page in the MediaWiki wiki, link to it using a full page name and section name, e.g. <code> <nowiki>[[Extension:Example/version_1.22a#Code]]</nowiki> </code> (it must remain valid when bot-copied elsewhere) | ||
|- | |- | ||
| <span id="readme">readme</span>|| external link to the readme file, e.g. http://svn.wikimedia.org/svnroot/mediawiki/trunk/extensions/Sort/README | | <span id="readme">readme</span>|| external link to the readme file, e.g. http://svn.wikimedia.org/svnroot/mediawiki/trunk/extensions/Sort/README | ||