Manual:$wgAppleTouchIcon

From MediaWiki.org
Jump to: navigation, search
Translate this page; This page contains changes which are not marked for translation.

Other languages:
Deutsch • ‎English • ‎español • ‎français • ‎日本語 • ‎polski • ‎português do Brasil • ‎中文
Paths: $wgAppleTouchIcon
Optional URL to an icon to use when bookmarking to the home screen on Apple handheld devices
Introduced in version: 1.12.0 (r29942)
Removed in version: still in use
Allowed values: relative path or absolute URL
Default value: false
Other settings: Alphabetical | By function

Details[edit]

Apple's iPhone, iPod Touch and iPad devices have the ability to display an icon when you save a bookmark onto the home screen from Safari. This is somewhat similar to a favicon, but with larger sizes (57x57, 72x72, 114x114 and 144x144 pixels, depending on the device).

Safari Web Content Guide recommends to place a file named "apple-touch-icon.png" in your web site's document root directory; use "apple-touch-icon-precomposed.png" to avoid the iOS-created rounded corners and glossy shine effect for your icon. However, if for some reason you want to use a custom-set icon, you can use the following format:

$wgAppleTouchIcon = "/wiki/icons/apple-touch-icon.png";

This produces a <link> tag in HTML header output:

<link rel="apple-touch-icon" href="/wiki/icons/apple-touch-icon.png" />

As $wgAppleTouchIcon is set to false by default, MediaWiki will not generate the link, and the browser will attempt to load "/apple-touch-icon.png". If this doesn't exist either, a thumbnail of the page is used which is not very attractive.

Using the override option, wikis may set a different icon from other pages on the same host, or may simply choose to set a custom URL.

For Android devices place "apple-touch-icon-precomposed.png" in your root directory, and include $wgAppleTouchIcon = "$wgScriptPath/apple-touch-icon-precomposed.png"; in LocalSettings.php.

Guidelines[edit]

An iPhone home screen including some custom site icons.

Clean images with good sharpness and contrast and a bright colored background will fit in reasonably well with other icons. If you don't have one to test with, refer to handy screen shots such as the one here.

Apple documentation recommends a 114×114 pixel PNG image; however, 118×120 seems to be the mark for retina displays. A smaller image is scaled up slightly, becoming a bit blurry. Wikimedia projects currently (May 2017) use 152×152 pixel.

Rounded corners and a "glossy" texture are added by the iPhone UI, so use a flat, square background in your source image:

Original image: As rendered:
Wikipedia bookmark icon for iPhone.png Wikipedia bookmark icon as rendered on iPhone home screen.jpg

Transparent backgrounds are rendered as solid black.


See also[edit]