mirror of
https://github.com/NuSkooler/enigma-bbs.git
synced 2025-07-21 02:05:54 +02:00
Onelinerz standardization work and docs
This commit is contained in:
parent
5859ba0b68
commit
a14c0f42af
4 changed files with 24 additions and 4 deletions
|
@ -72,6 +72,7 @@
|
|||
- [BBS List]({{ site.baseurl }}{% link modding/bbs-list.md %})
|
||||
- [Rumorz]({{ site.baseurl }}{% link modding/rumorz.md %})
|
||||
- [File Transfer Protocol Select]({{ site.baseurl }}{% link modding/file-transfer-protocol-select.md %})
|
||||
- [Onelinerz]({{ site.baseurl }}{% link modding/onelinerz.md %})
|
||||
|
||||
- Administration
|
||||
- [oputil]({{ site.baseurl }}{% link admin/oputil.md %})
|
||||
|
|
18
docs/modding/onelinerz.md
Normal file
18
docs/modding/onelinerz.md
Normal file
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
layout: page
|
||||
title: Onelinerz
|
||||
---
|
||||
## The Onelinerz Module
|
||||
The built in `onelinerz` module provides a retro onelinerz system.
|
||||
|
||||
## Configuration
|
||||
### Config Block
|
||||
Available `config` block entries:
|
||||
* `dateTimeFormat`: [moment.js](https://momentjs.com) style format. Defaults to current theme → system `short` date format.
|
||||
|
||||
### Theming
|
||||
The following `itemFormat` object is provided to MCI 1 (ie: `%VM1`):
|
||||
* `userId`: User ID of the onliner entry.
|
||||
* `userName`: Login username of the onliner entry.
|
||||
* `oneliner`: The oneliner text. Note that the standard `{text}` field also contains this value.
|
||||
* `ts`: Timestamp of the entry formatted with `dateTimeFormat` format described above.
|
|
@ -19,6 +19,3 @@ The following `itemFormat` object is provided to MCI 1 (ie: `%VM1`):
|
|||
* `lastLoginTs`: Last login timestamp formatted with `dateTimeFormat` style.
|
||||
* `location`: User's location.
|
||||
* `affiliation` or `affils`: Users affiliations.
|
||||
|
||||
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue