The dotMobi WordPress Mobile Pack
The dotMobi WordPress Mobile Pack is a complete toolkit from dotMobi to help mobilize your WordPress site and blog.
It includes a mobile switcher to select themes based on the type of user that is visiting the site, a selection of mobile themes, extra widgets, device adaptation and a mobile administration panel to allow users to edit the site or write new posts when out and about.
The pack has been tested on WordPress 2.5, 2.6, and 2.7. It is also compatible with WordPress MU 2.6 in the 'plugins' mode. The download itself (and the very simple installation instructions) are available at the end of this article.
The pack contains the following functionality:
- Mobile switcher to detect mobile visitors and provide an appropriate experience
- Base mobile theme for quick-and-easy XHTML-MP compliance
- Extended mobile themes so you can unleash your mobile creativity
- Transcoding and device adaptation to optimise the mobile experience
- DeviceAtlas integration for world-class adaptation
- Mobile admin panel for when posts can't wait
- Mobile ad widget to make you some money
- Barcode widget to help users bookmark your blog
Let's look at each of these in turn...
The mobile switcher identifies whether the visitor to the site is mobile or not, and switches between the primary WordPress theme (for desktop users) and a mobile theme (of the site owner's choice) accordingly.
It can use two approaches to identify the user as mobile. Firstly, it can try to identify if they have a mobile device based on the headers sent when a page is requested. Alternatively, it can identify whether the user has requested the site on a 'desktop domain' (such as yoursite.com) or a 'mobile domain' (such as yoursite.mobi) and deduce their intent from that.
The recommended approach is a third, combined, approach that uses both techniques, and also allows users to switch between sites if the choice is not appropriate by providing a link in the themes' footers or a widget.
In this combined mode, the switcher will provide interstitial warning pages if a mobile user accesses the desktop domain or vice-versa. It will also remember their choice of preferred site through the use of a cookie.
Settings for the switcher are found under the 'Mobile Switcher' admin page, and are self-explanatory.
More detail on these switching algorithms is available in a series of articles on this site.
Base mobile theme
The pack contains an extensible theme that is ready for display on mobile devices. The theme is XHTML-MP compliant and scores highly on dotMobi's ready.mobi site tester.
The base theme supports all standard WordPress content, including indexes, posts, pages, archives, search results, comments and widgets. If configured, it also invokes the device adaptation process (detailed below) that ensures the posts themselves are formatted suitable for mobile devices.
There are a number of simple settings that can be used to adapt the way in which lists of posts appear on the mobile theme. These are found under the 'Mobile Theme' admin page, which appears when the switcher component is installed (or when the mobile theme is selected as the main WordPress theme). It is possible to set how many posts appear on the home page and in archives, and how verbosely they display.
Away from the posts themselves, the theme does not provide a 'hard-coded' sidebar and relies wholly on the WordPress widget framework. Widgets that are selected in the WordPress admin pages (and then selected to show for the mobile theme) will appear in a 'sidebar' below the main part of the mobile page.
Since each widget adds size to the overall page, it is recommended that no more than 5 desktop widgets are enabled for the mobile theme. The 'Mobile Widgets' admin page also appears when the switcher component is installed (or when the mobile theme is selected as the main WordPress theme).
Any standard WordPress widgets that are known not to be XHTML-compliant are slightly rewritten by the theme to make them so. However, the theme does not currently correct arbitrary widget content and the use of third-party widgets (that were designed for desktop use) may easily push the overall page out of XHTML-MP compliance and affect the user's experience.
Large widgets are not currently split or paged for small mobile devices. This may increase the load time, cost to the user, or even make the page unreadable on a limited capability device. Be aware of this when enabling large widgets on the mobile theme.
Extended mobile themes
Simply by extending the base theme, it is very easy and quick to customise the mobile theme to fit existing requirements or brand.
The easiest way to do this is to re-tint the theme's colour scheme. The colour specifications for the base theme are all defined at the top of its stylesheet. Site owners can override this palette with their own colours, named DARKEST, DARK, MID, LIGHT, LIGHTEST and so on.
To demonstrate, three extended themes are available within this pack: blue, green and red. Note how they use the 'Template:' directive at the top of the stylesheet (and the CSS @import statement) to indicate that they extend the base theme.
Of course it is also easy to extend the theme in other, more structural ways, and even adapt the template's PHP files. However, if such changes should be done carefully to preserve XHTML-MP compliance within the markup.
Transcoding and device adaptation
When the base theme, or a theme that extends it, it used, the pack provides some features to adapt the content of the posts and pages of the blog to make them more suitable for mobile use.
There are four major stages to this process, and each may be enabled or disabled independently on the 'Mobile Theme' admin page. These are:
This will remove interactivity and media elements (such as script, Flash, movies, and embedded frames) from the posts and pages. Unless it is certain that users have high-capability handsets, these types of content will stretch the abilities of their mobile devices. The HTML tags removed are object, embed, marquee, script, frame and iframe. This process also removes any event attributes (such as onClick) from the page.
Partition large pages
This will break large blog posts or pages into smaller pieces more suitable for mobile devices. The length of each piece depends on the known memory limitations of the visitor's device (if DeviceAtlas integration is enabled), or will default to approximately 5K in size. Contiguous sections such as lists will not be broken, and a pager will appear at the bottom of each post to allow the user to page through the post.
This will shrink large images within posts or pages to fit on smaller screens. The width or height constraints of the device (if DeviceAtlas integration is enabled) are used to determine the new dimensions, or they will default to 124 pixels. This functionality relies on the server having the PHP graphics library LibGD installed (as it will be for PHP 4.3 or greater). Both the original and resized images are cached locally for performance, and site owners have an option to clear this cache on the admin page.
This will remove styling elements from the posts and pages to ensure mobile compatibility. The HTML attributes removed are: align, background, bgcolor, border, cellpadding, cellspacing, class, color, height, style and width. It removes the following tags: center, font, and span (although note that the inner content of those tags remains). Finally it removes any empty, non-singleton tags that do not have attributes.
If enabled, the mobile pack can invoke dotMobi's DeviceAtlas API to provide information about the device currently accessing the site. This is used in a number of ways:
- The device adaptation (above) uses DeviceAtlas to provide information about screen-size and page-size in order to change the content of the pages and posts.
- A DeviceAtlas widget can be placed on the site to display the name, screen size (and optionally, user-agent) of the device, if known. This is useful for testing the site on different handsets
- Programmatically, theme designers can use DeviceAtlas data to adapt the way the theme displays. Using the wpmp_deviceatlas_property($property_name) function will return a single property directly from the API, and wpmp_deviceatlas_device() will provide a reference to all the device's characteristics data. For example, site owners could use the following in a theme to provide a full-screen image:
<?php $d = wpmp_deviceatlas_device(); ?> <img src='...' width='<?php print $d->usableScreenWidth; ?>' height='<?php print $d->usableScreenHeight; ?>' />
The mobile pack does not ship with the DeviceAtlas API or data file. Site owners should sign up for a DeviceAtlas licence on the site itself, and contact dotMobi to enable it for the WordPress plugin. Having done so, site owners can enter the licence key into the 'DeviceAtlas' admin panel, and easily trigger the update process for the local data.
Mobile admin panel
A user identified as mobile by the switcher will receive a mobilised version of the WordPress administration interface. The link to the dashboard is available in the standard 'Meta' widget, or it can be reached directly at http://your.site/wp-admin
Only users with administrator status are allowed to access the mobile administration pages. Note this makes it more restrictive than the desktop dashboard, but this prevents less-authorised users from accessing it and making changes to important site settings.
The following pages are available in the mobile administration interface:
Like the desktop dashboard, this details how many pages, posts, categories and tags site owners have on the site. It also highlights how many comments currently await moderation.
Administrators may write a new post to appear on the site. They can specify the title and the body of the post, and whether they want it to remain draft, pending review, or published. It is not currently possible to specify tags, categories or other advanced properties of the post in the mobile interface.
This page lists all of the current posts and allows administrators to edit them. As for the 'New post' page, they can edit title, status, and body. It is not possible to edit the categories or tags and so on, although existing values for such properties of the post will remain set after editing in the mobile interface. Depending on the theme, a link to this edit panel may also be available on the site itself when administrators are logged in.
This page lists extracts of all of the comments awaiting moderation on the site. From this list, administrators can click on the commentator's name to see the whole comment, and, by clicking the appropriate links, set the comment to be published or marked as spam. Editing, de-approving or deleting a comment cannot be performed in this interface.
This page lists all the settings for the site which are simple enough to edit with this mobile interface. Complex settings, such as which plugins are installed, are not available. However, text- and number-based settings can be easily edited. Note that no descriptions are available for each setting and the meanings of the values, so it is advisable to only edit them cautiously
It is also possible to log-out of the admin panel. Since the login is stored persistently on the mobile device, this is advisable if the site is sensitive and administrators want to protect against the impact of handset theft.
The mobile administration panel uses the same URL structure as the desktop version, so in most cases, the administration links sent to administrators in emails (such as when a comment needs moderation) can be followed regardless of whether they are using a mobile device or a desktop.
Mobile ad widget
This provides the ability to place a new widget into the site containing either AdMob or Google mobile ads. Administrators will see the 'Mobile Ads' in the 'Widget' admin page, and it allows them to specify which provider to use, and the publisher ID.
The widget can also be configured to attempt to disable itself when shown on a desktop theme. This is recommended, since the quality of mobile ads presented in response to a desktop user context is lower, and relevant conversion rates may be negatively affected.
Google supports both single-ad and double-ad modes. Administrators can select which to use from the same publisher dropdown.
Site owners can place a two-dimensional QR-code widget on the desktop site that users can use to quickly navigate to the mobile version of the site. If their phones have a camera and QR-code reader capabilities, they can simply snap the barcode off their desktop screen and navigate directly to the mobile equivalent.
Within the widget site owners can specify the link to provide, and the size of the square barcode to show. Site owners should ensure it fits well into the desktop theme.
Site owners can also indicate whether they want the widget to show some instructions to the users about the purpose of the barcode, as well as a list of well-known readers they can download for their devices if they are not already installed.
Installation for WordPress v2.7 and later
On WordPress v2.7 and later, the installation is as follows:
- Go to the 'Plugins' / 'Add new' menu
- Upload wordpress_mobile_pack.1.0.8223.zip then press 'Install now'.
- Activate the switcher plugin. Change its settings as required.
- Select which desktop widgets are to appear on the mobile theme.
Installation on WordPress v2.6 and earlier
On WordPress v2.5 and v2.6, the installation is very slightly different:
- Locate your WordPress install on the file system
- Extract the contents of wordpress_mobile_pack.1.0.8223.zip into wp-content/plugins
- Activate the switcher plugin. Change its settings as required.
- Select which desktop widgets are to appear on the mobile theme.
More detailed instructions for installation and configuration are provided within the pack itself. There is also a readme file that identifies known limitations. The pack is distributed under the Apache 2 license.
We hope you enjoy using the WordPress Mobile Pack. Please let us know how we can improve it by contacting us or by using the comment form below. We're committed to working hard on developing it, addressing issues, and learning how it gets deployed.
For help and support please go to our WordPress forum and leave a message.
The author would like to thank Andrea Trasatti for moral support, relentless sanity checking and screenshot duty, Dennis Bournique for excellent feedback and patience in the face of constant iteration, Ronan Cremin and everyone else who has helped to test and review the plugin - and last but not least of course, Ribot for the beautiful mobile themes.
Download the WordPress mobile pack from wordpress.org