More doc cleanup
This commit is contained in:
Bryan Ashby
parent
5e52b31918
commit
939c07f466
|
|
@ -11,7 +11,7 @@ Themes live in `art/themes/`. Each theme (and thus it's *theme ID*) is a directo
|
|||
## Art
|
||||
For information on art files, see [General Art Information](general.md). TL;DR: In general, to theme a piece of art, create a version of it in your themes directory.
|
||||
|
||||
:note: Remember that by default, the system will allow for randomly selecting art (in one of the directories mentioned above) by numbering it: `FOO1.ANS`, `FOO2.ANS`, etc.!
|
||||
:memo: Remember that by default, the system will allow for randomly selecting art (in one of the directories mentioned above) by numbering it: `FOO1.ANS`, `FOO2.ANS`, etc.!
|
||||
|
||||
## Theme Sections
|
||||
Themes are some important sections to be aware of:
|
||||
|
|
@ -53,9 +53,9 @@ Override system defaults.
|
|||
Example:
|
||||
```hjson
|
||||
defaults: {
|
||||
dateTimeFormat: {
|
||||
short: MMM Do h:mm a
|
||||
}
|
||||
dateTimeFormat: {
|
||||
short: MMM Do h:mm a
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -73,30 +73,30 @@ Two formats for `mci` blocks are allowed:
|
|||
Example: Verbose `mci` with form IDs:
|
||||
```hjson
|
||||
newUserFeedbackToSysOp: {
|
||||
0: {
|
||||
mci: {
|
||||
TL1: { width: 19, textOverflow: "..." }
|
||||
ET2: { width: 19, textOverflow: "..." }
|
||||
ET3: { width: 19, textOverflow: "..." }
|
||||
0: {
|
||||
mci: {
|
||||
TL1: { width: 19, textOverflow: "..." }
|
||||
ET2: { width: 19, textOverflow: "..." }
|
||||
ET3: { width: 19, textOverflow: "..." }
|
||||
}
|
||||
}
|
||||
}
|
||||
1: {
|
||||
mci: {
|
||||
MT1: { height: 14 }
|
||||
1: {
|
||||
mci: {
|
||||
MT1: { height: 14 }
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Example: Shorthand `mci` format:
|
||||
```hjson
|
||||
matrix: {
|
||||
mci: {
|
||||
VM1: {
|
||||
itemFormat: "|03{text}"
|
||||
focusItemFormat: "|11{text!styleFirstLower}"
|
||||
mci: {
|
||||
VM1: {
|
||||
itemFormat: "|03{text}"
|
||||
focusItemFormat: "|11{text!styleFirstLower}"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -105,9 +105,9 @@ Many modules support "custom range" MCI items. These are MCI codes that are left
|
|||
|
||||
```hjson
|
||||
messageAreaChangeCurrentArea: {
|
||||
config: {
|
||||
areaListInfoFormat10: "|15{name}|07: |03{desc}"
|
||||
}
|
||||
config: {
|
||||
areaListInfoFormat10: "|15{name}|07: |03{desc}"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -117,18 +117,18 @@ messageAreaChangeCurrentArea: {
|
|||
1. Copy `/art/themes/luciano_blocktronics` to `art/themes/your_board_theme`
|
||||
2. Update the `info` block at the top of the theme.hjson file:
|
||||
``` hjson
|
||||
info: {
|
||||
name: Awesome Theme
|
||||
author: Cool Artist
|
||||
group: Sick Group
|
||||
enabled: true // default
|
||||
}
|
||||
info: {
|
||||
name: Awesome Theme
|
||||
author: Cool Artist
|
||||
group: Sick Group
|
||||
enabled: true // default
|
||||
}
|
||||
```
|
||||
|
||||
3. If desired, you may make this the default system theme in `config.hjson` via `theme.default`. `theme.preLogin` may be set if you want this theme used for pre-authenticated users. Both of these values also accept `*` if you want the system to radomly pick.
|
||||
``` hjson
|
||||
theme: {
|
||||
theme: {
|
||||
default: your_board_theme
|
||||
preLogin: *
|
||||
}
|
||||
}
|
||||
```
|
||||
|
|
|
|||
|
|
@ -9,9 +9,9 @@ All paths mentioned here are relative to the ENiGMA½ checkout directory.
|
|||
| `/art/general` | Non-theme art - welcome ANSI, logoff ANSI, etc. See [General Art]({{ site.baseurl }}{% link art/general.md %}).
|
||||
| `/art/themes` | Theme art. Themes should be in their own subdirectory and contain a theme.hjson. See [Themes]({{ site.baseurl }}{% link art/themes.md %}).
|
||||
| `/config` | [config.hjson](config-hjson.md) system configuration.
|
||||
| `/config/menus` | [menu.hjson](menu-hjson.md)storage.
|
||||
| `/config/security` | D path for SSL certs and public/private keys.
|
||||
| `/db` | All ENiGMA½ databases in Sqlite3 format.
|
||||
| `/config/menus` | [menu.hjson](menu-hjson.md) storage.
|
||||
| `/config/security` | SSL certificates and public/private keys.
|
||||
| `/db` | All ENiGMA½ databases in SQLite3 format.
|
||||
| `/docs` | These docs ;-)
|
||||
| `/dropfiles` | Dropfiles created for [local doors]({{ site.baseurl }}{% link modding/local-doors.md %})
|
||||
| `/logs` | Logs. See [Monitoring Logs]({{ site.baseurl }}{% link troubleshooting/monitoring-logs.md %})
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ Due to the nature of 2FA/OTP, even if enabled on your system, users must opt-in
|
|||
|
||||
:warning: Serving 2FA/OTP registration links over insecure (HTTP) can expose secrets intended for the user and is **highly** discouraged!
|
||||
|
||||
:note: +ops can also manually enable or disable 2FA/OTP for a user using [oputil](/docs/admin/oputil.md), but this is generally discouraged.
|
||||
:memo: +ops can also manually enable or disable 2FA/OTP for a user using [oputil](/docs/admin/oputil.md), but this is generally discouraged.
|
||||
|
||||
#### Recovery
|
||||
In the situation that a user loses their 2FA/OTP device (such as a lost phone with Google Auth), there are some options:
|
||||
|
|
|
|||
|
|
@ -23,7 +23,7 @@ storageTags: {
|
|||
}
|
||||
```
|
||||
|
||||
:note: On their own, storage tags don't do anything — they are simply pointers to storage locations on your system.
|
||||
:memo: On their own, storage tags don't do anything — they are simply pointers to storage locations on your system.
|
||||
|
||||
:warning: Remember that paths are case sensitive on most non-Windows systems!
|
||||
|
||||
|
|
|
|||
|
|
@ -21,4 +21,4 @@ uploads: {
|
|||
|
||||
:information_source: Remember that uploads in a particular area are stored **using the first storage tag defined in that area.**
|
||||
|
||||
:information_source: Any ACS checks are allowed. See [ACS](../configuration/acs.md)
|
||||
:bulb: Any ACS checks are allowed. See [ACS](../configuration/acs.md)
|
||||
|
|
|
|||
|
|
@ -70,7 +70,7 @@ Example:
|
|||
}
|
||||
```
|
||||
|
||||
:note: You can import `AREAS.BBS` or FTN style `.NA` files using [oputil](/docs/admin/oputil.md)!
|
||||
:bulb: You can import `AREAS.BBS` or FTN style `.NA` files using [oputil](/docs/admin/oputil.md)!
|
||||
|
||||
#### A More Complete Example
|
||||
Below is a more complete *example* illustrating some of the concepts above:
|
||||
|
|
|
|||
|
|
@ -6,6 +6,7 @@ title: NNTP Server
|
|||
The NNTP *content server* provides access to publicly exposed message conferences and areas over either **secure** NNTPS (NNTP over TLS or nttps://) and/or non-secure NNTP (nntp://).
|
||||
|
||||
## Configuration
|
||||
|
||||
| Item | Required | Description |
|
||||
|------|----------|-------------|
|
||||
| `nntp` | :-1: | Configuration block for non-secure NNTP. See Non-Secure NNTP Configuration below. |
|
||||
|
|
|
|||
Loading…
Reference in New Issue