1. Usage
The UserDashboard template allows any logged-in user who has writing permissions, to build customized dashboards to follow up the state of the pages on which this user has a role (e.g. main writer, expert...) to play.
A dashboard is obtained thanks to a Semantic MediaWiki query[ud 1], and is displayed as a searchable and exportable table thanks to the table
format and the datatable
class[ud 2]. The features of this class are:
- nice visual appearance
- search input box for searching within the table
- easy export of the table's content into CSV, JSON, RSS and RDF
Usage: {{UserDashboard | user=<username> | role=<role> | filter=<filter>}}
Where:
- <username> is the optional username of the logged-in user who has writing permissions for whom the customized dashboard is built (if any doubt, cross-check, in your preferences, your wiki username). Per default (if <username> is not set), the user who is currently logged-in, is considered.
- <role> is the optional role (e.g. main writer, expert...) for which the customized dashboard is built. The default value is MW. The possible values for <role> are:
- MW: main writer
- EX: expert
- TW: technical writer
- MT: maintainer
- <filter> is the optional filter to reduce the number of listed pages. The default value is assignment. The possible value for <filter> is:
- assignment: the dashboard lists all the pages that match with the user and role criteria
- action: the dashboard lists only the pages that match with the user and role criteria, and for which an action from this user is required (e.g. follow-up, review...)
Summary:
<role> | <filter> | The dashboard lists the pages |
---|---|---|
not set | whatever the filter | An error is displayed |
MW (or not set) |
assignment (or not set) |
to which the user is assigned as main writer |
action | to which the user is assigned as main writer, and that are not approved: therefore, a follow-up from the user is required (e.g. updating, starting a review...) | |
EX | assignment (or not set) |
to which the user is assigned as expert |
action | to which the user is set as reviewer, and that are "under review by experts": therefore, a review from the user is required | |
TW | assignment (or not set) |
to which the user is assigned as technical writer |
action | to which the user is set as reviewer, and that are "under review by technical writers": therefore, a review from the user is required | |
MT | assignment (or not set) |
to which the user is assigned as maintainer |
action | to which the user is set as reviewer, and that are "under maintainer approval for publication": therefore, a review from the user is required |
References:
2. Basic examples
You type | All pages to which the "currently logged-in user" is assigned as main writer
|
---|---|
You get | The pages to which you are assigned as main writer |
You type | All pages to which "Arnaud Pouliquen" is assigned as main writer
|
You get | Arnaud Pouliquen is assigned as MW of |
You type | All "not approved" pages to which the "currently logged-in user" is assigned as main writer
|
You get | All "not approved" pages to which you are assigned as main writer |
You type | All "not approved" pages to which "Arnaud Pouliquen" is assigned as main writer
|
You get | As MW, Arnaud Pouliquen has no specific action presently. |
You type | All pages to which the "currently logged-in user" is assigned as expert
|
You get | The pages to which you are assigned as expert |
You type | All pages to which "Arnaud Pouliquen" is assigned as expert
|
You get | Arnaud Pouliquen is assigned as EX of |
You type | All "under review by experts" pages to which the "currently logged-in user" is set as reviewer
|
You get | All "under review by experts" pages to which you are set as reviewer |
You type | All "under review by experts" pages to which "Arnaud Pouliquen" is set as reviewer
|
You get | As EX, Arnaud Pouliquen has no page to review presently. |
You type | All pages to which the "currently logged-in user" is assigned as technical writer
|
You get | The pages to which you are assigned as technical writer |
You type | All pages to which "Arnaud Pouliquen" is assigned as technical writer
|
You get | Arnaud Pouliquen is not assigned as TW |
You type | All "under review by technical writers" pages to which the "currently logged-in user" is set as reviewer
|
You get | All "under review by technical writers" pages to which you are set as reviewer |
You type | All "under review by technical writers" pages to which "Arnaud Pouliquen" is set as reviewer
|
You get | As TW, Arnaud Pouliquen has no page to review presently. |
You type | All pages to which the "currently logged-in user" is assigned as maintainer
|
You get | The pages to which you are assigned as maintainer |
You type | All pages to which "Arnaud Pouliquen" is assigned as maintainer
|
You get | Arnaud Pouliquen is assigned as MT of |
You type | All "under maintainer approval for publication" pages to which the "currently logged-in user" is set as reviewer
|
You get | All "under maintainer approval for publication" pages to which you are set as reviewer |
You type | All "under maintainer approval for publication" pages to which "Arnaud Pouliquen" is set as reviewer
|
You get | As MT, Arnaud Pouliquen has no page to approve presently. |
3. More examples
You type | No role and no filter specified: same as if "MW" and "assignment were specified
|
---|---|
You get | Arnaud Pouliquen is assigned as MW of |
You type | No role specified: same as if "MW" was specified
|
You get | As MW, Arnaud Pouliquen has no specific action presently. |
You type | Unknown user
{{UserDashboard | user=Unknown user}}<br> {{UserDashboard | user=Unknown user | role=MW}}<br> {{UserDashboard | user=Unknown user | role=EX}}<br> {{UserDashboard | user=Unknown user | role=TW}}<br> {{UserDashboard | user=Unknown user | role=MT}}<br> {{UserDashboard | user=Unknown user | role=MW | filter=action}}<br> {{UserDashboard | user=Unknown user | role=EX | filter=action}}<br> {{UserDashboard | user=Unknown user | role=TW | filter=action}}<br> {{UserDashboard | user=Unknown user | role=MT | filter=action}} |
You get | Unknown user is not assigned as MW
CSV |
You type | Unknown role
|
You get | Unknown role Unknown role |
You type | Unknown filter: same as if "assignment" was specified
|
You get | Unknown filter ("assignment" is considered). Arnaud Pouliquen is assigned as MW of |
You type | Check that there's no space before and after the text
|
You get | BEFOREArnaud Pouliquen is assigned as MW of CSVAFTER |
4. Maintenance
This template is a template common to all ST wikis.
Modifications must be done into the WikiModel. They must be reviewed by all ST wikis maintainers.
When approved, the template can be pushed/merged towards all ST wikis.
5. Code
10.70.42.228 is not assigned as MW CSV