Расширение:MobileFrontend

Справка по расширениям MediaWiki

MobileFrontend Статус релиза: стабильно
Реализация	Пользовательский интерфейс, Хук
Описание	Обеспечивает удобный вид на мобильных устройствах
Автор(ы)	See repo
Последняя версия	2.4.0
Политика совместимости	Snapshots releases along with MediaWiki. Master is not backward compatible.
MediaWiki	1.33+
PHP	5.5.9+
Лицензия	GNU General Public License 2.0 или позднее
Скачать	Скачать расширение Git [?]: скачать текущую версию исходника репозиторий (GitHub) история изменений список разработчиков (GitHub) code review README
Пример	m.mediawiki.org
Параметры $wgMFSearchGenerator $wgMFStopRedirectCookieHost $wgMFShowMobileViewToTablets $wgMFStripResponsiveImages $wgMFLazyLoadImages $wgMFRSSFeedLink $wgMFNamespacesWithLeadParagraphs $wgMFAmcOutreachMinEditCount $wgMFEnableMobilePreferences $wgMFMobileFormatterOptions $wgMFRemovableClasses $wgMFNoindexPages $wgMFShowFirstParagraphBeforeInfobox $wgMFMinCachedPageSize $wgMFVaryOnUA $wgMFLogWrappedInfoboxes $wgMFDisplayWikibaseDescriptions $wgMFEnableJSConsoleRecruitment $wgMobileFrontendFormatCookieExpiry $wgMFResponsiveImageWhitelist $wgMFLazyLoadSkipSmallImages $wgMFSearchAPIParams $wgMFMobileHeader $wgMFEnableXAnalyticsLogging $wgMFUseDesktopSpecialHistoryPage $wgMFSiteStylesRenderBlocking $wgDefaultMobileSkin $wgMobileUrlTemplate $wgMFCollapseSectionsByDefault $wgMFStopMobileRedirectCookieSecureValue $wgMFEnableFontChanger $wgwgMFScriptPath $wgMFEnableBeta $wgMFSchemaEditAttemptStepOversample $wgMFAmcOutreach $wgMFNearby $wgMFAdvancedMobileContributions $wgMFWatchlistEditCountThreshold $wgMFSpecialPageTaglines $wgMFNearbyRange $wgMFManifestBackgroundColor $wgMFBetaFeedbackLink $wgMFDefaultEditor $wgMFManifestThemeColor $wgMFEnableManifest $wgMFUseDesktopSpecialWatchlistPage $wgMFEnableWikidataDescriptions $wgMFUseWikibase $wgMFNamespacesWithoutCollapsibleSections $wgMFTrackBlockNotices $wgMFAutodetectMobileView $wgMFQueryPropModules
Используемые хуки APIGetAllowedParams APIQuerySiteInfoGeneralInfo AbuseFilter-builder AbuseFilter-generateUserVars AfterBuildFeedLinks AuthChangeFormFields BeforeInitialize BeforePageDisplay BeforePageRedirect CentralAuthLoginRedirectData CentralAuthSilentLoginRedirect ChangeTagsListActive DifferenceEngineViewHeader Gadgets::allowLegacy GetCacheVaryCookies GetPreferences HTMLFileCache::useFileCache ListDefinedTags LoginFormValidErrorMessages MakeGlobalVariablesScript ManualLogEntryBeforePublish MediaWikiPerformAction OutputPageBeforeHTML OutputPageBodyAttributes OutputPageParserOutput PageRenderingHash RecentChange_save RequestContextCreateSkin ResourceLoaderRegisterModules ResourceLoaderSiteModulePages ResourceLoaderSiteStylesModulePages SkinAddFooterLinks SkinAfterBottomScripts SpecialPageBeforeExecute SpecialPage_initList ThumbnailBeforeProduceHTML TitleSquidURLs UserGetDefaultOptions UserLoginComplete
Предоставляемые хуки MobileFrontendBeforeDOM EnterMobileMode GetMobileUrl RequestContextCreateSkinMobile BeforePageDisplayMobile MobileLicenseLink MobileSiteOutputPageBeforeExec MobileFrontendFeaturesRegistration MobileSpecialPageStyles BeforeSpecialMobileDiffDisplay SpecialMobileEditWatchlist::images
Переведите расширение MobileFrontend, если оно доступно на translatewiki.net
Проверьте использование и версию.
Проблемы	Открытые задачи · Сообщить об ошибке

Расширение MobileFrontend:

• создаёт отдельный мобильный сайт для вашего мобильного трафика,
  • системные администраторы могут установить другую оболочку, например, Тема оформления:MinervaNeue .
• обеспечивает различные преобразования контента, чтобы сделать его более дружелюбным,
  • в частности, сворачивание разделов, перекомпоновка и удаление контента, в том числе расположение вступительного абзаца над вступительной фотографией или информационной карточкой, даже в том случае, когда вступительный абзац находится под ними в исходном коде страницы.
• упрощает нижний колонтитул для мобильных устройств и добавляет ссылку на настольную/мобильную версию сайта,
• предоставляет замены для служебных страниц, которые не оптимизированы для мобильных устройств: Special:History, Special:Contributions, Special:Watchlist, Special:Preferences, Special:MobileDiff
• предоставляет служебные страницы: Special:Nearby, Special:MobileOptions (для настроек мобильной оболочки), Special:MobileLanguages (для выбора языка),
• предоставляет бета-режим с системой управления функциями для добавления экспериментальных функций анонимным пользователям.

