mirror of
https://github.com/StarCitizenTools/mediawiki-skins-Citizen.git
synced 2024-11-28 00:01:05 +00:00
000643ad36
This is a part of the header refactor * Clean up DOM strcture * Clean up unnessecary styles * Clean up HTML classes * Add active state to button |
||
|---|---|---|
| .github | ||
| .husky | ||
| bin | ||
| i18n | ||
| includes | ||
| licenses | ||
| resources | ||
| skinStyles | ||
| templates | ||
| .commitlintrc.json | ||
| .eslintignore | ||
| .eslintrc.json | ||
| .gitignore | ||
| .phpcs.xml | ||
| .stylelintignore | ||
| .stylelintrc.json | ||
| .svgo.config.js | ||
| .versionrc.json | ||
| CHANGELOG.md | ||
| citizen.php | ||
| CODE_OF_CONDUCT.md | ||
| composer.json | ||
| jsdoc.json | ||
| LICENSE | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| skin.json | ||
Citizen
Citizen is a responsive skin for MediaWiki built by the Star Citizen Wiki team. Although it is specifically built for the Star Citizen Wiki, the skin is designed to be flexible to run on any Mediawiki installation that is 1.35.2 or higher. Due to resource constraints, we might not be able to provide full support for setups that are vastly different than us, but please feel free to submit patches or bug report!
Live demo can be seen at the Star Citizen Wiki, more avaliable here.
Notable features
- Fully responsive skin: Responsive and able to adapt to different screen sizes. 📱💻🖥️
- Light/dark mode support: Switch between light and dark mode. Require JS ☀️🌙
- Adjustable font size and page width: Read the article the way you wanted. Require JS 👀📃
- Collapsible sections: Collapse and expand article sections. Require JS 📖📕
- Persistent ToC: Access ToC anywhere in the article. Tracking require JS 🔍📖
- Rich search suggestions: More helpful search suggestions with images and descriptions. Require JS 🔍👀
- Webapp manifest: Give a more app-like experience when user add your wiki to their home screen. 📱
SkinStyles
Citizen includes numerous skinStyles that applies custom styling to extensions and core libraries. Please feel free to submit PRs if you want to add support for more extensions! Unless the extension has never supported the current minimum required MediaWiki version of the skin, the skinStyles are based on the latest version of the said MW release branch (e.g. REL1_35 for MediaWiki 1.35).
- Grade A - Overhaul - Major adjustments to UI, plus Grade B.
- Grade B - Dynamic - Colors are converted into CSS variables, little to none style adjustments.
- Grade E - Legacy - Dark mode colors are hardcored as LESS variables. These should be updated to at least Grade B support.
Core
| Name | Grade | Version | Last updated |
|---|---|---|---|
| MediaWiki UI | B | 1.35.3 | 2021-07-27 |
| OOUI | B | 0.39.3 086b4f1 |
2021-07-26 |
Extensions
| Name | Grade | Version | Last updated |
|---|---|---|---|
| AdvancedSearch | B | REL1_35 fae6250 |
2021-08-26 |
| ApprovedRevs | B | N/A | N/A |
| Babel | B | MLEB 2021.07 | 2021-07-29 |
| Capiunto | B | REL1_35 30049a7 |
2021-08-26 |
| Cargo | B | REL1_35 df13273 |
2021-08-31 |
| CategoryTree | B | N/A | N/A |
| Cite | A | N/A | N/A |
| CleanChanges | B | MLEB 2021.07 | 2021-07-29 |
| CodeMirror | A | REL1_35 a326407 |
2021-08-25 |
| CookieWarning | A | REL1_35 3c2ae6a |
2022-04-29 |
| DiscussionTools | A | REL1_35 7aa0a9b |
2022-05-06 |
| DismissableSiteNotice | A | N/A | N/A |
| Echo | A | REL1_35 347c30e |
2021-08-11 |
| Flow (StructuredDiscussions) | B | REL1_35 e3379f0 |
2022-04-27 |
| Graph | B | N/A | N/A |
| Lingo | B | REL1_35 e948775 |
2022-04-29 |
| MsUpload | A | REL1_35 32eb420 |
2021-08-25 |
| MultimediaViewer | A | N/A | N/A |
| OAuth | B | REL1_35 451ed95 |
2021-08-31 |
| Popups | A | REL1_35 dccd607 |
2021-09-02 |
| PortableInfobox | B | 0.6 16a77dc |
2022-04-14 |
| RelatedArticles | A | REL1_35 0f27333 |
2021-08-31 |
| Semantic MediaWiki | E | N/A | N/A |
| Semantic Result Formats | E | N/A | N/A |
| SimpleTooltip | B | N/A | 2022-02-19 |
| SyntaxHighlight | A | REL1_35 05598b3 |
2021-08-26 |
| Tabber | A | N/A | N/A |
| TabberNeue | A | 1.3.1 c045490 |
2022-04-19 |
| TimedMediaHandler | B | N/A | N/A |
| Translate | B | MLEB 2021.07 | 2021-07-29 |
| UniversalLanguageSelector | B | MLEB 2021.07 | 2021-07-29 |
| UploadWizard | A | N/A | N/A |
| VisualEditor | A | REL1_35 cc3466a |
2021-08-04 |
| WikiEditor | B | REL1_35 e18315e |
2021-08-11 |
| WSSearchFront | B | 3.5.4 c27ebcb5 |
2021-11-23 |
Some of the field are tagged as N/A because the information was not tracked before. If you are interested in adding skinstyles, please check out this page on the wiki!
Installation
- Download place the file(s) in a directory called
Citizenin yourskins/folder. - Add the following code at the bottom of your LocalSettings.php:
wfLoadSkin( 'Citizen' );
- ✔️Done - Navigate to Special:Version on your wiki to verify that the skin is successfully installed.
Configurations
The skin works out of the box without any configurations. The config flags allow more customization on the specific features in the skin. Check out this wiki page on how to adapt Citizen styles on your wiki.
Appearance
| Name | Description | Values | Default |
|---|---|---|---|
$wgCitizenThemeDefault |
The default theme of the skin | auto - switch between light and dark according to OS/browser settings; light; dark |
auto |
$wgCitizenEnableCollapsibleSections |
Enables or disable collapsible sections on content pages | true - enable; false - disable |
true |
$wgCitizenShowPageTools |
The condition of page tools visibility | true - always visible; login - visible to logged-in users; permission - visible to users with the right permissions |
true |
$wgCitizenEnableDrawerSiteStats |
Enables the site statistics in drawer menu | true - enable; false - disable |
true |
$wgCitizenPortalAttach |
Label of the portal to attach links to upload and special pages to | string | first |
$wgCitizenThemeColor |
The color defined in the theme-color meta tag |
Hex color code | #131a21 |
Search suggestions
| Name | Description | Values | Default |
|---|---|---|---|
$wgCitizenEnableSearch |
Enable or disable rich search suggestions | true - enable; false - disable |
true |
$wgCitizenSearchGateway |
Which gateway to use for fetching search suggestion | mwActionApi; mwRestApi |
mwActionApi |
$wgCitizenSearchDescriptionSource |
Source of description text on search suggestions (only takes effect if $wgCitizenSearchGateway is mwActionApi) |
wikidata - Use description provided by WikibaseLib or ShortDescription; textextracts - Use description provided by TextExtracts; pagedescription - Use description provided by Description2 or any other extension that sets the description page property |
textextracts |
$wgCitizenMaxSearchResults |
Max number of search suggestions | Integer > 0 | 6 |
Webapp manifest
| Name | Description | Values | Default |
|---|---|---|---|
$wgCitizenEnableManifest |
Enable or disable web app manifest | true - enable; false - disable |
true |
$wgCitizenManifestThemeColor |
Theme color of the web app manifest | Hex color code | #131a21 |
$wgCitizenManifestBackgroundColor |
Background color of the web app manifest | Hex color code | #131a21 |
Miscellaneous
| Name | Description | Values | Default |
|---|---|---|---|
$wgCitizenEnablePreconnect |
Enable or disable preconnect to required origin | true - enable; false - disable |
false |
$wgCitizenPreconnectURL |
The URL for preconnect to required origin | URL | |
$wgCitizenThemeColor |
The color defined in the theme-color meta tag |
Hex color code | #11151d |
Requirements
- MediaWiki 1.35.2 or later
- For the legacy versions, check the other release branches.