← Back to branch summary

~kosova/+junk/tuxfamily-twiki

« back to all changes in this revision

Viewing changes to foswiki/data/System/VarUSERINFO.txt

  • Committer: James Michael DuPont
  • Date: 2009-07-18 19:58:49 UTC
  • Revision ID: jamesmikedupont@gmail.com-20090718195849-vgbmaht2ys791uo2
added foswiki

Show diffs side-by-side

added added

removed removed

Lines of Context:
foswiki/data/System/VarUSERINFO.txt
 
1
%META:TOPICINFO{author="ProjectContributor" date="1231502400" format="1.1" version="1"}%
 
2
%META:TOPICPARENT{name="Macros"}%
 
3
#VarUSERINFO
 
4
---+++ USERINFO{"name"} -- retrieve details about a user
 
5
   * Syntax: =%<nop>USERINFO%=
 
6
   * Expands to: <code>%USERINFO%</code> (comma-separated list of the username, wikiusername, and emails)
 
7
   * With formatted output, using tokens =$emails=, =$username=, =$wikiname=, =$wikiusername=, =$groups= and =$admin= ($admin returns 'true' or 'false'):
 
8
      * Example: =%<nop>USERINFO{ format="$username is really $wikiname" }%=
 
9
      * Expands to: =%USERINFO{ format="$username is really !$wikiname" }%=
 
10
   * Retrieve information about another user:
 
11
      * Example: =%<nop>USERINFO{ "WikiGuest" format="$username is really $wikiname" }%=
 
12
      * Expands to: <code>%USERINFO{ "WikiGuest" format="$username is really !$wikiname" }%</code>
 
13
      * %H% The parameter should be the wikiname of a user. You can also pass a login name. You can only get information about another user if the ={AntiSpam}{HideUserDetails}= configuration option is not enabled, or if you are an admin. %IF{"{AntiSpam}{HideUserDetails}" then=" _(User details are hidden in this site)_ "}%
 
14
   * Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarUSERNAME][USERNAME]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarWIKINAME][WIKINAME]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarWIKIUSERNAME][WIKIUSERNAME]], UserAuthentication, ChangeEmailAddress