-
Notifications
You must be signed in to change notification settings - Fork 6
Expand file tree
/
Copy pathreadme.txt
More file actions
195 lines (118 loc) 路 6.27 KB
/
Copy pathreadme.txt
File metadata and controls
195 lines (118 loc) 路 6.27 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
=== Hammy ===
Contributors: Noel_Tock
Donate link: http://www.noeltock.com
Tags: responsive, adaptive, image, images, figure, picture, pictures, smartphone, mobile, resize, resized, automatic, automated, speed, fast
Requires at least: 3.5
Tested up to: 3.8.1
Stable tag: 1.5.1
Hammy speeds up your website by generating and serving resized images for your content area depending on content width.
== Description ==
= Introduction =
Hammy takes your regular content images (only within posts and pages, not custom post types) and regenerates a number of smaller sized images. When a person visits your website, it then automatically provides them with the most appropriate image (or the smallest one possible). This makes for a better experience, especially on mobile. This uses the new WP 3.5 image code.
= Will it work on my Theme? =
**Yes!** (the only exception being themes with no standard posts or pages)
= How does it work? =
When activated, the `<img>` tag is replaced by the `<figure>` tag, and the alternate image sizes are provided in a way that only jQuery can access/load. If jQuery isn't available, it falls back to the regular image you had there in the first place.
It also takes on any classes or alternate titles from the original image. It does not make any changes to your database (i.e. content or images that you already have remain untouched).
= What else do I need to know? =
* Supports Retina
* Uses WordPress 3.5 Image Code (no external dependency)
* You need to be willing to **spend a few minutes configuring and playing with the breakpoints and choosing the correct parent container** to get it right.
* Hammy filters the output every single time, but only needs to generate a resized image once.
= Updates =
Follow me for updates at [@noeltock](http://www.twitter.com/noeltock)
= GitHub =
If you have technical issues or other enhancements that you'd like to contribute, please do so in the form of a pull request or issue here:
[http://wordpress.org/plugins/hammy/](http://wordpress.org/plugins/hammy/)
== Installation ==
Video Walkthrough
http://www.youtube.com/watch?v=GpmAaGAW9-c
Hammy already starts working upon activation, so any configuration is optional:
1. Upload the folder `hammy` to the `/wp-content/plugins/` directory
1. Activate the plugin through the 'Plugins' menu in WordPress
1. (Optional) Go to Settings -> Hammy and review the options. Add the id/class of the container that holds your posts (i.e. #content). Then add breakpoints that are relevant to that container ( **see the FAQ for an example** ).
1. (Optional) Edit your theme's CSS to add `figure.hammy-responsive`, in a way that it is identical to any `img` styling used for your content area.
== Frequently Asked Questions ==
= How does the post/page container setting work? =
The width of your browser is quite different than that of the post/page container (i.e. #content). By being able to measure the width of the content container instead of the browser window, you'll ensure far better accuracy at all breakpoints.
= Breakpoints example? =
If your website is 960px wide, but the content (#content) is only 600px, then `600` is your largest breakpoint. If the next smaller size is iPhone landscape (where the sidebar is also positioned underneath the content) and you have a 10px margin on either side, that breakpoint is `460` (480 minus 20), and so forth.
At the end, your breakpoints may look like `300,460,600`
= It doesn't work with this gallery plugin or something else, what to do? =
You have the ability to ignore certain classes (i.e. ".gallery-thumb"), but please let me know of any edge-cases on the [Hammy forums](http://wordpress.org/support/plugin/hammy)
= How is Hammy constructed? =
Hammy is possible through two awesome open source projects:
* [jQuery Picture](http://jquerypicture.com/) by [Abban Dunne](http://abandon.ie/) (this script has been sligthly altered in order to be able to target a particular container).
* [WPThumb](http://hmn.md/introducing-wp-thumb/) by [Human Made Limited](http://hmn.md)
They're both worth checking out and getting a better understanding of (or using in your mega-awesome WordPress client projects).
= What's with the squirrel? =
Hammy, from the movie "Over the Hedge", he's quite fast, like these images. Be sure to check out the movie for full appreciation.
== Screenshots ==
1. Options Screen
== Changelog ==
= 1.5.1 =
* Fix invalid markup
= 1.5.0 =
* Moved back to using `figure` as opposed to `picture`for larger compatibility (especially IE). **Check your CSS to make sure figure** acts like an image.
* Updated Lazy Load to 1.9.3
* Gave Lazy Load placeholders dimensions so that the browser doesn't reflow for each load
= 1.4.1 =
* Fixed Warnings
* Typo
* Tested PNG
= 1.4 =
* Allow images smaller then the smallest breakpoint to function
* WPThumb Update
* 3.8.1 Compatibility Testing
= 1.3.2 =
* WPThumb Update
= 1.3.1 =
* Readme & Banner changes
= 1.3.0 =
* Updated WPThumb
* Added defaults that take into consideration `$content_width` if available.
= 1.2.3 =
* Add Walkthrough Video (under Installation)
= 1.2.1 =
* Fixed typo
* Added walkthrough
= 1.2 =
* Fixed readme.txt typo's
* Added title attribute to images
* Updated WPThumb to latest
= 1.1 =
* Add Lazy Loading with the help of @jacquesletesson
* Clean up code to conform to WP standards more
* Latest version of WPThumb
= 1.0 =
* Uses WordPress 3.5 core for powering resizes.
* Fixes
= 0.3.1 =
* Slight logic change for the better
= 0.3 =
* Changed tag figure to picture, closer to w3 discussions
* Retina Support
= 0.1.1 =
* Fix for if logic
= 0.1 =
* Initial Release (Hammy Time)
== Upgrade Notice ==
= 1.5.1 =
* Fix invalid markup
= 1.5.0 =
* Important enhancements, check CSS
= 1.4.1 =
* Important fix
= 1.4 =
* Bug fix, 3.8.1 check and WPThumb update
= 1.3.1 =
* Updated various aspects of all the plugin.
= 0.3.1 =
* Slight logic change for the better
= 0.3 =
* Changed tag figure to picture, closer to w3 discussions
* Retina Support
= 0.1.1 =
* Small but important fix
== Feedback & Bugs ==
Kindly post any issues, questions or suggestions on the [Hammy forums](http://wordpress.org/support/plugin/hammy) .