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:

AbdulAlim, AbigailVieregg, AlbertWandui, AlessandroSanchez, AlessandroSchillaci

AbdulAlim, AbigailVieregg, AlbertWandui, AlessandroSanchez, AlessandroSchillaci, AlexisWeber, AliciaLanz, AnthonyTurner, AntonioFortes, AriCukierman, ArkadasBul, AstridTomada, AtlasTechnologies, AtlasUser, AydaSahimi, B3LabMountGuest, BahmanMaleki, BarthNetterfield, BeauBastyan, BenjaminLehmann, BettyHu, BobWilson, BrettBuchea, BryanSteinbach, CaraConsidine, CarolineSorensen, ChaoLinKuo, ChaseParker, ChrisSheehy, ChristianSmith, ClaraMartini, ClemPryke, ColinBischoff, CyndiaYu, DaichiTsuna, DannyPark, DavidGoldfinger, DenisBarkats, DulBayanlar, EdwardYoung, EleanoreAufderhar, EmreSeo, EricB, EricYang, EsiEsii, EthanFryerRessmeyer, EthanKarpel, GeneralDynamics, GeoryBam, GrantlandHall, HansBoenish, HawinwebHa, HienNguyen, HowardHui, ImanGoldoost, ImmanuelBuder, JackDonati, JackWalker, JaeHwanKang, JakeConnors, JamesCornelison, JamieTolan, JasonSun, JedBothell, JeffFilippini, JimmyGrayson, JoannaAdams, JohnCoyle, JohnKovac, JordiMontanaLopez, JosefFrisch, JustinWillmert, KeithThompson, KentIrwin, KevinWang, KiWonYoon, KimCollins, KimmyWu, KiritKarkare, KizlikZariDikimi, KrikorMegerian, LaraHoolan, LorenzoMoncelsi, MaddieHickman, MahdiMeydan, MandanaAmiri, MarcRunyan, MariaS, MarkHalpern, MasoodDaneshi, MatthewWithers, MaxSilva, MdAbdusSamad, MikeCrumrine, MrjavadJavad, NeilGoecknerWald, NgocLa, NorixeNorixe, PamneaPisalak, PaulDraghis

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   AbdulAlim   AbigailVieregg   AlbertWandui   AlessandroSanchez   AlessandroSchillaci

%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 - 2024-03-28" }%

-- %USERSIG{TWikiGuest}%

-- %USERSIG{TWikiGuest - 2024-03-28}%

Sample output:
-- TWiki Guest - 2024-03-28

-- TWiki Guest

-- TWiki Guest - 2024-03-28

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 - 2024-03-28" }%

Test comment using BUBBLESIG

-- %BUBBLESIG{TWikiGuest - 2024-03-28}%

Sample output:
Test comment using USERREPORT

-- TWiki Guest - 2024-03-28

Test comment using BUBBLESIG

-- TWiki Guest - 2024-03-28

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:

Abdul Alim


, , USA
Mail

Abigail Vieregg


, ,
Mail

Albert Wandui


, , USA
Mail

Alessandro Sanchez


, , USA
Mail

Alessandro Schillaci


California Institute of Technology, , USA
Mail

Alexis Weber


, , USA
Mail

Alicia Lanz


, , USA
Mail

Anthony Turner


JPL, , USA
Mail

antonio fortes


, , USA
Mail

Ari Cukierman


Stanford University, , USA
Mail

arkadas bul


cikolata, , Turkey
Mail

Astrid Tomada


SLAC, , USA
Mail

Atlas Bothell


AtlasTechnologies, , USA
Mail

Richard Bothell


Atlas Technologies, , USA
Mail

Ayda Sahimi


Siue, , USA
Mail

B3LabMount Guest


, , USA
Mail

bahman maleki


coper, , Iran
Mail

Barth Netterfield


, ,
Mail

Beau Bastyan


Homes Pure, , USA
Mail

Benjamin Lehmann


, , USA
Mail

Betty Hu


SLAC SULI, , USA
Mail

Bob Wilson


