3c2c712bb361341562af0e451c3ee55e5a80fd4b
[ikiwiki.git] / doc / todo / avatar.mdwn
1 [[!tag wishlist]]
2
3 It would be nice if ikiwiki, particularly [[plugins/comments]]
4 supported user avatar icons. I was considering adding a directive for this,
5 as designed below.
6
7 However, there is no *good* service for mapping openids to avatars --
8 openavatar has many issues, including not supporting delegated openids, and
9 after trying it, I don't trust it to push users toward. 
10 Perhaps instead ikiwiki could get the email address from the openid
11 provider, though I think the perl openid modules don't support the openid
12 2.x feature that allows that.
13
14 At the moment, working on this doesn't feel like a good use of my time.
15 --[[Joey]]
16
17 ----
18
19 The directive displays a small avatar image for a user. Pass it the
20 email address, openid, or wiki username of the user.
21
22         \[[!avatar user@example.com]]
23         \[[!avatar http://joey.kitenet.net/]]
24         \[[!avatar user]]
25
26 The avatars are provided by various sites. For email addresses, it uses a
27 [gravatar](http://gravatar.com/). For openid,
28 [openavatar](http://www.openvatar.com/) is used. For a wiki username, the
29 user's email address is looked up and the gravatar for that user is
30 displayed. (Of course, the user has to have filled in their email address
31 on their Preferences page for that to work.)
32
33 An optional second parameter can be included, containing additional
34 options to pass in the 
35 [gravatar url](http://en.gravatar.com/site/implement/url).
36 For example, this asks for a smaller gravatar, and if a user does
37 not have a gravatar, uses a cute auto-generated "wavatar" avatar.
38
39         \[[!gravatar user@example.com "size=40&default=wavatar"]]
40
41 The `gravitar_options` setting in the setup file can be used to
42 specify additional options to pass. So for example if you want
43 to use wavatars everywhere, set it to "default=wavatar".