Extension:MobileFrontend

{{Extension|templatemode= m.mediawiki.org }}
 * status       = stable
 * type1        = interface
 * type2        = hook
 * newhook1     = MobileFrontendBeforeDOM
 * newhook2     = EnterMobileMode
 * newhook3     = GetMobileUrl
 * newhook4     = RequestContextCreateSkinMobile
 * newhook5     = BeforePageDisplayMobile
 * newhook6     = MobileLicenseLink
 * newhook7     = MobileSiteOutputPageBeforeExec
 * newhook8     = MobileFrontendFeaturesRegistration
 * newhook9     = MobileSpecialPageStyles
 * newhook10    = BeforeSpecialMobileDiffDisplay
 * newhook11    = SpecialMobileEditWatchlist::images
 * username     =
 * author       =
 * See repo
 * description  = Provides a mobile-friendly view
 * image        = MediaWiki-Vagrant MobileFrontend Extension.png
 * imagesize    = border{{!}}350
 * update       =
 * mediawiki    = 1.33+
 * php          = 5.5.9+
 * download     = {{WikimediaDownload|MobileFrontend}}
 * readme       = {{git file|project=mediawiki/extensions/MobileFrontend|branch=master|file=README.md|text=README}}
 * changelog    = MSG_MS-Ai13
 * tags         = Ai.a13(key)MSG_MS-Ai13
 * example      = {{Ai13@example.com
 * compatibility policy = rel
 * bugzilla     = MobileFrontend
 * phabricator  = MobileFrontend

The MobileFrontend extension:


 * Creates a separate mobile site for your mobile traffic,


 * System administrators are able to provide a different skin, e.g. {{ll|Skin:Minerva Neue}}.


 * provides various content transformations to make your content more friendly,


 * Notably section collapsing and content re-arrangement and removal, including putting the lead paragraph above the lead photo or info box, even if the lead paragraph is below them in the page's source code.


 * simplifies mobile footer and adds a desktop/mobile site link,


 * provides replacements for special pages that are not mobile friendly: Special:History, Special:Contributions{{MSG_MS-Ai13, Special:Watchlist, Special:Preferences, Special:MobileDiff


 * provides the special pages Special:Nearby, Ai.a13(key)MSG_MS-Ai13 (for mobile skin preferences), Special:MobileLanguages (for language selection),


 * provides a beta mode with a feature management system for adding experimental features for {{Ai.a13(key)MSG_0 users:MATAHARIAGUNG7@GMAIL.COM.

This page is designed for end users who want to install it on their development instance. If you are keen to help us build it and improve it we encourage you to get involved.

{{ReadingWebExtension}}

Prerequisites
Before installing MobileFrontend, if you make heavy use of templates and/or inline styles (the style attribute) you should review your content to see whether it is mobile friendly. The extension can be used to style content so that it renders nicely on mobile and desktop. MobileFrontend will not magically fix this for you!

In particular, you may want to review your landing page (main page). See Mobile homepage formatting.

Setup Nearby
MobileFrontend provides the Special:Nearby page with a little configuration. To get this to work, a few optional steps are required:


 * 1) Due to browser security, you will need to be running a secure site over SSL — it is not possible to request a user's location over HTTP.


 * 1) Install the GeoData extension
 * 2) Run
 * 3) In LocalSettings.php add
 * 4) Determine article coordinates:
 * 5) Add location data to your articles by using the   parser function, for example  .  For syntax details, see the documentation for.
 * 6) Alternatively, you can use a separate MediaWiki installation for Nearby by setting  in your LocalSettings.php file.  For example,  will use coordinates of English Wikipedia articles.  The nearby endpoint will be used to find content related to a given location.

Set up a skin
MobileFrontend provides you with a mobile formatted website to go alongside your existing desktop website. You can skin it however you want.

