moon
/
enigma-bbs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documentation changes

This commit is contained in:
Nathan Byrd 2022-07-31 13:17:51 -05:00
parent c799f1f73c
commit 4baba90fc4
2 changed files with 8 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
WHATSNEW.md
View File

@ -6,6 +6,7 @@ This document attempts to track **major** changes and additions in ENiGMA½. For
* Removed terminal `cursor position reports` from most locations in the code. This should greatly increase the number of terminal programs that work with Enigma 1/2. For more information, see [Issue #222](https://github.com/NuSkooler/enigma-bbs/issues/222). This may also resolve other issues, such as [Issue #365](https://github.com/NuSkooler/enigma-bbs/issues/365), and [Issue #320](https://github.com/NuSkooler/enigma-bbs/issues/320). Anyone that previously had terminal incompatibilities please re-check and let us know!
* Bumped up the minimum [Node.js](https://nodejs.org/en/) version to v14. This will allow more expressive Javascript programming syntax with ECMAScript 2020 to improve the development experience.
* Added new configuration options for `term.checkUtf8Encoding`, `term.checkAnsiHomePostion`, `term.cp437TermList`, and `term.utf8TermList`. More information on these options is available in [UPGRADE](UPGRADE.md).
* Added a system method to support setting the client encoding from menus, `@systemMethod:setClientEncoding`.
* Many additional backward-compatible bug fixes since the first release of 0.0.12-beta. See the [project repository](https://github.com/NuSkooler/enigma-bbs) for more information.
## 0.0.12-beta

31
docs/_docs/configuration/menu-hjson.md
View File

@ -76,7 +76,7 @@ Menus may also support more than one layout type by using a *MCI key*. A MCI key
For more information on views and associated MCI codes, see [MCI Codes](../art/mci.md).
## Submit Handlers
When a form is submitted, it's data is matched against a *submit handler*. When a match is found, it's *action* is performed.
When a form is submitted, it's data is matched against a *submit handler*. When a match is found, it's *action* is performed. Note: Setting the value explicitly to null matches against any value.
### Submit Actions
Submit actions are declared using the `action` member of a submit handler block. Actions can be kick off system/global or local-to-module methods, launch other menus, etc.
@ -368,7 +368,7 @@ newUserApplicationPre: {
Enigma½ tries to automatically determine the proper encoding for a client when it connects. Unfortunately, there are cases where the wrong encoding can be selected, resulting in terminal programs that are not supported. If your user base contains users that would like to connect with unsupported clients, one solution is to offer manual encoding selection.
A new system method has been added to support this, @systemMethod:setClientEncoding.
This can be accomplished with the system method `@systemMethod:setClientEncoding`.
### Simple example
@ -385,7 +385,6 @@ telnetConnected: {
clientSelectEncoding: {
art: CLTSEL.ASC
next: matrix
config: { interrupt: realtime }
form: {
0: {
mci: {
@ -410,11 +409,7 @@ clientSelectEncoding: {
submit: {
*: [
{
value: { encoding: "utf-8" }
action: @systemMethod:setClientEncoding
}
{
value: { encoding: "cp437" }
value: { encoding: null }
action: @systemMethod:setClientEncoding
}
]
@ -458,9 +453,7 @@ telnetConnected: {
clientSelectUTF8: {
art: CLTSEL.ASC
next: matrix
config: { font: utf-8
interrupt: realtime
}
config: { font: utf-8 }
form: {
0: {
mci: {
@ -486,11 +479,7 @@ clientSelectUTF8: {
submit: {
*: [
{
value: { encoding: "utf-8" }
action: @systemMethod:setClientEncoding
}
{
value: { encoding: "cp437" }
value: { encoding: null }
action: @systemMethod:setClientEncoding
}
]
@ -502,9 +491,7 @@ clientSelectUTF8: {
clientSelectCP437: {
art: CLTSEL.ASC
next: matrix
config: { font: cp437
interrupt: realtime
}
config: { font: cp437 }
form: {
0: {
mci: {
@ -530,11 +517,7 @@ clientSelectCP437: {
submit: {
*: [
{
value: { encoding: "utf-8" }
action: @systemMethod:setClientEncoding
}
{
value: { encoding: "cp437" }
value: { encoding: null }
action: @systemMethod:setClientEncoding
}
]