, ,
Mail

Brett Buchea


, , USA
Mail

Bryan Steinbach


Caltech, , USA
Mail

Cara Considine


, , USA
Mail

Caroline Sorensen


, , USA
Mail

Chao-Lin Kuo


, ,
Mail

Chase Parker


Stanford University, , USA
Mail

Chris Sheehy


, , USA
Mail

Christian Smith


, , USA
Mail

clara martini


, , Armenia
Mail

Clem Pryke


, ,
Mail

Colin Bischoff


, , USA
Mail

Cyndia Yu


Harvard, , USA
Mail

Daichi Tsuna


Stanford Univ, , USA
Mail

Danny Park


, , USA
Mail

David Goldfinger


Harvard University, , USA
Mail

Denis Barkats


Harvard, , USA
Mail

dul bayanlar


Kcandan, , Turkey
Mail

Edward Young


Stanford, , USA
Mail

Eleanore Aufderhar


, , USA
Mail

Emre Seo


seo, , USA
Mail

Eric Bullock


, , USA
Mail

Eric Yang


Stanford, , Taiwan
Mail

esi esii


, , United Arab Emirates
Mail

Ethan Fryer-Ressmeyer


University of Minnesota, , USA
Mail

Ethan Karpel


, , USA
Mail

General Dynamics


, ,
Mail

Grantland Hall


, , USA
Mail

Hans Boenish


USAP, , USA
Mail

hawinweb ha


, , USA
Mail

Hien Nguyen


, ,
Mail

Howard Hui


, , USA
Mail

iman goldoost


themeoff, , USA
Mail

Immanuel Buder


Harvard, , USA
Mail

Jack Donati


, , United Kingdom
Mail

Jack walker


, , United Kingdom
Mail

Jae Hwan Kang


Stanford, , USA
Mail

Jake Connors


Harvard, , USA
Mail

James Cornelison


, , USA
Mail

Jamie Tolan


, , USA
Mail

Jason Sun


Caltech, , USA
Mail

Jed Bothell


Atlas Technologies, , USA
Mail

Jeff Filippini


Caltech, , USA
Mail

Jimmy Grayson


, , USA
Mail

Joanna Adams


, , USA
Mail

John Coyle


, , USA
Mail

John Kovac


, ,
Mail

Jordi Montana-Lopez


, , USA
Mail

josef frisch


SLAC, , USA
Mail

Justin Willmert


University of Minnesota, , USA
Mail

Keith Thompson


, ,
Mail

Kent Irwin


, ,
Mail

Kevin Wang


, , USA
Mail

Ki Won Yoon


Stanford, , USA
Mail

Kim Collins


, , Philippines
Mail

Kimmy Wu


, ,
Mail

Kirit Karkare


, , USA
Mail

Kızlık Zarı Dikimi


Kızlık Zarı Dikimi, , Turkey
Mail

krikor megerian


JPL, , USA
Mail

Lara Hoolan


, , USA
Mail

Lorenzo Moncelsi


California Institute of Technology, , USA
Mail

Madeline Hickman


, , USA
Mail

Mahdi meydan


, , Iran
Mail

Mandana Amiri


University of British Columbia , , Canada
Mail

Marc Runyan


, ,
Mail

Maria Salatino


Stanford & KIPAC, , USA
Mail

Mark Halpern


UBC Dept of Physics and Astronomy, , Canada
Mail

Masood Daneshi


Shenoland Music, , Iran
Mail

Matthew Withers


Stanford University, , USA
Mail

Max Silva


Stanford, , USA
Mail

Md Abdus Samad


, , USA
Mail

Mike Crumrine


UMN, , USA
Mail

mrjavad javad


, , Hong Kong
Mail

Neil GoecknerWald


Stanford, , USA
Mail

Ngoc La


, , USA
Mail

norixe norixe


, , USA
Mail

pamnea pisalak


ultimatemedical, , USA
Mail

Paul Draghis


, , USA
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, 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-11 - TWikiContributor
 
  • Edit
  • Attach
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 1999-2024 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.