TWiki User Reports

This page is for TWiki application developers. Include the sections on this page to show user reports with profile pictures. Create appealing TWiki applications in a short time.

Section: 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.

  • Section "user_list": Show a list of users as comma-space delimited list of WikiWords.
    • Parameter search: Apply filter by searching all form fields, but not the main topic text. Optional; all users are returned if missing.
    • Parameter limit: Limits the number of users returned. Optional; all users are returned if missing.
    • Parameter sort: Sort the result by the topic name, topic creation date, last modified date, last editor, or named field of TWikiForms. For details see sort parameter of SEARCH.
    • Parameter reverse: Reverse the direction of the search result

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

Usage example:

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

Sample output:

AdelaIde572, AdeliNe873, AileEn772, AlbertEsterline, AlbertStrong

AdelaIde572, AdeliNe873, AileEn772, AlbertEsterline, AlbertStrong, AlbertoRozenfarb, AletHa154, AletHa51, AlexDominguez, AlexW, AlexanderSchiendorfer, AlisherWright, AllenAguiar, AlmeDa238, AlvaroGuevara, AlysHa824, AmbeR634, AmitSingh, AnA95, AndrIa759, AndrewSims, AngeLa279, AngelIna114, AnitaRaja, AnnamAe988, AntoneTte939, AntonioPastorLopez, ArifYunar, ArliNe398, ArmanDidandeh, ArnoLd339, AshokSubramanian, AstrId462, AureA138, BarberOtto, BarrIe546, BartJButer, BennEtt49, BerRy9, BernardM, BertIe134, BertIe344, BettIe11, BeulAh14, BeverLy624, BlaiNe624, BlaiseDenham, BlanCh253, BrahimChaibdraa, BrentOn685, BrianLunday, BritTni41, BruceBarkstrom, CaitlYn319, CamilLa111, CandaNce66, CarL96, CarY635, CarleTta122, CarmineGarzillo, ChanG297, ChinA578, ChrisNell, ChristEna335, ChristEna736, ChristIana621, ChristofSchoetz, ClariNe917, ClaudIe154, ClaudIe691, ClaudiaJChaney, ClintOn875, ColtOn761, CorrIna46, CristAl947, CurtisChow, DannyD, DariO261, DeOn5, DeliSa22, DelphIne212, DeneEn694, DenialBarbosa, DennialBarbosia, DeoN494, DimitrisTsipras, DionNa348, DirkNeumann, DohoonKim, DomTheo, DominIc388, DonA67, DustY876, EberSchmitz, ElfriEde244, ElkE573, ElmiRa45, ElysE129, EnricoFranchi, EricKa515

Section: 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.

  • Section "profile_picture": Show the profile picture image of a user.
    • Parameter user: WikiWord of user, required.
    • Parameter width: Width of image, optional.
    • Parameter height: Height of image, optional. The aspect ratio is preserved unless width and height are specified. If width and height are missing, a height of 100 pixels is used.
    • Parameter title: Title parameter of img tag, optional.

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   AdelaIde572   AdeliNe873   AileEn772   AlbertEsterline   AlbertStrong

%user%

Section: 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.

  • Section "user_sig": Show a user signature with profile picture.
    • Parameter user: WikiWord of user, required. Optionally followed by a date or other text.
    • Parameter width: Width of image, optional.
    • Parameter height: Height of image, optional. The aspect ratio is preserved unless width and height are specified. If width and height are missing, a height of 18 pixels is used.

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 - 2022-08-17" }%

-- %USERSIG{TWikiGuest}%

-- %USERSIG{TWikiGuest - 2022-08-17}%

Sample output:
-- TWiki Guest - 2022-08-17

-- TWiki Guest

-- TWiki Guest - 2022-08-17

Section: 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.

  • Section "bubble_sig": Show a user signature with profile picture.
    • Parameter user: WikiWord of user, required. Optionally followed by a date or other text.

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 - 2022-08-17" }%

Test comment using BUBBLESIG

-- %BUBBLESIG{TWikiGuest - 2022-08-17}%

Sample output:
Test comment using USERREPORT

-- TWiki Guest - 2022-08-17

Test comment using BUBBLESIG

-- TWiki Guest - 2022-08-17

