From f1f749499ff4a8c679e1b2b98a40cf3d3c25de59 Mon Sep 17 00:00:00 2001 From: Bryan Ashby Date: Fri, 16 Nov 2018 18:30:44 -0700 Subject: [PATCH] More doc updates --- docs/art/mci.md | 5 +++-- docs/art/themes.md | 24 +++++++++++++++++------- docs/modding/msg-area-list.md | 2 +- 3 files changed, 21 insertions(+), 10 deletions(-) diff --git a/docs/art/mci.md b/docs/art/mci.md index f5876105..36ca4aa6 100644 --- a/docs/art/mci.md +++ b/docs/art/mci.md @@ -71,6 +71,7 @@ for a full listing. Many codes attempt to pay homage to Oblivion/2, iNiQUiTY, et | `SU` | Total uploads, system wide | | `SP` | Total uploaded amount, system wide (formatted to appropriate bytes/megs/etc.) | + Some additional special case codes also exist: | Code | Description | |--------|--------------| @@ -78,7 +79,7 @@ Some additional special case codes also exist: | `CB##` | Moves the cursor position back _##_ characters | | `CU##` | Moves the cursor position up _##_ characters | | `CD##` | Moves the cursor position down _##_ characters | -| `XY` | A special code that may be utilized for placement identification when creating menus or to extend an otherwise empty space in an art file down the screen. +| `XY` | A special code that may be utilized for placement identification when creating menus or to extend an otherwise empty space in an art file down the screen. | ## Views @@ -104,7 +105,7 @@ see additional information. ## Properties & Theming -Predefined MCI codes and other Views can have properties set via `menu.hjson` and further *themed* via `theme.hjson`. +Predefined MCI codes and other Views can have properties set via `menu.hjson` and further *themed* via `theme.hjson`. See [Themes](themes.md) for more information on this subject. ### Common Properties diff --git a/docs/art/themes.md b/docs/art/themes.md index c3ac38cf..f0093897 100644 --- a/docs/art/themes.md +++ b/docs/art/themes.md @@ -41,11 +41,11 @@ The `info` configuration block describes the theme itself. ### Customization Block The `customization` block in is itself broken up into major parts: -| Item | Required | Description | +| Item | Description | |-------------|----------|----------------------------------------------------------| -| `defaults` | :-1: | Default values to use when this theme is active. These values override system defaults, but can still be overridden themselves in specific areas of your theme. | -| `menus` | :-1: | The bulk of what you theme in the system will be here. Any menu (that is, anything you find in `menu.hjson`) can be tweaked. | -| `prompts` | :-1: | Similar to `menus`, this file themes prompts found in `prompts.hjson`. | +| `defaults` | Default values to use when this theme is active. These values override system defaults, but can still be overridden themselves in specific areas of your theme. | +| `menus` | The bulk of what you theme in the system will be here. Any menu (that is, anything you find in `menu.hjson`) can be tweaked. | +| `prompts` | Similar to `menus`, this file themes prompts found in `prompts.hjson`. | #### Defaults | Item | Description | @@ -68,10 +68,10 @@ defaults: { Each *key* in the `menus` block matches up with a key found in your `menu.hjson`. For example, consider a `matrix` menu defined in `menu.hjson`. In addition to perhaps providing a `MATRIX.ANS` in your themes directory, you can also theme other parts of the menu via a `matrix` entry in `theme.hjson`. Major areas to override/theme: -* `config`: Override and/or provide additional theme information over that found in the `menu.hjson`'s entry. Common entries here are for further overriding date/time formats, and custom range info formats (`InfoFormat`). -* `mci`: Set `height`, `width`, override `text`, `textStyle`/`focusTextStyle`, `itemFormat`/`focusItemFormat`, etc. +* `config`: Override and/or provide additional theme information over that found in the `menu.hjson`'s entry. Common entries here are for further overriding date/time formats, and custom range info formats (`InfoFormat`). See Entry Formatting in [MCI Codes](mci.md) and Custom Range Info Formatting below. +* `mci`: Set per-MCI code properties such as `height`, `width`, text styles, etc. See [MCI Codes](mci.md) for a more information. -Two main formats for `mci` are allowed: +Two formats for `mci` blocks are allowed: * Verbose where a form ID(s) are supplied. * Shorthand if only a single/first form is needed. @@ -105,6 +105,16 @@ matrix: { } ``` +##### Custom Range Info Formatting +Many modules support "custom range" MCI items. These are MCI codes that are left to the user to define using a format object specific to the module. For example, consider the `msg_area_list` module: This module sets MCI codes 10+ (`%TL10`, `%TL11`, etc.) as "custom range". When theming you can place these MCI codes in your artwork then define the format in `theme.hjson`: + +```hjson +messageAreaChangeCurrentArea: { + config: { + areaListInfoFormat10: "|15{name}|07: |03{desc}" + } +} +``` ## Creating Your Own :warning: ***IMPORTANT!*** It is recommended you don't make any customisations to the included `luciano_blocktronics' theme. Create your own and make changes to that instead: diff --git a/docs/modding/msg-area-list.md b/docs/modding/msg-area-list.md index e3f5cde1..499b7fa6 100644 --- a/docs/modding/msg-area-list.md +++ b/docs/modding/msg-area-list.md @@ -14,4 +14,4 @@ The following `itemFormat` object is provided to MCI 1 (ie: `%VM1`): The following additional MCIs are updated as the user changes selections in the main list: * MCI 2 (ie: `%TL2` or `%M%2`) is updated with the area description. -* MCI 10+ (ie `%TL10`...) are custom ranges updated with the same information available above in `itemFormat`. +* MCI 10+ (ie `%TL10`...) are custom ranges updated with the same information available above in `itemFormat`. Use `areaListItemFormat##`.