PluginProbe
CoolClock / 4.2
CoolClock v4.2
4.3.8 trunk 0.1 2.0 2.9.8 3.0 3.1 3.2 3.3 4.0 4.1 4.2 4.3.3 4.3.4 4.3.5 4.3.6 4.3.7
coolclock / readme.txt

readme.txt in CoolClock 4.2, at readme.txt

237 lines 9.1 KB
No matching file
Up and down to move Enter to open Esc to close
Raw Download Zip
1 === CoolClock - a Javascript Analog Clock ===
2 Contributors: RavanH
3 Donate link: https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=ravanhagen%40gmail%2ecom&item_name=CoolClock%20for%20WordPress&item_number=1%2e3%2e4%2e9&no_shipping=0&tax=0&charset=UTF%2d8&currency_code=EUR
4 Tags: clock, analog clock, coolclock, javascript, jquery, widget, shortcode, logarithmic clock
5 Requires at least: 4.8.1
6 Tested up to: 5.3
7 Requires PHP: 5.6
8 Stable tag: 4.2
9
10 Show an analog clock on your WordPress site sidebar or in post and page content.
11
12 == Description ==
13
14 This plugin integrates [CoolClock - The Javascript Analog Clock](http://randomibis.com/coolclock/) into your WordPress site. You can add it as a **widget** to your sidebar or insert it into your posts and pages with a **shortcode**. See [the FAQ's](http://wordpress.org/extend/plugins/coolclock/faq/) for available shortcode parameters and how to build the clock into your theme.
15
16 = Features =
17
18 - Can be added via a widget, shortcode or theme function
19 - No flash, meaning compatible with tablets and most other javascript enabled mobile devices
20 - 22 different skins to choose from or
21 - Custom skin option to create your own skin style
22 - Linear or logarithmic time scale
23
24 Read more on the [CoolClock homepage](https://status301.net/wordpress-plugins/coolclock/) or see [the FAQ's](http://wordpress.org/extend/plugins/coolclock/faq/) to learn how to configure your own skin settings.
25
26 = Pro features =
27
28 - Show date or 24h digital time
29 - Background image or color
30 - Border radius (rounded corners for background)
31 - Advanced positioning options (relative to background)
32 - Advanced shortcode parameters (including background image and custom skin)
33 - One extra clean skin for use with background image
34 - Support on the [CoolClock Pro forum](https://premium.status301.net/support/forum/coolclock-pro/)
35
36 Pro features come with the [CoolClock - Advanced extension](https://premium.status301.net/downloads/coolclock-advanced/).
37
38 = Translators =
39
40 - **Dutch** * R.A. van Hagen https://status301.net/ (version 3.0)
41 - **French** * R.A. van Hagen https://status301.net/ (version 3.0)
42 - **German** * Manfred Mrak http://www.niftyfox.ch/ (version 3.2)
43 - **Serbian** * Borisa Djuraskovic - WebHostingHub http://www.webhostinghub.com/ (version 2.9.4)
44 - **Slovenian** * Adijan Dervišević - http://www.adijan.eu (version 3.2)
45 - **Russian** * Наталия Завьялова - http://time-impressions.ru (version 2.9.8)
46
47 Please [contact me](https://status301.net/contact-en/) to submit your translation and get mentioned here :)
48
49 = Privacy / GDPR =
50
51 This plugin does not collect any user or visitor data nor set browser cookies. Using this plugin should not impact your site privacy policy in any way.
52
53
54 == Installation ==
55
56 = Wordpress =
57
58 Quick installation: [Install now](http://coveredwebservices.com/wp-plugin-install/?plugin=coolclock) !
59
60 … OR …
61
62 Search for "coolclock" and install with that slick **Plugins > Add New** back-end page.
63
64 … OR …
65
66 Follow these steps:
67
68 1. Download archive.
69
70 2. Upload the zip file via the Plugins > Add New > Upload page … OR … unpack and upload the complete directory with your favourite FTP client to the /plugins/ folder.
71
72 3. Activate the plugin on the Plug-ins page.
73
74 Now visit your Widgets admin page and add the Analog Clock widget to your sidebar. :)
75
76
77 == Frequently Asked Questions ==
78
79 = Where do I start? =
80
81 There is no options page. Just go to your Appearance > Widgets admin page and find the new Analog Clock widget. Add it to your sidebar and change settings if you want to see another than the default clock.
82
83 Other ways to integrate a clock into your site are shortcodes or a theme function. See instructions below.
84
85 = What options does the widget have? =
86
87 First of all, you can pick a preset skin. There are 21 skins made by other users and, when the Advanced extension is added, one Minimal skin that only shows the clock arms, that can be useful for placing over a custom background image.
88
89 There are these options:
90
91 - Custom skin parameters - see question below;
92 - Radius - changes the clock size;
93 - Hide second hand;
94 - Show digital time (more options in the Advanced version);
95 - Set digital time color;
96 - GMT Offset - use this if you want one or more clocks to show the time for other timezones;
97 - Scale - linear is our standard clock scale, the other two show a logarithmic time scale;
98 - Align - left, center or right;
99 - Subtext - optional text, centered below the clock.
100
101 Then there are extra options availabe in the [CoolClock - Advanced extension](https://premium.status301.net/downloads/coolclock-advanced/) which allow for more customisation:
102
103 - Background image - define the full URL or path to an image to serve as background;
104 - Repeat image;
105 - Background size - stretch or cover to make it match your clock size;
106 - Background position - center, top, right, bottom or left of the wrapping div (define div size below);
107 - Width and height - define the size of the wrapping div that holds the background image;
108 - Background color - define a color value in hex or rgb(a) format, or a css color name;
109 - Border radius - optional rounded corners, higher is rounder;
110 - Clock position relative to background - here you can position the clock relative to top and left border of the wrapping div (as defined above) that holds the background image.
111 - Custom skin parameters for shortcode
112
113 = How can I create a custom skin? =
114
115 Follow the steps on [Creating a Custom Skin](https://premium.status301.net/coolclock-custom-skin/) and if you
116
117
118 = Can I share this fantastic custom skin I created? =
119
120 If you made a nice skin and would like to share it, you can do so in the comments on [Creating a Custom Skin](https://premium.status301.net/coolclock-custom-skin/) or add it to your [Plugin Review](http://wordpress.org/support/view/plugin-reviews/coolclock).
121
122 Thanks for sharing! :)
123
124
125 = Can I insert a clock in posts or pages? =
126
127 Yes, there the shortcode **[coolclock** **/]** available. You can find all parameters on [How to use the CoolClock shrotcode](https://premium.status301.net/how-to-use-the-coolclock-shortcode/).
128
129
130 = I'm building my own theme. Is there a theme function available? =
131
132 Yes, you can use a built-in WordPress function that parses a shortcode. To place the same clock as in the shortcode example above, anywhere in your theme, use this:
133
134 `<?php echo do_shortcode('[ coolclock skin="chunkySwiss" radius="140" showdigital=true align="left" ]'); ?>`
135
136
137 == Known Issues ==
138
139 1. When IE 8 is manually put or forced (through X-UA-Compatibility meta tag or response header) into Compatibility mode, the Clock will --even though the canvas area is put in place-- remain invisible.
140
141 2. When a shortcode is not placed on its own line but on the same line with text, image or even another shortcode, then the output (div with canvas tag) will be wrapped inside a paragraph tag. While most browsers do not have a problem displaying the clock, this *will* cause a validation error.
142
143 Please report any other issues on the [Support page](http://wordpress.org/support/plugin/coolclock).
144
145
146 == Screenshots ==
147
148 1. Example analog clock in sidebar. The background logo is added with the [CoolClock - Advanced extension](https://premium.status301.net/downloads/coolclock-advanced/).
149
150 2. Widget settings. The background options are availabe in the [CoolClock - Advanced extension](https://premium.status301.net/downloads/coolclock-advanced/).
151
152
153 == Upgrade Notice ==
154
155 = 4.2 =
156 Plugin support and rate links, input validation and bugfixes
157
158 == Changelog ==
159
160 = 4.2 =
161 * Custom skin parameters in shortcode
162 * Plugin support and rate links
163 * Widget color code validation
164 * FIX shortcode skin names case-sensitive
165 * FIX undefined index
166
167 = 4.1 =
168 * Digital text styling
169 * Clock icon for widget in Customizer
170 * FIX: use .min script versions when not in debug mode
171
172 = 4.0 =
173 * Split up classes
174 * Don't use print_scripts the wrong way
175
176 = 3.3 =
177 * Wrapper div class "coolclock"
178 * User input shortcode attributes validation
179
180 = 3.2 =
181 * Dropped compatibility with PHP 4 and pre WP 3.2
182 * German translation
183
184 = 3.1 =
185 * Deprecating PHP4 style constructor for Widget
186 * Bugfix undefined index
187
188 = 3.0 =
189 * Responsive canvas styling
190
191 = 2.9.8 =
192 * Translation string fixes
193 * Russian translation by Natalia Zavyalova
194
195 = 2.9.7 =
196 * Prepare custom skin for shortcode in advanced extension
197 * BUGFIX: disable wptexturize for shortcode content
198
199 = 2.9.6 =
200 * Skin watermelon alpha fix
201 * BUGFIX: Non-static method should not be called statically
202 * BUGFIX: Undefined index
203
204 = 2.9.5 =
205 * BUGFIX: PHP 5.4 Using $this when not in object context
206 * BUGFIX: Non-static method should not be called statically
207
208 = 2.9.4 =
209 * New clock skin shared by user MrCarlLister
210 * Use Globaltick branch script version 3.0.0-pre
211 * BUGFIX: undefined index in widget form
212
213 = 2.9.2 =
214 * BUGFIX: Thread between tip of the second hand and 3 o'clock in IE
215 * Shortcode filter
216
217 = 2.9 =
218 * BUGFIX: excanvas included too late
219 * CoolClock.js version 3.0.0-pre
220 * Allow shortcode in text widget
221 * NEW: Subtext option
222 * NEW: Widget align option
223
224 = 2.0 =
225 * NEW: logClock option
226
227 = 1.1 =
228 * Minified javascript
229
230 = 1.0 =
231 * Sidebar widget overhaul
232 * Class
233 * NEW: Shortcode
234
235 = 0.1 =
236 * First implementation of CoolClock in sidebar widget
237