From 939c07f466e1dbd04f0efbf35cd4f950f0cf1e69 Mon Sep 17 00:00:00 2001 From: Bryan Ashby Date: Sat, 21 Nov 2020 12:35:46 -0700 Subject: [PATCH] More doc cleanup --- docs/art/themes.md | 60 +++++++++++------------ docs/configuration/directory-structure.md | 6 +-- docs/configuration/security.md | 2 +- docs/filebase/first-file-area.md | 2 +- docs/filebase/uploads.md | 2 +- docs/messageareas/ftn.md | 2 +- docs/servers/nntp.md | 1 + 7 files changed, 38 insertions(+), 37 deletions(-) diff --git a/docs/art/themes.md b/docs/art/themes.md index ec3e3684..9c9087e1 100644 --- a/docs/art/themes.md +++ b/docs/art/themes.md @@ -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: * - } +} ``` diff --git a/docs/configuration/directory-structure.md b/docs/configuration/directory-structure.md index e139be80..4060991c 100644 --- a/docs/configuration/directory-structure.md +++ b/docs/configuration/directory-structure.md @@ -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 %}) diff --git a/docs/configuration/security.md b/docs/configuration/security.md index dc2a122d..8461a381 100644 --- a/docs/configuration/security.md +++ b/docs/configuration/security.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: diff --git a/docs/filebase/first-file-area.md b/docs/filebase/first-file-area.md index a30e40f3..c561b055 100644 --- a/docs/filebase/first-file-area.md +++ b/docs/filebase/first-file-area.md @@ -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! diff --git a/docs/filebase/uploads.md b/docs/filebase/uploads.md index b6bceef2..3d994440 100644 --- a/docs/filebase/uploads.md +++ b/docs/filebase/uploads.md @@ -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) diff --git a/docs/messageareas/ftn.md b/docs/messageareas/ftn.md index 276d28de..f3d1237a 100644 --- a/docs/messageareas/ftn.md +++ b/docs/messageareas/ftn.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: diff --git a/docs/servers/nntp.md b/docs/servers/nntp.md index c6ceaf2e..6d15fa17 100644 --- a/docs/servers/nntp.md +++ b/docs/servers/nntp.md @@ -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. |