mirror of
https://github.com/NuSkooler/enigma-bbs.git
synced 2025-07-31 15:06:15 +02:00
More itemFormat & doc work
This commit is contained in:
parent
a98940e967
commit
5af2fdc6c5
4 changed files with 48 additions and 11 deletions
24
docs/modding/bbs-list.md
Normal file
24
docs/modding/bbs-list.md
Normal file
|
@ -0,0 +1,24 @@
|
|||
---
|
||||
layout: page
|
||||
title: BBS List
|
||||
---
|
||||
## The BBS List Module
|
||||
The built in `bbs_list` module provides the ability for users to manage entries to other Bulletin Board Systems.
|
||||
|
||||
## Configuration
|
||||
### Config Block
|
||||
Available `config` block entries:
|
||||
* `youSubmittedFormat`: Provides a format for entries that were submitted (and therefor ediable) by the current user. Defaults to `'{submitter} (You!)'`. Utilizes the same `itemFormat` object as entries described below.
|
||||
|
||||
### Theming
|
||||
The following `itemFormat` object is provided to MCI 1 (ie: `%VM1`) (the BBS list):
|
||||
* `id`: Row ID
|
||||
* `bbsName`: System name. Note that `{text}` also contains this value.
|
||||
* `sysOp`: System Operator
|
||||
* `telnet`: Telnet address
|
||||
* `www`: Web address
|
||||
* `location`: System location
|
||||
* `software`: System's software
|
||||
* `submitter`: Username of entry submitter
|
||||
* `submitterUserId`: User ID of submitter
|
||||
* `notes`: Any additional notes about the system
|
12
docs/modding/rumorz.md
Normal file
12
docs/modding/rumorz.md
Normal file
|
@ -0,0 +1,12 @@
|
|||
---
|
||||
layout: page
|
||||
title: Rumorz
|
||||
---
|
||||
## The Rumorz Module
|
||||
The built in `rumorz` module provides a classic interface for users to add and view rumorz!
|
||||
|
||||
## Configuration
|
||||
|
||||
### Theming
|
||||
The following `itemFormat` object is provided to MCI 1 (ie: `%VM1`) (the rumor list):
|
||||
* `rumor`: The rumor text. Also available in the standard `{text}` field.
|
Loading…
Add table
Add a link
Reference in a new issue