Miscellaneous documentation updates
Update references from .txt to .md when files have moved, a few other tweaks, no changes to code. Change-Id: I0bfd38c47b9fb0fc11ae98a0a674af66fb4c5a84
This commit is contained in:
parent
c09928cbcc
commit
2e3bdb3498
18 changed files with 26 additions and 26 deletions
|
|
@ -138,7 +138,7 @@ Assume class `Foo` has mostly non-static methods, and provides a static
|
|||
Assume class `Bar` calls `new Foo()`.
|
||||
* Add an instantiator function for `Foo` into ServiceWiring.php and add a
|
||||
`getFoo()` method to MediaWikiServices. Don't forget to add the appropriate
|
||||
test casesin MediaWikiServicesTest.
|
||||
test cases in MediaWikiServicesTest.
|
||||
* In the instantiator, replace any access to global state with calls
|
||||
to `$services->getXxx()` to get a service, or
|
||||
`$services->getMainConfig()->get()` to get a configuration setting.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
Introduction {#mainpage}
|
||||
Introduction
|
||||
===============================
|
||||
|
||||
Welcome to the MediaWiki autogenerated documentation system.
|
||||
|
|
|
|||
|
|
@ -62,4 +62,4 @@ getArticleID() needs some explanation: for "internal" articles, it should return
|
|||
the "page_id" field if the article exists, else it returns 0. For all external
|
||||
articles it returns 0. All of the IDs for all instances of Title created during
|
||||
a request are cached, so they can be looked up quickly while rendering wiki text
|
||||
with lots of internal links. See linkcache.txt.
|
||||
with lots of internal links. See LinkCache.md.
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@
|
|||
Fix type for <id> within <contributor> to "nonNegativeInteger"
|
||||
|
||||
Version 0.8 adds support for a <model> and a <format> tag for
|
||||
each revision. See contenthandler.txt.
|
||||
each revision. See contenthandler.md.
|
||||
|
||||
Version 0.9 adds the database name to the site information.
|
||||
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@
|
|||
Fix type for <id> within <contributor> to "nonNegativeInteger"
|
||||
|
||||
Version 0.8 adds support for a <model> and a <format> tag for
|
||||
each revision. See contenthandler.txt.
|
||||
each revision. See contenthandler.md.
|
||||
|
||||
Version 0.9 adds the database name to the site information.
|
||||
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@
|
|||
Fix type for <id> within <contributor> to "nonNegativeInteger"
|
||||
|
||||
Version 0.8 adds support for a <model> and a <format> tag for
|
||||
each revision. See contenthandler.txt.
|
||||
each revision. See contenthandler.md.
|
||||
|
||||
The canonical URL to the schema document is:
|
||||
http://www.mediawiki.org/xml/export-0.8.xsd
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@
|
|||
Fix type for <id> within <contributor> to "nonNegativeInteger"
|
||||
|
||||
Version 0.8 adds support for a <model> and a <format> tag for
|
||||
each revision. See contenthandler.txt.
|
||||
each revision. See contenthandler.md.
|
||||
|
||||
Version 0.9 adds the database name to the site information.
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Magic Words are some phrases used in the wikitext. They are used for two things:
|
|||
functions and accepts parameters.
|
||||
|
||||
The localized arrays keys are the internal name, and the values are an array,
|
||||
whose include their case-sensitivity and their alias forms. The first form
|
||||
which include their case-sensitivity and their alias forms. The first form
|
||||
defined is used by the program, for example, when moving a page and its old name
|
||||
should include #REDIRECT.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
<?php
|
||||
/**
|
||||
* See docs/magicword.txt.
|
||||
* See docs/magicword.md.
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
<?php
|
||||
|
||||
/**
|
||||
* See docs/magicword.txt.
|
||||
* See docs/magicword.md.
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
<?php
|
||||
/**
|
||||
* See docs/magicword.txt.
|
||||
* See docs/magicword.md.
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
|
|
|
|||
|
|
@ -89,7 +89,7 @@ use WikiPage;
|
|||
* require prepareContent or prepareUpdate to have been called first, to initialize the
|
||||
* DerivedPageDataUpdater.
|
||||
*
|
||||
* @see docs/pageupdater.txt for more information.
|
||||
* @see docs/pageupdater.md for more information.
|
||||
*
|
||||
* MCR migration note: this replaces the relevant methods in WikiPage, and covers the use cases
|
||||
* of PreparedEdit.
|
||||
|
|
@ -231,7 +231,7 @@ class DerivedPageDataUpdater implements IDBAccessObject, LoggerAwareInterface {
|
|||
* A stage identifier for managing the life cycle of this instance.
|
||||
* Possible stages are 'new', 'knows-current', 'has-content', 'has-revision', and 'done'.
|
||||
*
|
||||
* @see docs/pageupdater.txt for documentation of the life cycle.
|
||||
* @see docs/pageupdater.md for documentation of the life cycle.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
|
|
@ -243,7 +243,7 @@ class DerivedPageDataUpdater implements IDBAccessObject, LoggerAwareInterface {
|
|||
* XXX: Overkill. This is a linear order, we could just count. Names are nice though,
|
||||
* and constants are also overkill...
|
||||
*
|
||||
* @see docs/pageupdater.txt for documentation of the life cycle.
|
||||
* @see docs/pageupdater.md for documentation of the life cycle.
|
||||
*
|
||||
* @var array[]
|
||||
*/
|
||||
|
|
@ -322,7 +322,7 @@ class DerivedPageDataUpdater implements IDBAccessObject, LoggerAwareInterface {
|
|||
/**
|
||||
* Transition function for managing the life cycle of this instances.
|
||||
*
|
||||
* @see docs/pageupdater.txt for documentation of the life cycle.
|
||||
* @see docs/pageupdater.md for documentation of the life cycle.
|
||||
*
|
||||
* @param string $newStage the new stage
|
||||
* @return string the previous stage
|
||||
|
|
@ -342,7 +342,7 @@ class DerivedPageDataUpdater implements IDBAccessObject, LoggerAwareInterface {
|
|||
/**
|
||||
* Asserts that a transition to the given stage is possible, without performing it.
|
||||
*
|
||||
* @see docs/pageupdater.txt for documentation of the life cycle.
|
||||
* @see docs/pageupdater.md for documentation of the life cycle.
|
||||
*
|
||||
* @param string $newStage the new stage
|
||||
*
|
||||
|
|
@ -509,7 +509,7 @@ class DerivedPageDataUpdater implements IDBAccessObject, LoggerAwareInterface {
|
|||
* Some updates are performed based on the difference between the database state at the
|
||||
* moment this method is first called, and the state after the edit.
|
||||
*
|
||||
* @see docs/pageupdater.txt for more information on when thie method can and should be called.
|
||||
* @see docs/pageupdater.md for more information on when thie method can and should be called.
|
||||
*
|
||||
* @note After prepareUpdate() was called, grabCurrentRevision() will throw an exception
|
||||
* to avoid confusion, since the page's current revision is then the new revision after
|
||||
|
|
@ -718,7 +718,7 @@ class DerivedPageDataUpdater implements IDBAccessObject, LoggerAwareInterface {
|
|||
* The derived data prepared for revision creation may then later be re-used by doUpdates(),
|
||||
* without the need to re-calculate.
|
||||
*
|
||||
* @see docs/pageupdater.txt for more information on when thie method can and should be called.
|
||||
* @see docs/pageupdater.md for more information on when thie method can and should be called.
|
||||
*
|
||||
* @note Calling this method more than once with the same $slotsUpdate
|
||||
* has no effect. Calling this method multiple times with different content will cause
|
||||
|
|
@ -1051,7 +1051,7 @@ class DerivedPageDataUpdater implements IDBAccessObject, LoggerAwareInterface {
|
|||
* derived data e.g. in ApiPurge, RefreshLinksJob, and the refreshLinks
|
||||
* script.
|
||||
*
|
||||
* @see docs/pageupdater.txt for more information on when thie method can and should be called.
|
||||
* @see docs/pageupdater.md for more information on when thie method can and should be called.
|
||||
*
|
||||
* @note Calling this method more than once with the same revision has no effect.
|
||||
* $options are only used for the first call. Calling this method multiple times with
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
<?php
|
||||
/**
|
||||
* Representation of a title within %MediaWiki.
|
||||
* Representation of a title within MediaWiki.
|
||||
*
|
||||
* See title.txt
|
||||
* See Title.md
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
/**
|
||||
* Utility for exporting site entries to XML.
|
||||
* For the output file format, see docs/sitelist.txt and docs/sitelist-1.0.xsd.
|
||||
* For the output file format, see docs/sitelist.md and docs/sitelist-1.0.xsd.
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
/**
|
||||
* Utility for importing site entries from XML.
|
||||
* For the expected format of the input, see docs/sitelist.txt and docs/sitelist-1.0.xsd.
|
||||
* For the expected format of the input, see docs/sitelist.md and docs/sitelist-1.0.xsd.
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
|
|
|
|||
|
|
@ -31,7 +31,7 @@ use Wikimedia\WrappedStringList;
|
|||
/**
|
||||
* The main skin class which provides methods and properties for all other skins.
|
||||
*
|
||||
* See docs/skin.txt for more information.
|
||||
* See docs/Skin.md for more information.
|
||||
*
|
||||
* @ingroup Skins
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ class ExportSites extends Maintenance {
|
|||
public function __construct() {
|
||||
$this->addDescription( 'Exports site definitions the sites table to XML file' );
|
||||
|
||||
$this->addArg( 'file', 'A file to write the XML to (see docs/sitelist.txt). ' .
|
||||
$this->addArg( 'file', 'A file to write the XML to (see docs/sitelist.md). ' .
|
||||
'Use "php://stdout" to write to stdout.', true
|
||||
);
|
||||
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ class ImportSites extends Maintenance {
|
|||
public function __construct() {
|
||||
$this->addDescription( 'Imports site definitions from XML into the sites table.' );
|
||||
|
||||
$this->addArg( 'file', 'An XML file containing site definitions (see docs/sitelist.txt). ' .
|
||||
$this->addArg( 'file', 'An XML file containing site definitions (see docs/sitelist.md). ' .
|
||||
'Use "php://stdin" to read from stdin.', true
|
||||
);
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue