moon
/
enigma-bbs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Slight doc update on message conf/areas

This commit is contained in:
Bryan Ashby 2020-07-12 13:58:46 -06:00
parent 0e1e7545a2
commit c3a19eb208
No known key found for this signature in database
GPG Key ID: B49EB437951D2542
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/messageareas/configuring-a-message-area.md
View File

@ -1,15 +1,17 @@
--- ---
layout: page layout: page
title: Configuring a Message Area title: Message Base
--- ---
## Message Conferences ## General Information
**Message Conferences** and **Areas** allow for grouping of message base topics. In ENiGMA½, a message base is divided into two logical grouping components: **Message Conferences** and **Areas**. Message conferences are top level containers while areas are for a specific topic. Messages are always stored internally with a area tag.
## Conferences ## Conferences
Message Conferences are the top level container for *1:n* Message *Areas* via the `messageConferences` block in `config.hjson`. A common setup may include a local conference and one or more conferences each dedicated to a particular message network such as fsxNet, ArakNet, etc. Message Conferences are the top level container for *1:n* Message *Areas* via the `messageConferences` block in `config.hjson`. A common setup may include a local conference and one or more conferences each dedicated to a particular message network such as fsxNet, ArakNet, etc.
Each conference is represented by a entry under `messageConferences`. Each entries top level key is it's *conference tag*. Each conference is represented by a entry under `messageConferences`. Each entries top level key is it's *conference tag*.
:information_source: It is **highly** recommended to use snake_case style message *conference tags* and *area tags*!
| Config Item | Required | Description | | Config Item | Required | Description |
|-------------|----------|-------------| |-------------|----------|-------------|
| `name` | :+1: | Friendly conference name | | `name` | :+1: | Friendly conference name |