zydronium/enigma-bbs
1
0
Fork 0
mirror of https://github.com/NuSkooler/enigma-bbs.git synced 2025-08-03 16:31:59 +02:00
Code Issues Projects Releases Packages Wiki Activity

ACS doc improvements

Browse source
This commit is contained in:
Bryan Ashby 2018-12-09 01:22:33 -07:00
parent 8652b35b46
commit 4bceb74cc4
2 changed files with 40 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

32
docs/messageareas/configuring-a-message-area.md
View file

@ -10,13 +10,18 @@ Message Conferences are the top level container for *1:n* Message *Areas* via th
Each conference is represented by a entry under `messageConferences`. Each entries top level key is it's *conference tag*.
| Config Item | Required | Description |
|-------------|----------|---------------------------------------------------------------------------------|
| `name` | :+1: | Friendly conference name |
| `desc` | :+1: | Friendly conference description. |
| `sort` | :-1: | Set to a number to override the default alpha-numeric sort order based on the `name` field. |
| `default` | :-1: | Specify `true` to make this the default conference (e.g. assigned to new users) |
| `areas` | :+1: | Container of 1:n areas described below |
| Config Item | Required | Description |
|-------------|----------|-------------|
| `name` | :+1: | Friendly conference name |
| `desc` | :+1: | Friendly conference description. |
| `sort` | :-1: | Set to a number to override the default alpha-numeric sort order based on the `name` field. |
| `default` | :-1: | Specify `true` to make this the default conference (e.g. assigned to new users) |
| `areas` | :+1: | Container of 1:n areas described below |
| `acs` | :-1: | A standard [ACS](/docs/configuration/acs.md) block. See **ACS** below. |
### ACS
An optional standard [ACS](/docs/configuration/acs.md) block can be supplied with the following rules:
* `read`: ACS require to read (see) this conference. Defaults to `GM[users]`.
### Example
@ -28,6 +33,9 @@ Each conference is represented by a entry under `messageConferences`. Each entri
desc: Local discussion
sort: 1
default: true
acs: {
read: GM[users] // default
}
}
}
}
@ -42,6 +50,11 @@ Message Areas are topic specific containers for messages that live within a part
| `desc` | :+1: | Friendly area description. |
| `sort` | :-1: | Set to a number to override the default alpha-numeric sort order based on the `name` field. |
| `default` | :-1: | Specify `true` to make this the default area (e.g. assigned to new users) |
| `acs` | :-1: | A standard [ACS](/docs/configuration/acs.md) block. See **ACS** below. |
### ACS
An optional standard [ACS](/docs/configuration/acs.md) block can be supplied with the following rules:
* `read`: ACS require to read (see) this conference. Defaults to `GM[users]`.
### Example
@ -54,7 +67,10 @@ messageConferences: {
name: ENiGMA 1/2 Development
desc: ENiGMA 1/2 discussion!
sort: 1
default: true
default: true
acs: {
read: GM[users] // default
}
}
}
}