Эта страница предназначена для конечных пользователей, которые хотят установить расширение на свою вики для дальнейшей разработки. Если у вас есть очень большое желание помочь нам в создании и улучшении расширения, мы приглашаем вас принять участие.

Необходимые компоненты

• Хотя MediaWiki не требует следующего, PHP должен иметь поддержку mbstring для работы этого расширения (задача T62174).

Если вы активно используете шаблоны и/или встроенные стили (атрибут style), перед установкой MobileFrontend вам следует просмотреть свой контент на предмет его оптимизации под мобильные устройства. Расширение TemplateStyles можно использовать для стилизации контента, чтобы он хорошо отображался на мобильных и настольных компьютерах. MobileFrontend не исправит это за вас волшебным образом!

В частности, вы можете пересмотреть вашу домашнюю страницу (главную страницу). См. Форматирование главной страницы для мобильных устройств.

Установка

• Если вы используете Vagrant , установите с помощью vagrant roles enable mobilefrontend --provision

Ручная установка

• Скачайте и распакуйте файл(ы) в папку с названием MobileFrontend в вашей папке extensions/.
• Добавьте следующие строки в конец файла LocalSettings.php:

  wfLoadExtension( 'MobileFrontend' );
  

• Настройте на свой манер при необходимости
•  Готово – Перейдите на страницу Special:Version на своей вики, чтобы удостовериться в том, что расширение успешно установлено.

Установка раздела «Поблизости»

MobileFronted предоставляет страницу Служебная:Nearby с возможностью донастройки. Требуется выполнить несколько необязательных шагов, чтобы эта служебная страница заработала у вас.

1. Из-за системы безопасности браузеров вам будет нужно запустить безопасный сайт через SSL — через HTTP невозможно запросить геолокацию пользователя.
2. Установите расширение GeoData
3. Запустите update.php
4. В LocalSettings.php добавьте $wgMFNearby = true;
5. Определите координаты статьи:
   1. Добавляйте геопозиционные данные в ваши статьи через функцию парсера coordinates; например, {{#coordinates:37.786971|-122.399677|primary}}. For syntax details, see the documentation for GeoData .
   2. Alternatively, you can use a separate MediaWiki installation for Nearby by setting $wgMFNearbyEndpoint in your LocalSettings.php file. Например, $wgMFNearbyEndpoint = 'https://en.m.wikipedia.org/w/api.php'; будет использовать координаты из статей Википедии на английском языке. The nearby endpoint will be used to find content related to a given location.

Установка темы оформления

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

// Choose one of these pairs of lines and add chosen code to bottom of LocalSettings.php file:
wfLoadSkin( 'MinervaNeue' );
$wgDefaultMobileSkin = 'minerva'; // use Minerva skin (You need to download and install it separately, otherwise you'll get an exception)
wfLoadSkin( 'Vector' );
$wgDefaultMobileSkin = 'vector'; // use Vector skin
wfLoadSkin( 'Timeless' );
$wgDefaultMobileSkin = 'timeless'; // use Timeless skin

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)

• Skin:Citizen (responsive skin)

Настройки конфигурации

Смотрите Extension:MobileFrontend/Configuration

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

Дополнительные настройки

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

• Расширение:GeoData - Get Special:Nearby and geotag your articles.
• Extension:PageImages - Adds images to search and nearby results.
• Extension:VisualEditor - Add Visual editing to your mobile experience.

Local customisations

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 mw.loader.using('mobile.site.styles') to your MediaWiki:Mobile.js.

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

Больше информации

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: ?useformat=mobile. For example: https://en.wikipedia.org/wiki/Chuck_Schuldiner?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 Extension:MobileFrontend/MobileViewAPI .

Extended action=parse

action=parse accepts extra parameters:

mobileformat=

Return rendered page HTML in a mobile format 1.23+.

noimages

Disable images in mobile output.

mainpage

Apply mobile main page transformations.

Пример:

api.php?action=parse&page=Therion_(band)&mobileformat=&prop=text [попробуйте в ApiSandbox]

Результат

{ "parse": { "title": "Therion (band)", "text": { "*": "<div><table class=\"infobox vcard plainlist\" style=\"width:22em\"><tr><th colspan=\"2\" style=\"text-align:center;font-size:125%;font-weight:bold;background-color: #b0c4de\"><span class=\"fn org\">Therion</span></th>\n</tr><tr><td colspan=\"2\" style=\"text-align:center\"><a href=\"/wiki/File:2130860153_281d30b3bf_b.jpg\" class=\"image\"> ...

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 mobileserver key of the general siteinfo information.

Для разработчиков/администраторов

Установка

You may need to run npm install 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 Extension:MobileFrontendContentProvider .

Using the mobile view

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.

Starting from the snapshot version 1.28, the default $wgMFMobileHeader was changed from X-WAP to X-Subdomain. You could either set $wgMFMobileHeader = 'X-WAP'; or modify your cache (Varnish) header setting, as long as they match.

ЧаВо

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 include/skins/minerva.mustache). 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 Тема оформления:MinervaNeue skin installed. If you don't you'll need to install this or configure your mobile skin per instructions above.

Для разработчиков расширений

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.

Смотрите также

• Mobile web browsers supported by MobileFrontend
• Extension:TextExtracts
• Wikimedia's MobileFrontend configuration file
• Commons:Category:MediaWiki extension MobileFrontend