ikiwiki (3.20130711) unstable; urgency=low
[ikiwiki.git] / doc / todo / avatar.mdwn
1 [[!tag wishlist]]
2
3 It would be nice if ikiwiki, particularly [[plugins/comments]]
4 (but also, ideally, recentchanges) supported user avatar icons.
5
6 > Update: Done for comments, but not for anything else, and the directive
7 > below would be a nice addition. --[[Joey]] 
8
9 Idea is to add a directive that displays a small avatar image for a user.
10 Pass it a user's the email address, openid, username, or the md5 hash
11 of their email address:
12
13         \[[!avatar user@example.com]]
14         \[[!avatar http://joey.kitenet.net/]]
15         \[[!avatar user]]
16         \[[!avatar hash]]
17
18 These directives can then be hand-inserted onto pages, or more likely,
19 included in eg, a comment post via a template.
20
21 An optional second parameter can be included, containing additional
22 options to pass in the 
23 [gravatar url](http://en.gravatar.com/site/implement/url).
24 For example, this asks for a smaller gravatar, and if a user does
25 not have a gravatar, uses a cute auto-generated "wavatar" avatar.
26
27         \[[!gravatar user@example.com "size=40&default=wavatar"]]
28
29 The `gravitar_options` setting in the setup file can be used to
30 specify additional options to pass. So for example if you want
31 to use wavatars everywhere, set it to "default=wavatar".