jenkins-bot has submitted this change and it was merged. Change subject: Updated README to point users to the on-wiki documentation at MW.org ......................................................................
Updated README to point users to the on-wiki documentation at MW.org Change-Id: Ic42839df063d88e1b22e8e9acdc125febb180775 --- M README.md 1 file changed, 29 insertions(+), 207 deletions(-) Approvals: Paladox: Looks good to me, approved jenkins-bot: Verified diff --git a/README.md b/README.md index dfae95c..a5b144d 100644 --- a/README.md +++ b/README.md @@ -6,13 +6,10 @@ The author of the skin is http://www.pidgi.net/wiki/Main_Page -Compatible with MediaWiki 1.26+. +Compatible with MediaWiki 1.25+. -If you would like compatibility with mediawiki 1.25, 1.24, 1.23, 1.22 or 1.21 please visit - -1.25 - -https://github.com/paladox/Metrolook/tree/REL1_25 +If you would like compatibility with older releases of MediaWiki, download the +appropriate version for your MediaWiki from one of the URLs below: 1.24 @@ -30,212 +27,48 @@ https://github.com/paladox/Metrolook/tree/REL1_21 -Please be aware that there are issues in the codes if you see any could you point it out it would help. and there are things like logos already set sorry i will put a setting there. +### Live demo -A working demo of the skin is available at http://www.pidgi.net/metrolooktest/index.php/Main_Page . This is currently using MediaWiki 1.25wmf18 and a snapshot of the test branch of the skin. +A working demo of the skin is available at http://www.pidgi.net/metrolooktest/index.php/Main_Page . +This is currently using MediaWiki 1.25wmf18 and a snapshot of the test branch of the skin. -## Installation +### On-wiki documentation -Download and save in skins/ folder +Please visit https://www.mediawiki.org/wiki/Skin:Metrolook where the documentation is now located. -Add this to LocalSettings.php +### Mobile design -```php -require_once "$IP/skins/Metrolook/Metrolook.php"; -``` +Mobile design now included in the latest release for MediaWiki 1.21+. +To get mobile design please download Metrolook release 0.2.0, 0.3.10, 1.4, 2.5 or 3.0 beta 16 or higher. -MediaWiki 1.25+ (optional) +Please report any and all bugs, issues and other feedback via the bug tracker (see below). -```php -wfLoadSkin( 'Metrolook' ); -``` +### Bugs +Bugs and issues should be reported on the MediaWiki Phabricator or GitHub. +It is strongly recommended that you use Phabricator to report bugs and submit +feedback, as more developers will see the report and are able to act on it. -## Settings +Phabricator is located at: -1.26 only +https://phabricator.wikimedia.org/tag/mediawiki-skins-metrolook/ -|Setting|Default|To Enable|To Disable| -|-------|-------|---------|----------| -|wgMetrolookLogo| `false` | `$wgMetrolookLogo = true;`| `$wgMetrolookLogo = false;`| -|wgMetrolookSiteName| `true` | `$wgMetrolookSiteName = true;`| `$wgMetrolookSiteName = false;`| -|wgMetrolookSiteNameText| `true` | `$wgMetrolookSiteNameText = true;`| `$wgMetrolookSiteNameText = false;`| -|wgMetrolookSiteText| `There is none` | `$wgMetrolookSiteNameText = false;` then do `$wgMetrolookSiteText = 'Enter text here';`| `$wgMetrolookSiteNameText = true;`| -|wgMetrolookSearchBar| `true` | `$wgMetrolookSearchBar = true;`| `$wgMetrolookSearchBar = false;`| -|wgMetrolookDownArrow| `true` | `$wgMetrolookDownArrow = true;`| `$wgMetrolookDownArrow = false;`| -|wgMetrolookLine| `true` | `$wgMetrolookLine = true;`| `$wgMetrolookLine = false;`| -|wgMetrolookUploadButton| `true` | `$wgMetrolookUploadButton = true;`| `$wgMetrolookUploadButton = false;`| -|wgMetrolookMobile| `true` | `$wgMetrolookMobile = true;`| `$wgMetrolookMobile = false;`| -|wgMetrolookBartile| `true` | `$wgMetrolookBartile = true;`| `$wgMetrolookBartile = false;`| -|wgMetrolookFeatures| `$wgMetrolookFeatures'] = array( 'collapsiblenav' => array( 'global' => false, 'user' => true ), );` | default is enabled | `$wgDefaultUserOptions['skinmetrolook-collapsiblenav'] = 0;` to disable it but allow users in preference to enable it. or `$wgMetrolookFeatures = array( 'collapsiblenav' => array( 'global' => false, 'user' => false ), );` to disable everywhere| +If, for some reason, you are unable to unwilling to use Phabricator, you can +submit your bug on GitHub, but it is likely to receive less attention there +than on Phabricator. -$wgBartile is now used to disable the default tiles or enable them so you can have the default tiles or set your self one. +The GitHub bug reporting URL is: -$link and $picture were removed in favour of using $wgMetrolookBartile and $wgMetrolookURL1 and $wgMetrolookImage1 +https://github.com/paladox/Metrolook/issues -$logo was removed in favour of $wgMetrolookLogo and $wgMetrolookSiteName. - -You can shorten youre site name for the top bar with $wgMetrolookSiteText. To set it please enable $wgMetrolookSiteNameText by doing $wgMetrolookSiteNameText = false then set this $wgMetrolookSiteText = 'Enter text here'; - -To set tiles now please do the following - -go to MediaWiki:metrolook-tiles - - -Then add - -for example - -Doint forget to add * in front of the code. It wont work without doing * in fornt of code. - -* URL to the site|alternative text|image URL - -* http://example.com|Example name|http://example.com/example.png - -You can now set different tiles for different languges. - -(for french) - -For example MediaWiki:metrolook-tiles/fr - - -## Mobile desgn - -Mobile desgn now included in the latest release for MediaWiki 1.21+. Also to get mobile desgn please download Metrolook release 0.2.0, 0.3.10, 1.4, 2.5 or 3.0 beta 16 or higher please. - -And please report feedback in the issues tab. And if you could help fix the problem and or improve the desgn please open and pull task. - - -## Customizing top bar color - -To customise top bar colour ether add it to theme.css which is in metrolook skin folder or MediaWiki:Metrolook.css from web browser. - -and all you need to do is edit background-colour and the top bar should change colour but please remember there is also hover which is when you hover it goes a different colour. - -```css - -/* Add your custom theme overrides here */ - -/* Top Bar colour and hover colour start */ - -@import "mediawiki.mixins"; - -#mw-page-base { - height: 2.5em; - background-color: dodgerBlue; - background-position: bottom left; - background-repeat: repeat-x; - /* This image is only a fallback (for IE 6-9), so we do not @embed it. */ - background-image: url('images/page-fade.png'); - min-width: auto; -} - -@media (max-width:768px) { -#mw-page-base { - height: 2.5em; - background-color: dodgerBlue; - background-position: bottom left; - background-repeat: repeat-x; - /* This image is only a fallback (for IE 6-9), so we do not @embed it. */ - background-image: url('images/page-fade.png'); - min-width: 24em; -} -} - -@media only screen and (min-device-width : 768px) and (max-device-width : 1024px) and (orientation : portrait) { -#mw-page-base { - height: 2.5em; - background-color: dodgerBlue; - background-position: bottom left; - background-repeat: repeat-x; - /* This image is only a fallback (for IE 6-9), so we do not @embed it. */ - background-image: url('images/page-fade.png'); - min-width: 25em; -} -} - -@media only screen and (min-device-width : 768px) and (max-device-width : 1024px) and (orientation : landscape) { -#mw-page-base { - height: 2.5em; - background-color: dodgerBlue; - background-position: bottom left; - background-repeat: repeat-x; - /* This image is only a fallback (for IE 6-9), so we do not @embed it. */ - background-image: url('images/page-fade.png'); - min-width: 64.7em; -} -} - -div.vectorTabs a:hover { - background-color: blue; -} - -div.onhoverbg:hover { - background-color: blue; -} - -img.downarrow:hover{ - background-color: blue; -} - -div.vectorMenu:hover h5 a { - background-color: blue; -} - -div.vectorMenu h5 a { - display: inline-block; - width: 24px; - height: 2em; - background-color: dodgerBlue; - .background-image-svg('images/arrow-down-icon.svg', 'images/arrow-down-icon.png'); - background-position: 50% 50%; - background-repeat: no-repeat; - .transition(background-position 250ms); -} - -div.vectorMenu:hover { - background-color: blue; -} - -div.vectorMenu ul { - border: solid 2px dodgerBlue; - border-top: none; - -} - -@media (max-width: 768px) { -#hamburgerIcon:hover { - background-color: blue; -} - -img.editbutton:hover { - background-color: blue; -} - -div.actionmenu ul { - border-top: solid 2px dodgerBlue; -} - -#left-navigation { - background-color: dodgerBlue; -} -} -/* To change bullet icon to a circle */ - -ul { - list-style-type: disc; - .list-style-image-svg('images/bullet-circle-icon.svg', 'images/bullet-circle-icon.png'); -} - -/* Top Bar colour and hover colour end */ -``` +It is recommended that you spend a while reading the documentation and +searching the archived discussions before posting a question - it is +possible that someone has experienced the same issue with this software +that you are experiencing currently. ## Known Issues -* Sometimes clicking of bartitle on mobile doesent work, workaround is to refresh page. - -## Comming soon - -Note plans may change. +See https://phabricator.wikimedia.org/tag/mediawiki-skins-metrolook/ for a list +of currently open bugs. ## Version @@ -250,14 +83,3 @@ 0.3.x requires MediaWiki 1.22. 0.2.x requires MediaWiki 1.21. - - -## Removed things - -Please do not remove this section. it is for things that have been removed and used for if something goes wrong and the problem was because it was removed then they can use the things here. - -```html -<link href='http://fonts.googleapis.com/css?family=Yanone+Kaffeesatz:700' defer="defer" rel='stylesheet' type='text/css'> -<meta name="msapplication-TileImage" content="http://www.pidgi.net/new/public/images/pidgiwiki.png"/> -<meta name="msapplication-TileColor" content="#BE0027"/> -``` -- To view, visit https://gerrit.wikimedia.org/r/224613 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: Ic42839df063d88e1b22e8e9acdc125febb180775 Gerrit-PatchSet: 4 Gerrit-Project: mediawiki/skins/Metrolook Gerrit-Branch: master Gerrit-Owner: Paladox <[email protected]> Gerrit-Reviewer: Jack Phoenix <[email protected]> Gerrit-Reviewer: Paladox <[email protected]> Gerrit-Reviewer: jenkins-bot <> _______________________________________________ MediaWiki-commits mailing list [email protected] https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
![http://www.pidgi.net/new/public/images/pidgiwiki.png"/](http://www.pidgi.net/new/public/images/pidgiwiki.png"/){kind=link}