enigma-bbs/docs/messageareas/configuring-a-message-area.md

layout	title
page	Configuring a Message Area

Message Conferences and Areas allow for grouping of message base topics.

Message Conferences

Message Conferences are the top level container for 1:n Message Areas via the messageConferences section in config.hjson. Common message conferences may include a local conference and one or more conferences each dedicated to a particular message network such as FsxNet, AgoraNet, etc.

Each conference is represented by a entry under messageConferences. The areas key is the conferences tag.

Config Item	Required	Description
name	👍	Friendly conference name
desc	👍	Friendly conference description
sort	👎	If supplied, provides a key used for sorting
default	👎	Specify true to make this the default conference (e.g. assigned to new users)
areas	👍	Container of 1:n areas described below

Example

{
  messageConferences: {
    local: {
      name: Local
      desc: Local discussion
      sort: 1
      default: true
    }
  }
}

Message Areas

Message Areas are topic specific containers for messages that live within a particular conference. # The area's key is its area tag. For example, "General Discussion" may live under a Local conference while an AgoraNet conference may contain "BBS Discussion".

Config Item	Required	Description
name	👍	Friendly area name
desc	👍	Friendly area discription
sort	👎	If supplied, provides a key used for sorting
default	👎	Specify true to make this the default area (e.g. assigned to new users)

Example

messageConferences: {
  local: {
    // ... see above ...
    areas: {
      enigma_dev: {                     // Area tag - required elsewhere!
        name: ENiGMA 1/2 Development   
        desc: ENiGMA 1/2 discussion!   
        sort: 1                        
        default: true                   
      }
    }
  }
}