Skip to content

Commit

Permalink
Merge pull request #548 from voipmeister/master
Browse files Browse the repository at this point in the history
Minor doc changes
  • Loading branch information
NuSkooler authored Aug 24, 2024
2 parents 9c0bc88 + 9f0249a commit 875b8fc
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
4 changes: 2 additions & 2 deletions docs/_docs/art/mci.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,8 +107,8 @@ There are many predefined MCI codes that can be used anywhere on the system (pla
| `NT` | Total *new* users *today* |
| `NM` | Count of new messages **address to the current user** across all message areas in which they have access |
| `NP` | Count of new private mail to the current user |
| `IA` | Indicator as to rather the current user is **available** or not. See also `getStatusAvailIndicators()` in [Themes](themes.md) |
| `IV` | Indicator as to rather the current user is **visible** or not. See also `getStatusVisibleIndicators()` in [Themes](themes.md) |
| `IA` | Indicator as to whether the current user is **available** or not. See also `getStatusAvailIndicators()` in [Themes](themes.md) |
| `IV` | Indicator as to whether the current user is **visible** or not. See also `getStatusVisibleIndicators()` in [Themes](themes.md) |
| `PI` | Ingress bytes for the current process (since ENiGMA started up) |
| `PE` | Egress bytes for the current process (since ENiGMA started up) |

Expand Down
2 changes: 1 addition & 1 deletion docs/_docs/configuration/acs.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: Access Condition System (ACS)
ENiGMA½ uses an Access Condition System (ACS) that is both familiar to oldschool BBS operators and has it's own style. With ACS, SysOp's are able to control access to various areas of the system based on various conditions such as group membership, connection type, etc. Various touch points in the system are configured to allow for `acs` checks. In some cases ACS is a simple boolean check while others (via ACS blocks) allow to define what conditions must be true for certain _rights_ such as `read` and `write` (though others exist as well).

## Group Membership
ENiGMA½ does not utilize legacy "security levels" (see note below) but instead utilizes a group system. Users may be long to one or more groups which can be checked by the `GM` ACS (See [ACS Codes](#acs-codes) below). Two special groups exist out of the box:
ENiGMA½ does not utilize legacy "security levels" (see note below) but instead utilizes a group system. Users may belong to one or more groups which can be checked by the `GM` ACS (See [ACS Codes](#acs-codes) below). Two special groups exist out of the box:
1. `users`: Any regular user
2. `sysops`: System Operators. The first user (your root, or admin) will alwasy belong to this group.

Expand Down
10 changes: 5 additions & 5 deletions docs/_docs/modding/wfc.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,11 +60,11 @@ The following MCI codes are available:
* `text`: Username or `*Pre Auth*`.
* `action`: Current action/menu.
* `affils`: Any affiliations related to the if `authenticated`, else "N/A".
* `authenticated`: Boolean rather the node is authenticated (logged in) or not.
* `authenticated`: Boolean whether the node is authenticated (logged in) or not.
* `availIndicator`: Indicator of availability (e.g. for messaging)? Displayed via `statusAvailableIndicators` or system theme. See also [Themes](../art/themes.md).
* `isAvailalbe`: Boolean rather the node is availalbe (e.g. for messaging) or not.
* `isAvailable`: Boolean whether the node is available (e.g. for messaging) or not.
* `isSecure`: Is the node securely connected (ie: SSL)?
* `isVisible`: Boolean rather the node is visible to others or not.
* `isVisible`: Boolean whether the node is visible to others or not.
* `node`: The node ID.
* `realName`: Real name of authenticated user, or "N/A".
* `serverName`: Name of connected server such as "Telnet" or "SSH".
Expand All @@ -90,7 +90,7 @@ The following MCI codes are available:
* `quickLogLevelMessagePrefixes`: A **map** of log level names (see above) to message prefixes. Commonly used for changing message color with pipe codes, such as `|04` for red errors.
* `message`: Log message.
* `MT3` or `ET3`: Selected node status information. May be a single or multi line view.
* Set `nodeStatusSelectionFormat` to the format desired including `\n` for line feeds in as `MT` view. The availalbe format keys are the same as the node status list above.
* Set `nodeStatusSelectionFormat` to the format desired including `\n` for line feeds in as `MT` view. The available format keys are the same as the node status list above.
* MCI 10...99: Custom entries with the following format keys available:
* `nowDate`: Current date in the `dateFormat` style, defaulting to `short`.
* `nowTime`: Current time in the `timeFormat` style, defaulting to `short`.
Expand Down Expand Up @@ -121,7 +121,7 @@ The following MCI codes are available:
* `systemCurrentLoad`: System current load.
* `newPrivateMail`: Number of new **private** mail for current user.
* `newMessagesAddrTo`: Number of new messages **addressed to the current user**.
* `availIndicator`: Is the current user availalbe? Displayed via `statusAvailableIndicators` or system theme. See also [Themes](../art/themes.md).
* `availIndicator`: Is the current user available? Displayed via `statusAvailableIndicators` or system theme. See also [Themes](../art/themes.md).
* `visIndicator`: Is the current user visible? Displayed via `statusVisibleIndicators` or system theme. See also [Themes](../art/themes.md).
* `processBytesIngress`: Ingress bytes since ENiGMA started.
* `processBytesEgress`: Egress bytes since ENiGMA started.
Expand Down

0 comments on commit 875b8fc

Please sign in to comment.