Jump to content

Extension:StandardWikitext

From mediawiki.org
MediaWiki extensions manual
StandardWikitext
Release status: experimental
Description Standardizes wikitext after each page save
Author(s) Sophivorustalk
Latest version 3.0
MediaWiki >= 1.39.0
PHP 7.4+
Database changes No
License GNU General Public License 3.0 or later
Download
Example [1]
  • $wgStandardWikitextAccount
  • $wgStandardWikitextNamespaces
Quarterly downloads 0
Translate the StandardWikitext extension if it is available at translatewiki.net

The StandardWikitext extension standardizes wikitext after each page save. Use this extension to:

  • Fix messy wikitext
  • Fix some broken wikitext
  • Simplify regular expression search-and-replace
  • Simplify wikitext parsing by other tools
  • Eliminate OCD editing
  • End controversy over wikitext styles

This extension is inspired on JavaScript Standard Style. Enough of this madness!

Installation

[edit]
  • Download and move the extracted StandardWikitext folder to your extensions/ directory.
    Developers and code contributors should install the extension from Git instead, using:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/StandardWikitext
  • Add the following code at the bottom of your LocalSettings.php file:
    wfLoadExtension( 'StandardWikitext' );
    
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration

[edit]

StandardWikitext is designed to work out of the box and needs no configuration. However, the following options are available, each one shown with its default value:

// Namespaces where to run wikitext standardization
$wgStandardWikitextNamespaces = [ NS_MAIN ];

// System account that will do the wikitext standardization
$wgStandardWikitextAccount = "StandardWikitext bot";

Modules

[edit]

Wikitext is standardized to the following formats.

Sections

[edit]
== Section ==

Text.

=== Sub-section ===

Text.

==== Sub-sub-section ====

Text.
[edit]
[[foo]]

[[foo]]s

[[Foo|bar]]

[[File:Foo.jpg|thumb|Caption]]

[[File:Foo.jpg|thumb|left|300px|Caption with [[sublink]].]]

Lists

[edit]
* Foo
* Bar
* Baz

# Foo
# Bar
# Baz

* Foo
** Bar
*** Baz

Templates

[edit]
{{Foo}}

{{Foo|bar|baz=qux}}

{{Foo
| bar
| baz = qux
}}

Tables

[edit]
{| class="wikitable"
|+ Caption
! Header
! Header
|-
| Text
| Text
|-
| Text
| Text
|}

References

[edit]
Text.<ref name="foo" group="bar">Reference</ref>

Text.<ref name="foo" />

Categories

[edit]
Text.

[[Category:A]]
[[Category:B]]
[[Category:C]]

See also

[edit]