mediawiki-extensions-Cite/README.md

The Cite extension to MediaWiki provides a way for wiki editors to add references and footnotes to articles.

See [mw:Extension:Cite] for technical documentation on installing and configuring the extension.  See [mw:Help:Cite] for user documentation.

Cite is responsible for implementing the `<ref>` and `<references>` tags in wikitext.  Integrations are provided for the legacy wikitext parser, Parsoid, WikiEditor, VisualEditor, and the reading interface.

[mw:Extension:Cite]: https://www.mediawiki.org/wiki/Special:MyLanguage/Extension:Cite
[mw:Help:Cite]: https://www.mediawiki.org/wiki/Special:MyLanguage/Help:Cite
Clean up top-level docs * Include the README in generated JS docs. * Tweak stray top-level files to explain their role. Note that the wmf template forces these files to appear on the docs home page... Bug: T358641 Change-Id: If421414340903991f50a06a76551bd7cd2904c5e 2024-03-12 08:37:44 +00:00			`The Cite extension to MediaWiki provides a way for wiki editors to add references and footnotes to articles.`
Store references in page_props and cache This stores references in page_props during links update in compressed JSON form. If the size is too big, it's broken up in several parts to fit, which is very unlikely to occur more than once. When the data is retrieved from the db, it's always cached. If set in config, it's also saved in the cache on parse. If not, the cache is invalidated when references are modified. Uses cases include : section preview to also show refs defined elsewhere on the page (T124840) and MobileFrontend (T123328). For the later, this still needs API support (T123290). There's a soft dependency on the core change I0c73b3d181f32502da75687857ae9aeff731f559. Bug: T125329 Change-Id: I7b106254b8f264f93b0f0c9cfa89f65adeeea4f0 2016-01-25 16:52:46 +00:00
Clean up top-level docs * Include the README in generated JS docs. * Tweak stray top-level files to explain their role. Note that the wmf template forces these files to appear on the docs home page... Bug: T358641 Change-Id: If421414340903991f50a06a76551bd7cd2904c5e 2024-03-12 08:37:44 +00:00			`See [mw:Extension:Cite] for technical documentation on installing and configuring the extension. See [mw:Help:Cite] for user documentation.`
Store references in page_props and cache This stores references in page_props during links update in compressed JSON form. If the size is too big, it's broken up in several parts to fit, which is very unlikely to occur more than once. When the data is retrieved from the db, it's always cached. If set in config, it's also saved in the cache on parse. If not, the cache is invalidated when references are modified. Uses cases include : section preview to also show refs defined elsewhere on the page (T124840) and MobileFrontend (T123328). For the later, this still needs API support (T123290). There's a soft dependency on the core change I0c73b3d181f32502da75687857ae9aeff731f559. Bug: T125329 Change-Id: I7b106254b8f264f93b0f0c9cfa89f65adeeea4f0 2016-01-25 16:52:46 +00:00
Clean up top-level docs * Include the README in generated JS docs. * Tweak stray top-level files to explain their role. Note that the wmf template forces these files to appear on the docs home page... Bug: T358641 Change-Id: If421414340903991f50a06a76551bd7cd2904c5e 2024-03-12 08:37:44 +00:00			Cite is responsible for implementing the `<ref>` and `<references>` tags in wikitext. Integrations are provided for the legacy wikitext parser, Parsoid, WikiEditor, VisualEditor, and the reading interface.

			`[mw:Extension:Cite]: https://www.mediawiki.org/wiki/Special:MyLanguage/Extension:Cite`
			`[mw:Help:Cite]: https://www.mediawiki.org/wiki/Special:MyLanguage/Help:Cite`