Onelinerz standardization work and docs

This commit is contained in:
Bryan Ashby 2018-11-05 22:39:49 -07:00
parent 5859ba0b68
commit a14c0f42af
4 changed files with 24 additions and 4 deletions

18
docs/modding/onelinerz.md Normal file
View 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.

View file

@ -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.