Section: slim_box

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

  • Section "slim_box_css": Defines the style sheets of the slim boxes. Optionally include it once per page; it is done for you by the "slim_box_start" section if needed.
  • Section "slim_box_start": Defines the start of a set of slim boxes.
    • Parameter style: Optional, overrides the css of the container div of slim boxes. Default: padding:0 5px 0 5px; background-color:#f0f0f4;.
  • Section "slim_box": Show a single slim box.
    • Parameter user: Specify the WikiWord of a single user.
    • Parameter style: Optional, overrides the css of the slim box. Default: float: left; width: 130px; border: solid 1px #d0d0d8; background-color: #f8f8fb;.
  • Section "slim_box_list": Show a set of slim boxes.
    • Parameter users: Specify a list of WikiWords of users. The list may be provided by including the "user_list" section.
    • Parameter style: Optional, same as section "slim_box".
  • Section "slim_box_end": Defines the end of a set of slim boxes.

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:

Section: small_box

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

  • Section "small_box_css": Defines the style sheets of the small boxes. Optionally include it once per page; it is done for you by the "small_box_start" section if needed.
  • Section "small_box_start": Defines the start of a set of small boxes.
    • Parameter style: Optional, overrides the css of the container div of small boxes. Default: padding:0 5px 0 5px; background-color:#f0f0f4;.
  • Section "small_box": Show a single small box.
    • Parameter user: Specify the WikiWord of a single user.
    • Parameter style: Optional, overrides the css of the small box. Default: float: left; width: 130px; border: solid 1px #d0d0d8; background-color: #f8f8fb;.
  • Section "small_box_list": Show a set of small boxes.
    • Parameter users: Specify a list of WikiWords of users. The list may be provided by including the "user_list" section.
    • Parameter style: Optional, same as section "small_box".
  • Section "small_box_end": Defines the end of a set of small boxes.

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:

Section: business_card

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

  • Section "business_card_css": Defines the style sheets of the business cards. Optionally include it once per page; it is done for you by the "business_card_start" section if needed.
  • Section "business_card_start": Defines the start of a set of business cards.
    • Parameter style: Optional, overrides the css of the container div of business cards. Default: padding:10px 15px 1px 15px; background-color:#f0f0f4;.
  • Section "business_card": Show a single business card.
    • Parameter user: Specify the WikiWord of a single user.
    • Parameter style: Optional, overrides the css of the business card. Default: float: left; width: 410px; border: solid 1px #d0d0d8; background-color: #fff;.
  • Section "business_card_list": Show a set of business cards.
    • Parameter users: Specify a list of WikiWords of users. The list may be provided by including the "user_list" section.
    • Parameter style: Optional, same as section "business_card".
  • Section "business_card_end": Defines the end of a set of business cards.

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:

Ashlyn Frink


, , Australia
Mail

Odell Raper


, , Australia
Mail

Millie Pedroza


, , Australia
Mail

Albert Esterline


, , USA
Mail

Albert Strong


, , USA
Mail

Alberto Rozenfarb


, , Argentina
Mail

Kelvin Salomon


, , Australia
Mail

Hobert Claiborne


, , Australia
Mail

Alex Dominguez


, , USA
Mail

Alexander Wolpert


Roosevelt University, , USA
Mail

Alexander Schiendorfer


University of Augsburg, , Germany
Mail

Alisher Wright


, , USA
Mail

Jazmine Kammann


Jacob, , Colombia
Mail

Steve Sthilaire


, , Australia
Mail

Alvaro Guevara


Universidad de Costa Rica, , Costa Rica
Mail

Sharri Nix


, , Australia
Mail

Jettie Columbus


, , Australia
Mail

Amit Singh


IIT Bombay, , India
Mail

Hettie Walser


, , Australia
Mail

Marna Segovia


, , Australia
Mail

Andrew Sims


, , USA
Mail

Sol Biller


, , Australia
Mail

Lea Emery


, , Australia
Mail

Anita Raja


, , USA
Mail

Joelle Ingle


, , Australia
Mail

Cody Partain


, , Australia
Mail

Antonio Pastor-Lopez


Universidad de Alicante, , Spain
Mail

arif yunar


wiki, , Indonesia
Mail

Jeanna Bolin


, , Australia
Mail

Arman Didandeh


, , Iran
Mail

Dusty Zukowski


, , Australia
Mail

Ashok Subramanian


, , India
Mail

Enriqueta Aikeworth


, , Australia
Mail

Joey Dews


, , Australia
Mail

Barber Otto


, , Iceland
Mail

Briana Wiegand


, , Australia
Mail

Bart Buter


, , Netherlands
Mail

Fern McClurg


, , Australia
Mail

Billy Dennison


, , Australia
Mail

Bernard Manderick


, , Belgium
Mail

Shari Locke


, , Australia
Mail

Otis Gilbertson


, , Australia
Mail

Lasonya Leon


, , Australia
Mail

Colton Southard


, , Australia
Mail

Leonora Brooke


