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.
Action "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 report also sets a "UserReports_users" variable to the number of users found. To retrieve, write %GET{UserReports_users}%.
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.
Action "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.
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.
Action "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:
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.
Action "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-11-13" }%
Test comment using BUBBLESIG
-- %BUBBLESIG{TWikiGuest - 2024-11-13}%
Show slim, one line height user boxes. Several actions are provided:
Action "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" action if needed.
Action "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;.
Action "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;.
Action "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" action.
Parameter style: Optional, same as action "slim_box".
Action "slim_box_end": Defines the end of a set of slim boxes.
Show small, two line height user boxes. Several actions are provided:
Action "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" action if needed.
Action "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;.
Action "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;.
Action "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" action.
Parameter style: Optional, same as action "small_box".
Action "small_box_end": Defines the end of a set of small boxes.
Show users in business card format. Several actions are provided:
Action "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" action if needed.
Action "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;.
Action "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;.
Action "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" action.
Parameter style: Optional, same as action "business_card".
Action "business_card_end": Defines the end of a set of business cards.
Show a selector to pick a user, for use in HTML forms.
Action "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" action. 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
Show rows of checkboxes to select users, for use in HTML forms.
Action "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" action. 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;
This topic has user report sections intended for TWiki application developers.
This topic uses more user friendly ParameterizedVariables%USERREPORT{ action="foo" ... }% instead of the more verbose parameterized include %INCLUDE{ "%SYSTEMWEB%.UserReports" section="foo" ... }%.
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.
