From f4a90900ae6ff36c39e840d41d64b1ef9e1aaaf4 Mon Sep 17 00:00:00 2001
From: Bryan Ashby <bryan@l33t.codes>
Date: Sun, 3 Sep 2023 11:01:43 -0600
Subject: [PATCH] TIC attachment doc updates

---
 docs/_docs/filebase/tic-support.md | 58 ++++++++++++++++++++----------
 1 file changed, 40 insertions(+), 18 deletions(-)

diff --git a/docs/_docs/filebase/tic-support.md b/docs/_docs/filebase/tic-support.md
index e1d01ffb..9639b5b7 100644
--- a/docs/_docs/filebase/tic-support.md
+++ b/docs/_docs/filebase/tic-support.md
@@ -3,7 +3,7 @@ layout: page
 title: TIC Support
 ---
 ## TIC Support
-ENiGMA½ supports FidoNet-Style TIC file attachments by mapping TIC areas to local file areas.
+ENiGMA½ supports FidoNet-Style TIC file attachments by mapping external TIC area tags to local file areas.
 
 Under a given node defined in the `ftn_bso` config section in `config.hjson` (see
 [BSO Import/Export](../messageareas/bso-import-export.md)), TIC configuration may be supplied:
@@ -17,9 +17,9 @@ Under a given node defined in the `ftn_bso` config section in `config.hjson` (se
           packetPassword: mypass
           encoding: cp437
           archiveType: zip
-          tic: {
+          tic: { // <--- General TIC config for 46:*
             password: TESTY-TEST
-            uploadBy: Agoranet TIC
+            uploadBy: AgoraNet TIC
             allowReplace: true
           }
         }
@@ -29,7 +29,15 @@ Under a given node defined in the `ftn_bso` config section in `config.hjson` (se
 }
 ```
 
-You then need to configure the mapping between TIC areas you want to carry, and the file base area and storage tag for them to be tossed to. Optionally you can also add hashtags to the tossed files to assist users in searching for files:
+Valid `tic` members:
+
+| Item | Required | Description |
+|--------|---------------|------------------|
+| `password` | :-1: | TIC packet password, if required |
+| `uploadedBy` | :-1: | Sets the "uploaded by" field for TIC attachments, for example "AgoraNet TIC" |
+| `allowReplace` | :-1: | Set to `true` to allow TIC attachments to replace each other. This is especially handy for things like weekly node list attachments |
+
+Next, we need to configure the mapping between TIC areas you want to carry, and the file base area (and, optionally, specific storage tag) for them to be tossed to. You can also add hashtags to the tossed files to assist users in searching for files:
 
 ```hjson
 ticAreas: {
@@ -41,10 +49,22 @@ ticAreas: {
 }
 
 ```
-Multiple TIC areas can be mapped to a single file base area.
+
+> :information_source: Note that in the example above `agn_node` represents the **external** network area tag, usually represented in all caps. In this case, `AGN_NODE`.
+
+Valid `ticAreas` members under a given node mapping are as follows:
+
+| Item | Required | Description |
+|--------|---------------|------------------|
+| `areaTag` | :+1: | Specifies the local areaTag in which to place TIC attachments |
+| `storageTag` | :-1: | Optionally, set a specific storageTag. If not set, the default for this area will be used. |
+| `hashTags` | :-1: | One or more optional hash tags to assign TIC attachments in this area. |
+
+
+💡 Multiple TIC areas can be mapped to a single file base area.
 
 ### Example Configuration
-An example configuration linking file base areas, FTN BSO node configuration and TIC area configuration.
+Example configuration fragments mapping file base areas, FTN BSO node configuration and TIC area configuration.
 
 ```hjson
 fileBase: {
@@ -79,22 +99,24 @@ scannerTossers: {
                 }
             }
         }
+
+        ticAreas: {
+            // here we map AgoraNet AGN_NODE -> local msgNetworks file area
+            agn_node: {
+                areaTag: msgNetworks
+                storageTag: msg_network
+                hashTags: agoranet,nodelist
+            }
+            agn_info: {
+                areaTag: msgNetworks
+                storageTag: msg_network
+                hashTags: agoranet,infopack
+            }
+        }
     }
 }
 
 
-ticAreas: {
-    agn_node: {
-        areaTag: msgNetworks
-        storageTag: msg_network
-        hashTags: agoranet,nodelist
-    }
-    agn_info: {
-        areaTag: msgNetworks
-        storageTag: msg_network
-        hashTags: agoranet,infopack
-    }
-}
 ```
 
 ## See Also