, , Australia
Mail

Janette Derrick


, , Australia
Mail

Blaise Denham


, , Australia
Mail

Glennis Conklin


, , Australia
Mail

Brahim Chaibdraa


, , Canada
Mail

Marjory Kang


, , Australia
Mail

Brian Lunday


, , USA
Mail

Gia Holte


, , Australia
Mail

Bruce Barkstrom


, , USA
Mail

Adrianne Frink


, , Australia
Mail

Selina Snook


, , Australia
Mail

Angela Risinger


, , Australia
Mail

Hermelinda Countryman


, , Australia
Mail

Ocie Carlsen


, , Australia
Mail

Bobby Correll


, , Australia
Mail

carmine garzillo


, , Italy
Mail

Ruby O'Day


, , Australia
Mail

Jay Champlin


, , Australia
Mail

Chris Nell


, , Canada
Mail

Myron Jalbert


, , Australia
Mail

Ana Denham


, , Australia
Mail

Loraine Strader


, , Australia
Mail

Christof Schötz


, , Germany
Mail

Hortencia Wicklund


, , Australia
Mail

Sherwood Colombo


, , Australia
Mail

Stefan Hudgens


, , Australia
Mail

Claudia J Chaney


, , USA
Mail

Kennith Bise


, , Australia
Mail

Efren Veliz


, , Australia
Mail

Nettie Granado


, , Australia
Mail

Ima Kinney


, , Australia
Mail

Curtis Chow


, , USA
Mail

Daniel Dunlavy


, , USA
Mail

Carma Kinney


, , Australia
Mail

Jackson Richburg


, , Australia
Mail

Lilia Viramontes


, , Australia
Mail

Merlin Hanner


, , Australia
Mail

Exie Baggett


, , Australia
Mail

Denial Barbosa


, , India
Mail

Dennial Barbosia


, , India
Mail

Earlean Barta


, , Australia
Mail

Dimitris Tsipras


National Technical University of Athens (NTUA), , Greece
Mail

Mikki Lipscomb


, , Australia
Mail

Dirk Neumann


, , Germany
Mail

Dohoon Kim


Kyung Hee University, , Korea
Mail

dom theo


, , USA
Mail

Eugene Martin


, , Australia
Mail

Danette Hofer


, , Australia
Mail

Brendan Machuca


, , Australia
Mail

Eber Schmitz


Federal University of Rio de Janeiro, , Brazil
Mail

Stephane Pugh


, , Australia
Mail

Jade Krouse


, , Australia
Mail

Tamala Sansone


, , Australia
Mail

Herschel Eshelman


, , Australia
Mail

Enrico Franchi


, , Italy
Mail

Deana Unknow


, , Australia
Mail



, ,
Mail



, ,
Mail

Section: select_one_user

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

  • Section "select_one_user": Selector to pick a user.
    • Parameter name: Name of form field, required.
    • Parameter selected: WikiWord name of a user, optional.
    • Parameter users: Specify a list of WikiWords of users, optional. The list may be provided by including the "user_list" section. All registered users are shown if the parameter is missing.
    • Parameter firstoption: Label of first option, optional. Default: Select...
    • Parameter firstvalue: Value of first option, optional. Default: empty value

Usage example:

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

Sample output:

Section: select_users

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

  • Section "select_users": Set of checkboxes to select users.
    • Parameter name: Name of form field, required.
    • Parameter selected: List of WikiWord names indicating the selected users, optional.
    • Parameter users: Specify a list of WikiWords of users, optional. The list may be provided by including the "user_list" section. All registered users are shown if the parameter is missing.
    • Parameter colums: Define number of columns, optional. Default: 5
    • Parameter style: Set the css of the container div, optional. Default: margin: 0; border: 1px solid transparent;

Usage example:

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

Sample output:









































































































































































































Note to Maintainer:

  • This topic has user report sections intended for TWiki application developers.
  • This topic uses more user friendly ParameterizedVariables %USERREPORT{ action="..." ... }% instead of the more verbose parameterized include %INCLUDE{ "%SYSTEMWEB%.UserReports" section="..." ... }%.
  • If you add a section to this topic, or add a parameter to a section, make sure to keep the parameterized variables settings in TWikiPreferences#ParameterizedVariables in sync.

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

-- TWiki:Main.PeterThoeny - 2013-02-06

Edit | Attach | Watch | Print version | History: r2 < r1 | Backlinks | Raw View | Raw edit | More topic actions...
Topic revision: r1 - 2013-10-12 - TWikiContributor
 
  • Edit
  • Attach
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 1999-2022 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.UserReports.