Doc updates

This commit is contained in:
Bryan Ashby 2018-07-27 21:50:51 -06:00
parent 33790a74e3
commit 82278a212b
3 changed files with 45 additions and 17 deletions

View File

@ -2,5 +2,4 @@
layout: page layout: page
title: General title: General
--- ---
General art lives in the `art/general` directory. 'General' art is ANSI you want to stay consistent across themes, General art lives in the `art/general` directory. 'General' art is ANSI you want to stay consistent across themes, such as a welcome ANSI or a rotation of logoff ANSIs.
such as a welcome ANSI or a rotation of logoff ANSIs.

View File

@ -72,7 +72,7 @@ iNiQUiTY, etc.
| `SU` | Total uploads, system wide | | `SU` | Total uploads, system wide |
| `SP` | Total uploaded amount, system wide (formatted to appropriate bytes/megs/etc.) | | `SP` | Total uploaded amount, system wide (formatted to appropriate bytes/megs/etc.) |
A special `XY` MCI code may also be utilized for placement identification when creating menus. A special `XY` MCI code may also be utilized for placement identification when creating menus or to extend an otherwise empty space in an art file down the screen.
## Views ## Views
@ -112,10 +112,14 @@ Predefined MCI codes and other Views can have properties set via `menu.hjson` an
| `focus` | If set to `true`, establishes initial focus | | `focus` | If set to `true`, establishes initial focus |
| `text` | (initial) text of a view | | `text` | (initial) text of a view |
| `submit` | If set to `true` any `accept` action upon this view will submit the encompassing **form** | | `submit` | If set to `true` any `accept` action upon this view will submit the encompassing **form** |
| `itemFormat` | Sets the format for a list entry. See **Entry Formatting** below |
| `focusItemFormat` | Sets the format for a focused list entry. See **Entry Formatting** below |
These are just a few of the properties set on various views. *Use the source Luke*, as well as taking a look at the default These are just a few of the properties set on various views. *Use the source Luke*, as well as taking a look at the default
`menu.hjson` and `theme.hjson` files! `menu.hjson` and `theme.hjson` files!
### Custom Properties
Often a module will provide custom properties that receive format objects (See **Entry Formatting** below). Custom property formatting can be declared in the `config` block. For example, `browseInfoFormat10`..._N_ (where _N_ is up to 99) in the `file_base_search` module received a fairly extensive format object that contains `{fileName}`, `{estReleaseYear}`, etc.
### Text Styles ### Text Styles
@ -133,3 +137,24 @@ Standard style types available for `textStyle` and `focusTextStyle`:
| `small i` | ENiGMA BULLETiN BOARD SOFTWARE | | `small i` | ENiGMA BULLETiN BOARD SOFTWARE |
| `mixed` | EnIGma BUlLEtIn BoaRd SOfTWarE (randomly assigned) | | `mixed` | EnIGma BUlLEtIn BoaRd SOfTWarE (randomly assigned) |
| `l33t` | 3n1gm4 bull371n b04rd 50f7w4r3 | | `l33t` | 3n1gm4 bull371n b04rd 50f7w4r3 |
### Entry Fromatting
Various strings can be formatted using a syntax that allows width & precision specifiers, text styling, etc. Depending on the context, various elements can be referenced by `{name}`. Additional text styles can be supplied as well. The syntax is largely modeled after Python's [string format mini language](https://docs.python.org/3/library/string.html#format-specification-mini-language).
### Additional Text Styles
Additional text styles are available for numbers:
| Style | Description |
|-------------------|---------------|
| `sizeWithAbbr` | File size (converted from bytes) with abbreviation such as `1 MB`, `2.2 GB`, `34 KB`, etc. |
| `sizeWithoutAbbr` | Just the file size (converted from bytes) without the abbreviation. For example: 1024 becomes 1. |
| `sizeAbbr` | Just the abbreviation given a file size (converted from bytes) such as `MB` or `GB`. |
| `countWithAbbr` | Count with abbreviation such as `100 K`, `4.3 B`, etc. |
| `countWithoutAbbr` | Just the count |
| `countAbbr` | Just the abbreviation such as `M` for millions. |
#### Examples
Suppose a format object contains the following elements: `userName` and `affils`. We could create a `itemFormat` entry that builds a item to our specifications: `|04{userName!styleFirstLower} |08- |13{affils}`. This may produce a string such as "<font color="red">eVIL cURRENT</font> <font color="grey">-</font> <font color="magenta">Razor 1911</font>".
Remember that a Python [string format mini language](https://docs.python.org/3/library/string.html#format-specification-mini-language) style syntax is available for widths, alignment, number prevision, etc. as well. A number can be made to be more human readable for example: `{byteSize:,}` may yield "1,123,456".

View File

@ -2,18 +2,20 @@
layout: page layout: page
title: Themes title: Themes
--- ---
# Creating Your Own
:warning: ***IMPORTANT!*** It is recommended you don't make any customisations to the included :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: `luciano_blocktronics' theme. Create your own and make changes to that instead:
1. Copy `/art/themes/luciano_blocktronics` to `art/themes/your_board_theme` 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: 2. Update the `info` block at the top of the theme.hjson file:
``` hjson
info: { info: {
name: Awesome Theme name: Awesome Theme
author: Cool Artist author: Cool Artist
group: Sick Group group: Sick Group
enabled: true enabled: true
} }
```
3. Specify it in the `defaults` section of `config.hjson`. The name supplied should match the name of the 3. Specify it in the `defaults` section of `config.hjson`. The name supplied should match the name of the
directory you created in step 1: directory you created in step 1:
@ -23,3 +25,5 @@ directory you created in step 1:
theme: your_board_theme theme: your_board_theme
} }
``` ```
# General Theme Info