mirror of
https://github.com/NuSkooler/enigma-bbs.git
synced 2025-07-22 02:35:56 +02:00
Standardization work on built in user list module plus docs & code cleanup
* More docs, fix some info * Code cleanup
This commit is contained in:
parent
2e275600b1
commit
e6a812cf34
9 changed files with 102 additions and 80 deletions
|
@ -66,6 +66,7 @@
|
|||
- [Existing Mods]({{ site.baseurl }}{% link modding/existing-mods.md %})
|
||||
- [Last Callers]({{ site.baseurl }}{% link modding/last-callers.md %})
|
||||
- [Who's Online]({{ site.baseurl }}{% link modding/whos-online.md %})
|
||||
- [User List]({{ site.baseurl }}{% link modding/user-list.md %})
|
||||
|
||||
- [Oputil]({{ site.baseurl }}{% link oputil/index.md %})
|
||||
|
||||
|
|
|
@ -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.
|
||||
|
||||
|
||||
|
|
24
docs/modding/user-list.md
Normal file
24
docs/modding/user-list.md
Normal file
|
@ -0,0 +1,24 @@
|
|||
---
|
||||
layout: page
|
||||
title: User List
|
||||
---
|
||||
## The User List Module
|
||||
The built in `user_list` module provides basic user list functionality.
|
||||
|
||||
## Configuration
|
||||
### Config Block
|
||||
Available `config` block entries:
|
||||
* `dateTimeFormat`: [moment.js](https://momentjs.com) style format. Defaults to current theme → system `short` format.
|
||||
|
||||
### Theming
|
||||
The following `itemFormat` object is provided to MCI 1 (ie: `%VM1`):
|
||||
* `userId`: User ID.
|
||||
* `userName`: Login username.
|
||||
* `realName`: User's real name.
|
||||
* `lastLoginTimestamp`: Full last login timestamp for formatting use.
|
||||
* `lastLoginTs`: Last login timestamp formatted with `dateTimeFormat` style.
|
||||
* `location`: User's location.
|
||||
* `affiliation` or `affils`: Users affiliations.
|
||||
|
||||
|
||||
|
|
@ -8,6 +8,7 @@ The built in `whos_online` module provides a basic who's online mod.
|
|||
### Theming
|
||||
The following `itemFormat` object is provided to MCI 1 (ie: `%VM1`):
|
||||
* `userId`: User ID.
|
||||
* `userName`: Login username.
|
||||
* `node`: Node ID the user is connected to.
|
||||
* `timeOn`: A human friendly amount of time the user has been online.
|
||||
* `realName`: User's real name.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue