The MobileFrontend extension adds a mobile view to your mediawiki instance.
Please follow the coding conventions of MobileFrontend: https://www.mediawiki.org/wiki/MobileFrontend/Coding_conventions
Install like so:
If you are not running Vagrant, be sure to set your
MEDIAWIKI_URL env variable to your local index path, e.g.
Commits are important as they give the reviewer more information to successfully review your code and find errors or potential problems you might not have thought of.
Commits are also useful when troubleshooting issues and refactoring. If it's not clear why a line of code is in the repository important bug fixes could be lost.
Commits should be as minor as possible. Please avoid removing unrelated console.log statements, fixing unrelated whitespace etc. do that in a separate commit which mentions the word cleanup.
First line commit should summarise the commit with bug it fixes if applicable. e.g. Fix problem with toggling see bug x.
Second line should be blank. Third line should go into detail where necessary providing links to blog posts/other bugs to provide more background. Mention the platforms/browsers the change is for where necessary, e.g.:
http://<url></url>which explains problem in detail
To run the full test suite run:
npm run precommit
To run only PHP tests:
php ../../tests/phpunit/phpunit.php "tests/phpunit/"
To run only MobileFrontend JS tests:
npm run test:unit
A new version of MobileFrontend is released every two weeks following the Wikimedia release train if there are new changes.
MobileFrontend follows the version naming from MediaWiki.
The following configuration options will apply to all skins operating in useformat=mobile mode.
Whether or not to enable the use of the X-Analytics HTTP response header. This header is used for analytics purposes.
ID of the App to deep link to replacing the browser. Set
false to have no such link.
Scheme to use for the deep link.
Options to control several functions of the mobile editor. Possible values:
anonymousEditing: Whether or not anonymous (not logged in) users should be able to edit. Note this is highly experimental and comes without any warranty and may introduce bugs until anonymous editing experience is addressed in this extension. Anonymous editing on mobile is still a big unknown. See bug 53069. Thoughts welcomed on https://www.mediawiki.org/wiki/Mobile_wikitext_editing#Anonymous_editing
skipPreview: Should the mobile edit workflow contain an edit preview (before save) to give the user the possibility to review the new text resulting of his changes or not.
[ 'anonymousEditing' => true, 'skipPreview' => false, ]
Enable mobile preferences in Special:Preferences (currently only accessible in desktop). Currently this allows users to disable many of mobile's special page optimisations.
A list of experiments active on the skin.
[ // Experiment to prompts users to opt into the beta experience of the skin. 'betaoptin' => [ 'name' => 'betaoptin', 'enabled' => false, 'buckets' => [ 'control' => 0.97, 'A' => 0.03, ], ], ]
Controls whether a message should be logged to the console to attempt to recruit volunteers.
Whether or not the banner experiment is enabled.
Name of PHP class that is responsible for formatting HTML for mobile. Must implement IContentProvider.
Allow editors to edit MediaWiki:MobileMainPage.css to serve render blocking css to the main page.
URL to be used by the MwApiMobileFormatter class. Points to a MediaWiki API that can be queried to obtain content.
When enabled the ContentProvider will run on desktop views as well as mobile views.
This is a list of html tags, that could be recognized as the first heading of a page. This is an interim solution to fix Bug T110436 and shouldn't be used, if you don't know, what you do. Moreover, this configuration variable will be removed in the near future (hopefully).
['h1', 'h2', 'h3', 'h4', 'h5', 'h6']
If set to true, styles inside MediaWiki:Mobile.css will become render blocking.
This is intended for situations where the TemplateStyles extension cannot be used. When enabled, this may increase the time it takes for the mobile site to render, depending on how large MediaWiki:Mobile.css is for your wiki.
If set to true, main page HTML will receive special massaging.
Use is discouraged as it leads to unnecessary technical debt and on the long term the goal is to deprecate usage of this config variable. Use at your own risk!
Requests containing header with this name will be considered as coming from mobile devices.
Make the classes, tags and ids stripped from page content configurable. Each item will be stripped from the page.
[ // These rules will be used for all transformations in the beta channel of the site 'beta' => , // These rules will be used for all transformations 'base' => , ]
Do load images in pages lazily. Currently it doesn't affect HTML-only clients (only JS capable ones) and it lazy loads images when they come close to the viewport.
[ // These will enable lazy loading images in beta mode 'beta' => false, // These will enable lazy loading images in all modes 'base' => false, ]
Array of namespaces that blacklists certain namespaces from applying mobile transformations to page content. This will disable lazy loading images and references; special casing and section formatting on the given page. MFRemovableClasses will not apply for any blacklisted pages.
[ NS_TEMPLATE, NS_SPECIAL ]
DB key of the category which members will never display mobile view.
Prefixed names of pages that will never display mobile view.
The range in meters that should be searched to find nearby pages on Special:Nearby (defaults to 10km).
Whether geodata related functionality should be enabled.
An optional alternative api to query for nearby pages, e.g. https://en.m.wikipedia.org/w/api.php
If set forces nearby to operate in JSONP mode.
Define a set of params that should be passed in every gateway query.
[ // See https://phabricator.wikimedia.org/T115646 'ppprop' => 'displaytitle', ]
Define a set of page props that should be associated with requests for pages via the API.
Sets RSS feed
<link> being outputted or not while on mobile version.
Define the generator that should be used for mobile search.
[ 'name' => 'prefixsearch', 'prefix' => 'ps', ]
Pages with smaller parsed HTML size are not cached. Set to 0 to cache everything or to some large value to disable caching completely.
64 * 1024
Set this to true to automatically show mobile view depending on people's user-agent.
WARNING: Make sure that your caching infrastructure is configured appropriately, to avoid people receiving cached versions of pages intended for someone else's devices.
Set this to
true, if you want to send
User-Agent in the
Vary header. This could improve your SEO ranking.
WARNING: You should set this to true only, if you know what you're doing!
CAUTION: Setting this to true in combination with a (frontend)caching layer (such as Varnish) can have a huge impact on how your caching works, as it now caches every single page multiple times for any possible/different User Agent string!
Controls whether tablets should be shown the mobile site. Works only if
Template for mobile URLs.
This will be used to transcode regular URLs into mobile URLs for the mobile view.
It's possible to specify the mobileness of the URL in the host portion of the URL.
You can either statically or dynamically create the host-portion of your mobile URL. To statically create it, just set
$wgMobileUrlTemplate to the static hostname. For example:
$wgMobileUrlTemplate = "mobile.mydomain.com";
Alternatively, the host definition can include placeholders for different parts of the host section of a URL. The placeholders are denoted by
%h and followed with a digit that maps to the position of a host-part of the original, non-mobile URL. Take the host
en.wikipedia.org for example.
%h0 maps to
%h1 maps to
%h2 maps to
org. So, if you wanted a mobile URL scheme that turned
en.m.wikipedia.org, your URL template would look like:
The number of seconds the
useformat cookie should be valid.
The useformat cookie gets set when a user manually elects to view either the mobile or desktop view of the site.
If this value is not set, it will default to
Set to false to allow search engines to index your mobile pages. So far, Google seems to mix mobile and non-mobile pages in its search results, creating confusion.
Set the domain of the
If this value is not set, it will default to the top domain of the host name (e.g.
en.wikipedia.org = .wikipedia.org)
If you want to set this to a top domain (to cover all subdomains), be sure to include the preceding
. (e.g. yes:
Path to the logo used in the login/signup form. The standard height is
Whether beta mode is enabled.
Link to feedback page for beta features. If false no feedback link will be shown.
The default skin for MobileFrontend.
In which namespaces sections shoudn't be collapsed.
[ // Authorship and licensing information should be visible initially NS_FILE, // Otherwise category contents will be hidden NS_CATEGORY, // Don't collapse various forms NS_SPECIAL, // Just don't NS_MEDIA, ]
Controls whether to collapse sections by default.
Leave at default
true for "encyclopedia style", where the section 0 lead text will always be visible and subsequent sections may be collapsed by default.
In tablet sections will always be expanded by default regardless of this setting.
false for "dictionary style", sections are not collapsed.
When enabled an option on Special:MobileOptions to expand all sections by default will be visible. This allows a user to specify a preference for toggling which will override the value of wgMFCollapseSectionsByDefault.
[ 'beta' => true, 'base' => false, ]
The wiki id/dbname for where photos are uploaded, if photos are uploaded to a wiki other than the local wiki (eg commonswiki).
An api to which any photos should be uploaded. e.g.
$wgMFPhotoUploadEndpoint = 'https://commons.wikimedia.org/w/api.php';
If set to true, the use Wikibase is enabled and associated features is enabled. See
If set to true, wikidata descriptions as defined in $wgMFDisplayWikibaseDescriptions will show up in the UI in the environment they have been told to target.
[ 'beta' => true, 'base' => false, ]
Set which features will use Wikibase descriptions, e.g.
$wgMFDisplayWikibaseDescriptions = [ 'search' => true, 'nearby' => true, 'watchlist' => false, 'tagline' => true, ];
[ 'search' => false, 'nearby' => false, 'watchlist' => false, 'tagline' => false, ]
Set taglines for special pages
$wgMFSpecialPageTaglines = [ "SpecialPageName" => "valid-message-key", ];
[ "MobileOptions" => "mobile-frontend-settings-tagline" ]
Whether to strip
srcset attributes from all images on mobile renderings. This is a sort of brute-force bandwidth optimization at the cost of making images fuzzier on most devices.
Whitelist of source file mime types to retain srcset attributes on when using $wgMFStripResponsiveImages. Defaults to allow rasterized SVGs since they usually are diagrams that compress well and benefit from the higher resolution.
[ "image/svg+xml", ]