PluginProbe
Multi Device Switcher / 1.3.0
Multi Device Switcher v1.3.0
trunk 1.0.0 1.0.1 1.0.2 1.0.3 1.0.4 1.1.0 1.1.1 1.1.2 1.2.0 1.2.1 1.2.2 1.2.3 1.3.0 1.4.0 1.4.1 1.4.2 1.5.0 1.5.1 1.5.2 1.5.3 1.5.4 1.6.0 1.6.1 1.6.2 All 34 releases
multi-device-switcher / readme.md

readme.md in Multi Device Switcher 1.3.0, at readme.md

200 lines 6.5 KB
No matching file
Up and down to move Enter to open Esc to close
Raw Download Zip
1 # Introducing Multi Device Switcher
2
3 This WordPress plugin allows you to set a separate theme for device (Smart Phone, Tablet PC, Mobile Phone, Game and custom).
4 This plugin detects if your site is being viewed by UserAgent, and switches to selected theme.
5 The Custom Switcher can add every device.
6
7 ## Features
8
9 - Set a separate theme for device (Smart Phone, Tablet PC, Mobile Phone, Game), switches to selected theme.
10 - Add every device by the Custom Switcher.
11 - Add links 'Mobile' or 'PC' in the theme by the PC Switcher, switch to the default theme.
12 - Can be using is_multi_device() function that detect of the device.
13
14 ## How do I use it ?
15
16 1. Download and unzip files. Or install multi-device-switcher using the WordPress plugin installer. In that case, skip 2.
17 2. Upload "multi-device-switcher" to the "/wp-content/plugins/" directory.
18 3. Activate the plugin through the 'Plugins' menu in WordPress.
19 4. Upload a separate theme to the "/wp-content/themes/" directory.
20 5. Go to the "Multi Device Switcher" options page through the 'Appearance' menu in WordPress.
21 6. Configure settings to your needs. Select Theme by Theme option. Add and fix UserAgent by UserAgent option if necessary.
22 7. Have fun!
23
24 ## Screenshot
25
26 <img src="screenshot-1.png">
27 <img src="screenshot-2.png">
28 <img src="screenshot-3.png">
29
30 ## How to add the Custom Switcher
31
32 1. Go to the "Multi Device Switcher" options page through the 'Appearance' menu in WordPress.
33 2. Enter the name of the Custom Switcher (20 characters max, alphanumeric) to the 'Add Custom Switcher'. Push the button 'Add'.
34 3. Configure settings. Select Theme by Theme option. Add UserAgent by UserAgent option.
35 4. Have fun!
36
37 ## Setting and Using the PC Switcher
38
39 There are three ways how to Using the PC Switcher.
40
41 <img src="screenshot-4.png">
42
43 ### 1. Add a PC Switcher to the footer
44
45 1. Go to the "Multi Device Switcher" options page through the 'Appearance' menu in WordPress.
46 2. Configure settings. Check the checkbox 'Add a PC Switcher to the footer.' by PC Switcher option.
47 3. Have fun!
48
49 ### 2. Add a PC Switcher to your sidebars/widget areas
50
51 1. Add-on the widget 'PC Switcher', when you activate the plugin "Multi Device Switcher".
52 2. Go to the "Widgets" options page through the 'Appearance' menu in WordPress.
53 3. Drag and drop the title bars 'PC Switcher' into the desired area.
54 4. Have fun!
55
56 ### 3. For the theme authors and developers, add a PC Switcher to your theme.
57
58 1. Add the following code into the PHP files, when you develop your theme.
59 ```
60 <?php if ( function_exists('multi_device_switcher_add_pc_switcher') ) { multi_device_switcher_add_pc_switcher(); } ?>
61 ```
62 2. Have fun!
63
64 ### Using default CSS and customized CSS
65
66 1. Go to the "Multi Device Switcher" options page through the 'Appearance' menu in WordPress.
67 2. Configure settings. Check the checkbox 'Add a default CSS.' by PC Switcher option. If you want to customize CSS, uncheck the checkbox.
68 3. Have fun!
69
70 ## UserAgent option Samples
71
72 * [](https://github.com/thingsym/multi-device-switcher/wiki/Default-UserAgentDefault UserAgent](https://github.com/thingsym/multi-device-switcher/wiki/Default-UserAgent](https://github.com/thingsym/multi-device-switcher/wiki/Default-UserAgent)
73
74 ## is_multi_device() function
75
76 is_multi_device() function is a boolean function, meaning it returns either TRUE or FALSE. Works through the detection of the device by the Multi_Device_Switcher class.
77
78 ### Usage
79
80 ```
81 <?php is_multi_device('smart'); ?>
82 ```
83
84 ### Examples
85
86 ```
87 <?php
88 if ( function_exists( 'is_multi_device' ) ) {
89 if ( is_multi_device('smart') ) {
90 /* Display and echo smartphone specific stuff here */
91 } elseif ( is_multi_device('tablet') ) {
92 /* Display and echo tablet specific stuff here */
93 }
94 }
95 ?>
96 ```
97
98 ### Parameters
99
100 **device name** (required)
101
102 (string) The name of the device
103
104 * smart
105 * tablet
106 * mobile
107 * game
108 * the name of the Custom Switcher
109
110 ### Return Values
111
112 (boolean) Return boolean whether a particular device.
113
114 ## Contributing
115
116 ### Patches and Bug Fixes
117
118 Small patches and bug reports can be submitted a issue tracker in Github. Forking on Github is another good way. You can send a pull request.
119
120 #### Contributors
121
122 * hykw [](https://github.com/hykw/multi-device-switcherGithub](https://github.com/hykw/multi-device-switcher](https://github.com/hykw/multi-device-switcher)
123
124 ### Translations
125
126 Translating a plugin takes a lot of time, effort, and patience. I really appreciate the hard work from these contributors.
127
128 If you have created or updated your own language pack, you can send [](http://codex.wordpress.org/Translating_WordPressgettext PO and MO files](http://codex.wordpress.org/Translating_WordPress](http://codex.wordpress.org/Translating_WordPress) to author. I can bundle it into Multi Device Switcher.
129
130 #### Translator
131
132 - Japanese (ja) - <a href="http://global.thingslabo.com/blog/">Thingsym</a>
133
134 ##### The latest PO and MO files
135
136 - [](http://plugins.svn.wordpress.org/multi-device-switcher/trunk/languages/multi-device-switcher.potPOT file](http://plugins.svn.wordpress.org/multi-device-switcher/trunk/languages/multi-device-switcher.pot](http://plugins.svn.wordpress.org/multi-device-switcher/trunk/languages/multi-device-switcher.pot)
137 - [](http://plugins.svn.wordpress.org/multi-device-switcher/trunk/languages/PO files](http://plugins.svn.wordpress.org/multi-device-switcher/trunk/languages/](http://plugins.svn.wordpress.org/multi-device-switcher/trunk/languages/)
138
139 ##### Send your own language pack
140
141 You can send your own language pack to author.
142
143 - [](https://github.com/thingsym/multi-device-switchermulti-device-switcher - GitHub](https://github.com/thingsym/multi-device-switcher](https://github.com/thingsym/multi-device-switcher)
144 - [](http://global.thingslabo.com/blog/http://global.thingslabo.com/blog/ (en)](http://global.thingslabo.com/blog/](http://global.thingslabo.com/blog/)
145 - [](http://blog.thingslabo.comhttp://blog.thingslabo.com (ja)](http://blog.thingslabo.com](http://blog.thingslabo.com)
146
147 ## Changelog
148
149 * Version 1.3.0
150 * fixed: fix script, style, html and readme
151 * new features: is_multi_device() function
152 * fixed: fix translation
153 * updated: update default UserAgent
154 * fixed: replace WP_PLUGIN_URL with plugins_url()
155 * fixed: using Page Hook Suffix
156 * merged: pull request [#3](https://github.com/thingsym/multi-device-switcher/pull/3)
157 * Version 1.2.3
158 * fixed: fix redirect uri with query string, using add_query_arg
159 * fixed: fix translation
160 * fixed: fix readme
161 * Version 1.2.2
162 * improved: improve responsiveness UI
163 * fixed: fix html
164 * Version 1.2.1
165 * fixed: delete add_contextual_help
166 * fixed: fix readme and html
167 * Version 1.2.0
168 * added: add PC Switcher Widget
169 * new features: PC Switcher
170 * added: add the settings link to the plugin page
171 * Version 1.1.2
172 * required: at least version 3.4
173 * fixed: fix tabs and buttons
174 * Version 1.1.1
175 * fixed: change the order of the UserAgent detection
176 * updated: update default UserAgent
177 * added: add HTTP/1.1 Vary header
178 * Version 1.1.0
179 * new features: Custom Switcher
180 * Version 1.0.4
181 * fixed: fix the object model PHP5, __construct() to replace Multi_Device_Switcher
182 * fixed: wp_get_themes(), and wp_get_theme() to replace get_themes(), get_theme()
183 * Version 1.0.3
184 * updated: update screenshots
185 * fixed: fix reset button
186 * Version 1.0.2
187 * added: add file uninstall.php
188 * fixed: split admin_enqueue_scripts() into two functions
189 * fixed: detects is_admin()
190 * Version 1.0.1
191 * fixed: split multi_device_switcher_init() into two functions
192 * Version 1.0.0
193 * Initial release.
194
195 ## Upgrade Notice
196
197 * 1.1.2
198 * Requires at least version 3.4 of the Wordpress
199
200