aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJoey Hess <joey@kitenet.net>2010-06-23 20:12:26 -0400
committerJoey Hess <joey@kitenet.net>2010-06-23 20:16:01 -0400
commit9a32451986c710d1f1ce71217c1f7ab3b84f72bf (patch)
treec3bf789d7d0e247327d94e5ff696ba50aba81526 /doc
parenta4f381ace837a032bc202cc6b2a98e922d4b7cfc (diff)
downloadikiwiki-9a32451986c710d1f1ce71217c1f7ab3b84f72bf.tar
ikiwiki-9a32451986c710d1f1ce71217c1f7ab3b84f72bf.tar.gz
finializing openid nickname support
Renamed usershort => nickname. Note that this means existing user login sessions will not have the nickname recorded, and so it won't be used for those.
Diffstat (limited to 'doc')
-rw-r--r--doc/ikiwiki/directive/comment.mdwn2
-rw-r--r--doc/plugins/write.mdwn2
2 files changed, 3 insertions, 1 deletions
diff --git a/doc/ikiwiki/directive/comment.mdwn b/doc/ikiwiki/directive/comment.mdwn
index 693a92770..398130e2e 100644
--- a/doc/ikiwiki/directive/comment.mdwn
+++ b/doc/ikiwiki/directive/comment.mdwn
@@ -29,6 +29,8 @@ metadata of the comment.
nearly any format, since it's parsed by [[!cpan TimeDate]]
* `username` - Used to record the username (or OpenID)
of a logged in commenter.
+* `nickname` - Name to display for a logged in commenter.
+ (Optional; used for OpenIDs.)
* `ip` - Can be used to record the IP address of a commenter,
if they posted anonymously.
* `claimedauthor` - Records the name that the user entered,
diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index a2b954bd4..a921b9a02 100644
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -1108,7 +1108,7 @@ The data structure returned for each change is:
{
rev => # the RCSs id for this commit
user => # user who made the change (may be an openid),
- usershort => # short name of user (optional; not an openid),
+ nickname => # short name for user (optional; not an openid),
committype => # either "web" or the name of the rcs,
when => # time when the change was made,