Mercurial > hg > soundsoftware-site
annotate vendor/plugins/gravatar/README.rdoc @ 307:c7d3b58bd01c feature_117
Produce a single en.yml which contains British texts but describes itself as just English.
The difference between en and en-GB is minimal for this application, apart from date formats, and the pain in maintaining both is significant. See #117 and #58.
| author | Chris Cannam |
|---|---|
| date | Mon, 28 Mar 2011 17:41:07 +0100 |
| parents | 513646585e45 |
| children |
| rev | line source |
|---|---|
| Chris@0 | 1 == Gravatar Plugin |
| Chris@0 | 2 |
| Chris@0 | 3 This plugin provides a handful of view helpers for displaying gravatars |
| Chris@0 | 4 (globally-recognized avatars). |
| Chris@0 | 5 |
| Chris@0 | 6 Gravatars allow users to configure an avatar to go with their email address at |
| Chris@0 | 7 a central location: http://gravatar.com. Gravatar-aware websites (such |
| Chris@0 | 8 as yours) can then look up and display each user's preferred avatar, without |
| Chris@0 | 9 having to handle avatar management. The user gets the benefit of not having to |
| Chris@0 | 10 set up an avatar for each site that they post on. |
| Chris@0 | 11 |
| Chris@0 | 12 == Installation |
| Chris@0 | 13 |
| Chris@0 | 14 cd ~/myapp |
| Chris@0 | 15 ruby script/plugin install git://github.com/woods/gravatar-plugin.git |
| Chris@0 | 16 |
| Chris@0 | 17 or, if you're using piston[http://piston.rubyforge.org] (worth it!): |
| Chris@0 | 18 |
| Chris@0 | 19 cd ~/myapp/vendor/plugins |
| Chris@0 | 20 piston import git://github.com/woods/gravatar-plugin.git |
| Chris@0 | 21 |
| Chris@0 | 22 == Example |
| Chris@0 | 23 |
| Chris@0 | 24 If you represent your users with a model that has an +email+ method (typical |
| Chris@0 | 25 for most rails authentication setups), then you can simply use this method |
| Chris@0 | 26 in your views: |
| Chris@0 | 27 |
| Chris@0 | 28 <%= gravatar_for @user %> |
| Chris@0 | 29 |
| Chris@0 | 30 This will be replaced with the full HTML +img+ tag necessary for displaying |
| Chris@0 | 31 that user's gravatar. |
| Chris@0 | 32 |
| Chris@0 | 33 Other helpers are documented under GravatarHelper::PublicMethods. |
| Chris@0 | 34 |
| Chris@0 | 35 == Acknowledgments |
| Chris@0 | 36 |
| Chris@0 | 37 Thanks to Magnus Bergmark (http://github.com/Mange), who contributed the SSL |
| Chris@0 | 38 support in this plugin, as well as a few minor fixes. |
| Chris@0 | 39 |
| Chris@0 | 40 The following people have also written gravatar-related Ruby libraries: |
| Chris@0 | 41 * Seth Rasmussen created the gravatar gem[http://gravatar.rubyforge.org] |
| Chris@0 | 42 * Matt McCray has also created a gravatar |
| Chris@0 | 43 plugin[http://mattmccray.com/svn/rails/plugins/gravatar_helper] |
| Chris@0 | 44 |
| Chris@0 | 45 == Author |
| Chris@0 | 46 |
| Chris@0 | 47 Scott A. Woods |
| Chris@0 | 48 West Arete Computing, Inc. |
| Chris@0 | 49 http://westarete.com |
| Chris@0 | 50 scott at westarete dot com |
| Chris@0 | 51 |
| Chris@0 | 52 == TODO |
| Chris@0 | 53 |
| Chris@0 | 54 * Add specs for ssl support |
| Chris@0 | 55 * Finish rdoc documentation |