Home | Gifts

TWiki User Reports

Page contents
This page contains user reports you can use in TWiki application. Create appealing TWiki applications in a no time!

Reports are of format %USERREPORT{ action="..." ... }%, where the action determines the kind of report. Each report supports additional parameters.

Action: user_list

Show a simple list of registered users. The output is a comma-space delimited sorted list of WikiWords of users (without web prefix), which can be used as input for other reports on this page.

This report also sets a "UserReports_users" variable to the number of users found. To retrieve, write %GET{UserReports_users}%.

ArpHbLbGISF, AwVCoNbqYHXRZ, BcDmuDdLzf, KDJAtUGAIAG, NywTKQxiWU, TDmOIglzpVJbvn, TaitCyrus, TgbQDkwpG, TzBngKIKVatgy, UjDMuFvOxTLM

Usage example:

%USERREPORT{ action="user_list" search="jane" limit="5" }%

Sample output:
ArpHbLbGISF, AwVCoNbqYHXRZ, BcDmuDdLzf, KDJAtUGAIAG, NywTKQxiWU

Action: profile_picture

Show the profile picture image of a user. A default image is returned in case the image is not defined in the Image form field of the user. The output is an <img /> tag that can be embedded in other tags such as links.

Usage example:

%USERREPORT{ action="profile_picture" user="TWikiGuest" height="40" title="TWikiGuest" }%
%USERREPORT{ action="profile_picture" user="AmandaBoris" height="40" title="AmandaBoris" }%

Sample output:
TWikiGuest   ArpHbLbGISF   AwVCoNbqYHXRZ   BcDmuDdLzf   KDJAtUGAIAG   NywTKQxiWU

%user%

Action: user_sig

Show a user signature with profile picture, optionally followed by a date or other text. A default image is shown in case the image is not defined in the Image form field of the user.

In addition, a USERSIG preferences setting is defined as a shortcut, so that a simple %USERSIG{TWikiGuest}% can be used.

Usage example:

-- %USERREPORT{ action="user_sig" user="TWikiGuest - 2024-12-09" }%

-- %USERSIG{TWikiGuest}%

-- %USERSIG{TWikiGuest - 2024-12-09}%

Sample output:
-- TWiki Guest - 2024-12-09

-- TWiki Guest

-- TWiki Guest - 2024-12-09

%user%

Action: bubble_sig

Show a faded comment bubble and user signature with profile picture, optionally followed by a date or other text. A default image is shown in case the image is not defined in the Image form field of the user. This is used for CommentPlugin signatures.

In addition, a BUBBLESIG preferences setting is defined as a shortcut, so that a simple %BUBBLESIG{TWikiGuest}% can be used.

Usage example:

Test comment using USERREPORT

-- %USERREPORT{ action="bubble_sig" user="TWikiGuest - 2024-12-09" }%

Test comment using BUBBLESIG

-- %BUBBLESIG{TWikiGuest - 2024-12-09}%

Sample output:
Test comment using USERREPORT

-- TWiki Guest - 2024-12-09

Test comment using BUBBLESIG

-- TWiki Guest - 2024-12-09

%user%

Action: slim_box

Slim box example
Show slim, one line height user boxes. Several actions are provided:

Usage example:

%USERREPORT{ action="slim_box_start" }%
  %USERREPORT{ action="slim_box" user="TWikiGuest" }%
  %USERREPORT{ action="slim_box" user="JaneSmith" }%
%USERREPORT{ action="slim_box_end" }%
%USERREPORT{ action="slim_box_start" style="background-color: #f0f0e8;" }%
  %USERREPORT{ action="slim_box_list" users="UserOne, UserTwo, UserThree" }%
%USERREPORT{ action="slim_box_end" }%

Sample output:

TWikiGuest TWiki Guest
ArpHbLbGISF Arp Hb Lb GISF
AwVCoNbqYHXRZ Aw VCo Nbq YHXRZ
BcDmuDdLzf Bc Dmu Dd Lzf
KDJAtUGAIAG KDJAt UGAIAG
NywTKQxiWU Nyw TKQxi WU

%users% %users%
%user% %user%

Action: small_box

Small box example
Show small, two line height user boxes. Several actions are provided:

Usage example:

%USERREPORT{ action="small_box_start" }%
  %USERREPORT{ action="small_box" user="TWikiGuest" }%
  %USERREPORT{ action="small_box" user="JaneSmith" }%
%USERREPORT{ action="small_box_end" }%
%USERREPORT{ action="small_box_start" style="background-color: #f0f0e8;" }%
  %USERREPORT{ action="small_box_list" users="UserOne, UserTwo, UserThree" }%
%USERREPORT{ action="small_box_end" }%

Sample output:

TWikiGuest TWiki Guest
ArpHbLbGISF Arp Hb Lb GISF
AwVCoNbqYHXRZ Aw VCo Nbq YHXRZ
BcDmuDdLzf Bc Dmu Dd Lzf
KDJAtUGAIAG KDJAt UGAIAG
NywTKQxiWU Nyw TKQxi WU

%users% %users%
%user% %user%

Action: business_card

Business card example
Show users in business card format. Several actions are provided:

Usage examples:

%USERREPORT{ action="business_card_start" }%
  %USERREPORT{ action="business_card" user="TWikiGuest" }%
  %USERREPORT{ action="business_card" user="JaneSmith" }%
%USERREPORT{ action="business_card_end" }%
%USERREPORT{ action="business_card_start" style="background-color: #f0f0e8;" }%
  %USERREPORT{ action="business_card_list" users="UserOne, UserTwo, UserThree" }%
%USERREPORT{ action="business_card_end" }%

Sample output:

jbvPZtRoOPB TnZUfvBvkYAvT


MGXXuqyr, , Other Country
Mail

jwDYExrtKJeZk MmQgEQBVUGVqhC


WteSxyamYKihpV, , Other Country
Mail

aanmJMJnobO IRvDEDmhbWwKLiw


XdcjpvMvhGJIGd, , Other Country
Mail

GSVDwkNBsFTOOI hUOBDdLvGS


anwUTTligiS, , Other Country
Mail

obRIFLbDtGBp sjwQKTjEZkrcsMi


sKxkmhJHExNkno, , Other Country
Mail



, ,
Mail



, ,
Mail

Action: select_one_user

Show a selector to pick a user, for use in HTML forms.

Usage example:

<form>
%USERREPORT{ action="select_one_user" name="Owner" selected="TWikiGuest" }%
</form>

Sample output:

Action: select_users

Select users example
Show rows of checkboxes to select users, for use in HTML forms.

Usage example:

<form>
%USERREPORT{ action="select_users" name="Members" selected="TWikiGuest, AmandaBoris" }%
</form>

Sample output:





















Note to Maintainer:

Related topics: TWikiGroups, TWikiUsers, UserList, UserListByDateJoined, UserListByLocation, VarUSERREPORT, TWikiUserMappingContrib

-- TWiki:Main.PeterThoeny - 2014-10-04

Revision r3 - 2015-05-29 - 23:43:57 - TWikiContributor Edit