Standardization work on built in user list module plus docs & code cleanup

* More docs, fix some info
* Code cleanup
This commit is contained in:
Bryan Ashby 2018-07-22 12:56:56 -06:00
parent 2e275600b1
commit e6a812cf34
9 changed files with 102 additions and 80 deletions

View file

@ -27,10 +27,11 @@ Remember that entries such as `actionIndicators` and `actionIndicatorDefault` ma
### Theming
The following `itemFormat` object is provided to MCI 1 (ie: `%VM1`):
* `userId`: User ID.
* `realName`: User's real name or "N/A".
* `userName`: Login username.
* `realName`: User's real name.
* `ts`: Timestamp in `dateTimeFormat` format.
* `location`: User's location or "N/A".
* `affiliation` or `affils`: Users affiliations or "N/A".
* `location`: User's location.
* `affiliation` or `affils`: Users affiliations.
* `actions`: A string built by concatenating action indicators for a users logged in session. For example, given a indincator of `userDownload` mapped to "D", the string may be "-D----". The format was made popular on Amiga style boards.