source: trunk/www.guidonia.net/wp/wp-content/plugins/wordpress-mobile-edition/README.txt@ 44

Last change on this file since 44 was 44, checked in by luciano, 14 years ago
File size: 3.7 KB
Line 
1=== WordPress Mobile Edition ===
2Tags: mobile, pda, wireless, cellphone, phone, iphone, touch, webkit, android, blackberry, carrington
3Contributors: alexkingorg
4Minimum version: 2.3
5Tested with: 2.8
6Stable tag: 3.1
7
8WordPress Mobile Edition is a plugin that shows an interface designed for a mobile device when visitors come to your site on a mobile device.
9
10Mobile browsers are automatically detected, the list of mobile browsers can be customized on the settings page.
11
12== Installation ==
13
141. Drop the wp-mobile.php file in your wp-content/plugins directory
152. Drop the carrington-mobile-(version #) directory in your wp-content/themes directory
163. Click the 'Activate' link for WordPress Mobile Edition on your Plugins page (in the WordPress admin interface)
17
18
19== Frequently Asked Questions ==
20
21= Is this compatible with the WP plugin auto-upgrade feature? =
22
23No. The mobile theme needs to be moved to your themes directory and the WP plugin auto-upgrade does not do this. For this reason, please follow the installation instructions here.
24
25
26= Is this compatible with WP (Super) Cache? =
27
28Yes, it is compatible with WP Super Cache 0.9 (using WP Cache mode).
29
30
31= Does this create a mobile admin interface too? =
32
33No, it does not.
34
35
36= Does this serve a mobile interface to mobile web search crawlers? =
37
38Yes, to Google and Yahoo mobile search crawlers. You can add any others by adding their user agents in the plugin's Settings page.
39
40
41= Does this support iPhones and other "touch" browsers? =
42
43Yes, as of version 3.0. There is a customized interface for advanced mobile browsers and special styling to make things "finger-sized" for touch browsers.
44
45
46= My mobile device isn't automatically detected, what do I do? =
47
48Visit the settings page and use the link there to identify your mobile browser's User Agent.
49
50Then add that to the list of mobile browsers in your settings.
51
52
53= Does this conflict with other iPhone theme plugins? =
54
55Not fundamentally. If you remove the iPhone from the list of detected browsers, then the other iPhone theme should work as normal.
56
57
58= Does this support pages too? =
59
60Yes, it does.
61
62
63= Can I create a link that forces someone to see the mobile version? =
64
65Yes, this is included as an experimental feature in version 2.1. The link can be added to your theme by using the akm_mobile_link() template tag:
66
67`<?php in (function_exists('cfmobi_mobile_link') { cfmobi_mobile_link(); } ?>`
68
69Note that this does not work if you have WP Cache enabled.
70
71
72= Why are recent posts shown on every page? =
73
74This is a feature of the plugin to allow easy access to recent content.
75
76
77= How do I customize the display of the mobile interface? =
78
79The contents of the wp-mobile folder are a standard WordPress theme. Any changes you make there will affect the display of the mobile interface.
80
81
82== Examples ==
83
84You can see the mobile theme in action here: http://mobile.carringtontheme.com
85
86
87== API ==
88
89There is a filter `cfmobi_check_mobile` that allows you to affect if a mobile browser is detected.
90
91`function your_mobile_check_function($mobile_status) {
92
93 // do your logic, set $mobile_status to true/false as needed
94
95 return $mobile_status;
96}
97add_filter('cfmobi_check_mobile', 'your_mobile_check_function');`
98
99
100There is an action `cfmobi_settings_form` that allows you to add to the settings page for this plugin. Handling form posts and other activities from anything you add to this form should be done in your plugin.
101
102`function your_settings_form() {
103 // create your form here - don't forget to catch the form submission as well
104}
105add_action('cfmobi_settings_form', 'your_settings_form');`
106
107
108== Changelog ==
109
110= 3.1 =
111
112- Added changelog
113- Added filter to enable other plugins to participate in mobile checking
114- Added hook to enable other plugins to add to the settings page
Note: See TracBrowser for help on using the repository browser.