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:

AaronWilson, AbigailMoore, AdamAmbrogi, AdamCarbullido, AlanSimmons

AaronWilson, AbigailMoore, AdamAmbrogi, AdamCarbullido, AlanSimmons, AleksandarLazarevic, AlishaAlexander, AmberMcReynolds, AmyCohen, AndreaEastman, AndrewBergeron, AndrewJohnson, AndrewRegenscheid, AndyPit, AngieRogers, AnnaMassoglia, ArtGriesser, ArthurKeller, BarbaraNetchert, BarbaraSimons, BeckySantos, BenLong, BenRice, BenjaminLong, BernieHirsch, BethAnnSurber, BethThompson, BillMalone, BlairBrenot, BonnieWoodfall, BrandiSeskes, BrandieSullivan, BrandonMartin, BrandonMulvey, BrentTurner, BrianCripe, BrianFox, BrianHancock, BrianMortimore, BrittanyWestfall, CJMoit, CaitrionaFitzgerald, CameronQuinn, CandiceHoke, CarolynEvans, CarrieBell, CarstenShuermann, CaseyBallentine, CaseyHayes, CharlesCorry, CherylJansen, ChrisBackert, ChrisBruscino, ChrisHughes, ChrisJerdonek, ChristinaAdkins, ChristopherThomas, ChuckVenvertloh, CindyReichert, ClaudiaAcemyan, ClydeTucker, CoryPatrick, CraigBurton, CraigReines, DaemmonHughes, DaleHartman, DaleLivingston, DanGillette, DandaParker, DanielBrandes, DanielZimmerman, DanyFarina, DaveFinlay, DaveKadlecek, DaveLoomis, DaviBosch, DavidBaquis, DavidBeirne, DavidCary, DavidECunningham, DavidJefferson, DavidLevine, DavidLiebenberg, DavidMcGivney, DavidNatelson, DavidStafford, DavidStonehill, DavidTackett, DavidTarrant, DavidWagner, DavidWallick, DavidWebber, DeanBaumert, DebbieBedford, DeborahDelgado, DeepalMadalani, DerekWillis, DianeGolden, DonRehill, DrewTinney

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   AaronWilson   AbigailMoore   AdamAmbrogi   AdamCarbullido   AlanSimmons

%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 - 2019-10-21" }%

-- %USERSIG{TWikiGuest}%

-- %USERSIG{TWikiGuest - 2019-10-21}%

Sample output:
-- TWiki Guest - 2019-10-21

-- TWiki Guest

-- TWiki Guest - 2019-10-21

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 - 2019-10-21" }%

Test comment using BUBBLESIG

-- %BUBBLESIG{TWikiGuest - 2019-10-21}%

Sample output:
Test comment using USERREPORT

-- TWiki Guest - 2019-10-21

Test comment using BUBBLESIG

-- TWiki Guest - 2019-10-21

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:

Aaron Wilson


, ,
Mail

Abigail Moore


, ,
Mail

Adam Ambrogi


, ,
Mail

Adam Carbullido


, ,
Mail

Alan Simmons


, ,
Mail

Aleksandar Lazarevic


, ,
Mail

Alisha Alexander


, ,
Mail

Amber McReynolds


, ,
Mail

Amy Cohen


, ,
Mail

Andrea Eastman


, ,
Mail

Andrew Bergeron


, ,
Mail

Andrew Johnson


, ,
Mail

Andrew Regenscheid


, ,
Mail

Andy Pit


, ,
Mail

Angie Rogers


, ,
Mail

Anna Massoglia


, ,
Mail

Art Griesser


, ,
Mail

Arthur Keller


, ,
Mail

Barbara Netchert


, ,
Mail

Barbara Simons


, ,
Mail

Becky Santos


, ,
Mail

Ben Long


, ,
Mail

Ben Rice


, ,
Mail

Benjamin Long


, ,
Mail

Bernie Hirsch


, ,
Mail

BethAnn Surber


, ,
Mail

Beth Thompson


, ,
Mail

Bill Malone


, ,
Mail

Blair Brenot


, ,
Mail

Bonnie Woodfall


, ,
Mail

Brandi Seskes


, ,
Mail

Brandie Sullivan


, ,
Mail

Brandon Martin


, ,
Mail

Brandon Mulvey


, ,
Mail

Brent Turner


, ,
Mail

Brian Cripe


, ,
Mail

Brian Fox


, ,
Mail

Brian Hancock


, ,
Mail

Brian Mortimore


, ,
Mail

Brittany Westfall


, ,
Mail

CJ Moit


, ,
Mail

Caitriona Fitzgerald


, ,
Mail

Cameron Quinn


, ,
Mail

Candice Hoke


, ,
Mail

Carolyn Evans


, ,
Mail

Carrie Bell


, ,
Mail

Carsten Shuermann


, ,
Mail

Casey Ballentine


, ,
Mail

Casey Hayes


, ,
Mail

Charles Corry


, ,
Mail

Cheryl Jansen


, ,
Mail

Chris Backert


, ,
Mail

Chris Bruscino


, ,
Mail

Chris Hughes


, ,
Mail

Chris Jerdonek


, ,
Mail

Christina Adkins


, ,
Mail

Christopher Thomas


, ,
Mail

Chuck Venvertloh


, ,
Mail

Cindy Reichert


, ,
Mail

Claudia Acemyan


, ,
Mail

Clyde Tucker


, ,
Mail

Cory Patrick


, ,
Mail

Craig Burton


, ,
Mail

Craig Reines


, ,
Mail

Daemmon Hughes


, ,
Mail

Dale Hartman


, ,
Mail

Dale Livingston


, ,
Mail

Dan Gillette


, ,
Mail

Danda Parker


, ,
Mail

Daniel Brandes


, ,
Mail

Daniel Zimmerman


, ,
Mail

Dany Farina


, ,
Mail

Dave Finlay


, ,
Mail

Dave Kadlecek


, ,
Mail

Dave Loomis


, ,
Mail

Davi Bosch


, ,
Mail

David Baquis


, ,
Mail

David Beirne


, ,
Mail

David Cary


, ,
Mail

David ECunningham


, ,
Mail

David Jefferson


, ,
Mail

David Levine


, ,
Mail

David Liebenberg


, ,
Mail

David McGivney


, ,
Mail

David Natelson


, ,
Mail

David Stafford


, ,
Mail

David Stonehill


, ,
Mail

David Tackett


, ,
Mail

David Tarrant


, ,
Mail

David Wagner


, ,
Mail

David Wallick


, ,
Mail

David Webber


, ,
Mail

Dean Baumert


, ,
Mail

Debbie Bedford


, ,
Mail

Deborah Delgado


, ,
Mail

Deepal Madalani


, ,
Mail

Derek Willis


, ,
Mail

Diane Golden


, ,
Mail

Don Rehill


, ,
Mail

Drew Tinney


, ,
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-12 - TWikiContributor
 
  • Edit
  • Attach
This site is powered by the TWiki collaboration platform Powered by PerlCopyright & 1999-2019 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.