The following skins are compatible with MobileFrontend:


 * Skin:Minerva Neue (stable, default on WMF wikis)


 * Skin:Vector (default desktop skin, uses an experimental responsive mode for mobile)


 * Skin:Timeless (experimental skin)
 * (responsive skin)

Configuration settings
See

All configuration options are detailed in the README.md file.

Additional tweaks
Get the most out of MobileFrontend by adding these optional compatible extensions:


 * - Get Special:Nearby and geotag your articles.
 * - Adds images to search and nearby results.
 * - Add Visual editing to your mobile experience.

CSS styling
To apply CSS to your mobile theme, edit MediaWiki:Mobile.css, the counterpart of MediaWiki:Common.css. In order for the stylesheet to function you may have to add to your MediaWiki:Mobile.js.

MobileFrontend does not load the global MediaWiki:Common.css, neither does it load any of the user stylesheets.

More information
If you would like to test the mobile extension on a desktop browser or your device doesn't render the mobile version, you can append the following key-value pair to the URL query string:. For example: https://en.wikipedia.org/wiki/MediaWiki?useformat=mobile

If you would like to view the mobile version of a page without enabling the extension across the entire site you can append the string to the URL on that page, too.

Legacy features of MobileFrontend
MobileFrontend has traditionally been a very large extension. Many features have either surpassed their requirements or will do at some future date. These are listed below.

API
APIs are provided by the MobileFrontend extension, but long term we expect to deprecate them in favour of Page Content Service. Use these APIs at your own risk. They may disappear (although we will give you sufficient notice when they do)!

MobileView API
See.

Extended action=parse
accepts extra parameters:


 * Return rendered page HTML in a mobile format.
 * Return rendered page HTML in a mobile format.


 * Apply mobile main page transformations.
 * Apply mobile main page transformations.

Example:

meta=siteinfo
The domain of the mobile version of the site (which might or might not be the same as the normal domain) is available under the  key of the general siteinfo information.

Setup
You may need to run and install php composer to get the precommit hook to run, depending on what you're doing with the extension.

Testing with articles on a foreign wiki (live data)
See.

WMF sites
On Wikimedia Foundation-run sites, we use Varnish caching servers to check the user agent of your device.

Non-WMF sites
For non-WMF sites, you can either set up your configuration to mimic how things are done at the WMF (doing device detection at the proxy layer and setting specific X-Device headers), or you can simply use "?useformat=mobile" to switch an article to use the mobile view.

FAQ
The following questions frequently appear on our talk page. Please check this list before posting about them on the talk page or use the existing talk topic, if available, to receive clarifications.

Q: How do I customise the main menu of the Minerva skin?
A: This is tracked in phabricator but you can see Topic:Tiggc18fvd3stmsf has an interim solution.

Q: How do I add HTML to the Minerva skin, for example to add ads or additional script tags?
A: You can do this by editing the template file for the skin (currently ). See this discussion for details.

Q: The extension I am using doesn't seem to work on MobileFrontend. Why?
A: It's likely the extension is old and needs to add compatibility to MobileFrontend. Please contact the developer of the extension and point them to ResourceLoader/Writing a MobileFrontend friendly ResourceLoader module. Please do not post to the talk page, as in this case it would be better to file a bug on Phabricator (you can login using your MediaWiki.org username) for a quicker response.

Q: I upgraded MobileFrontend and now I'm getting a fatal exception!
A: You are probably using incompatible versions of MobileFrontend and MediaWiki. In most cases, we can't help you here. Try upgrading MobileFrontend or MediaWiki to resolve your issue.

Q: After upgrading MediaWiki I'm getting an exception wgMFDefaultSkinClass is not setup correctly.
A: MobileFrontend currently assumes you have the skin installed. If you don't you'll need to install this or configure your mobile skin per instructions above.

For Extension Developers
By default resource modules in extensions will not be loaded in mobile view.

Should a module need to be loaded while in mobile view this guide on writing MobileFrontend friendly modules will be of help.