mediawiki-skins-Vector/README.md
Stephen Niedzielski 19edb3d612 [doc] Add link in readme to hooks.txt
I always forget hooks.txt exists but I guess it's a bit of a convention:

- extensions/CirrusSearch/docs/hooks.txt
- extensions/Echo/modules/hooks.txt

Add a link to hooks.txt in the readme to keep the convention but help
surface the documentation.

Change-Id: Ic40809ee79af2f40cb4b0d21e665441530439968
2020-04-28 09:29:52 -06:00

53 lines
1.5 KiB
Markdown

Vector Skin
========================
Installation
------------
See <https://www.mediawiki.org/wiki/Skin:Vector>.
### Configuration options
See [skin.json](skin.json).
Development
-----------
### Coding conventions
We strive for compliance with MediaWiki conventions:
<https://www.mediawiki.org/wiki/Manual:Coding_conventions>
Additions and deviations from those conventions that are more tailored to this
project are noted at:
<https://www.mediawiki.org/wiki/Reading/Web/Coding_conventions>
URL query parameters
--------------------
- `useskinversion`: Like `useskin` but for overriding the Vector skin version
user preference and configuration. E.g.,
http://localhost:8181?useskin=vector&useskinversion=2.
Skin preferences
----------------
Vector defines skin-specific user preferences. These are exposed on
Special:Preferences when the `VectorShowSkinPreferences` configuration is
enabled. The user's preference state for skin preferences is used for skin
previews and any other operation unless specified otherwise.
### Version
Vector defines a "version" preference to enable users who prefer the December
2019 version of Vector to continue to do so without any visible changes. This
version is called "Legacy Vector." The related preference defaults are
configurable via the configurations prefixed with `VectorDefaultSkinVersion`.
Version preference and configuration may be overridden by the `useskinversion`
URL query parameter.
### Hooks
See [hooks.txt](hooks.txt).