diff --git a/docs/SlyEdit_ReadMe.txt b/docs/SlyEdit_ReadMe.txt
index d866e812f94e16d47bf337e88bdccc0ba55c7f71..709bd145456aa6ae2ba5044ecf15b91f1c80df8e 100644
--- a/docs/SlyEdit_ReadMe.txt
+++ b/docs/SlyEdit_ReadMe.txt
@@ -1,6 +1,6 @@
SlyEdit message editor
- Version 1.63
- Release date: 2019-04-18
+ Version 1.64
+ Release date: 2019-05-24
by
@@ -30,6 +30,7 @@ Contents
10. Text replacements (AKA Macros)
11. User settings
12. Taglines
+13. Spell check and dictionaries
1. Disclaimer
@@ -195,6 +196,7 @@ DCT Edit. It also has the following features:
- Sysops can export the current message to a file (on the BBS machine)
- Configuration file with behavior and color settings. See section 4
(Configuration File) for more information.
+- Spell check
The following is a summary of the keyboard shortcuts, from SlyEdit's command
help screen (note that file import, with Ctrl-O & Ctrl-X, are only available to
@@ -204,20 +206,21 @@ BBS machine):
Help keys Slash commands (on blank line)
--------- ------------------------------
Ctrl-G : General help ¦ /A : Abort
-Ctrl-P : Command key help ¦ /S : Save
-Ctrl-R : Program information ¦ /Q : Quote message
+Ctrl-L : Command key list (this list) ¦ /S : Save
+ ¦ /Q : Quote message
Ctrl-T : List text replacements ¦ /T : List text replacements
- ¦ /U : Your settings
+ ¦ /U : Your user settings
+ ¦ /C : Cross-post selection
Command/edit keys
-----------------
Ctrl-A : Abort message ¦ PageUp : Page up
Ctrl-Z : Save message ¦ PageDown: Page down
-Ctrl-Q : Quote message ¦ Ctrl-N : Find text
+Ctrl-Q : Quote message ¦ Ctrl-S : Search for text
Insert/Ctrl-I: Toggle insert/overwrite mode ¦ Ctrl-D : Delete line
-ESC : Command menu
+Ctrl-R : Spell checker ¦ ESC : Command menu
Ctrl-O : Import a file ¦ Ctrl-X : Export to file
-Ctrl-U : Your settings
+Ctrl-U : Your user settings ¦ Ctrl-C : Cross-post selection
5. Digital Distortion Message Lister note
@@ -347,6 +350,18 @@ enableTagLines Whether or not to enable the option for users
setting, which users can configure in their
own settings.
+dictionaryFilenames Dictionary filenames (used for spell check).
+ This is a comma-separated list of dictionary
+ filenames. The dictionary filenames are in
+ the format dictionary_<language>.txt, where
+ <language> is the language name. In this
+ list, the filenames can be in that format, or
+ just <language>.txt, or just <language>.
+ Leave blank to use all dictionary files that
+ exist on the system. The dictionary files
+ are located in either sbbs/mods, sbbs/ctrl,
+ or the same directory as SlyEdit.
+
Ice colors
----------
Setting Description
@@ -762,6 +777,7 @@ replace), you would use $1 to refer to the word "darn". For example, for
Since version 1.32, SlyEdit has the ability for each user to configure some
settings for themselves. The user settings include the following:
- Whether or not to enable the option to use taglines
+- Whether or not to prompt for spell checking when saving a message
- Whether or not to add the original author's initials to quote lines
(this was previously only configurable in SlyEdit.cfg)
- Whether or not to indent quote lines that use author's intials (this was
@@ -777,6 +793,14 @@ settings for themselves. The user settings include the following:
to specify whehter to use only their first name when signing with their
real name, and also whether to sign emails with their real name (emails
don't have a configuration like sub-boards do).
+- Dictionaries for spell-check. If there is only one dictionary configured,
+ this option won't appear on the user options list. If there are multiple
+ dictionary files on the BBS machine (in either sbbs/mods, sbbs/ctrl, or in
+ the same directory as SlyEdit), the user will be able to choose any or all
+ dictionaries to be used for the spell check feature. Multiple dictionaries
+ can be selected, so if the user writes messages in more than one language,
+ or if a message could contain multiple languages, the spell-check feature
+ will use all selected dictionaries for spell checking.
The user settings files will be stored in the sbbs/data/user directory with the
filename <user number>.SlyEdit_Settings, and the user number will be 0-padded
@@ -809,4 +833,32 @@ update in which the full path & filename to the tagline file will be written
to line 7 of the MSGINF drop file, which SlyEdit reads on startup. If the
MSGINF file includes the 7th line, then the tagline will appear after the
user's signature (if they have one). If the MSGINF file does not include the
-7th line, then the tagline will appear before the user's signature.
\ No newline at end of file
+7th line, then the tagline will appear before the user's signature.
+
+13. Spell check and dictionaries
+================================
+Since version 1.64, SlyEdit has a spell check feature. Spell check can be
+started by the user with the Ctrl-R hotkey, or by the Edit > Spell Checker
+option in the DCT-style ESC menu (only available when in DCT mode). For spell
+check, SlyEdit will check each word to see if it exists in the configured
+dictionary/dictionaries, and if not, it will prompt the user for a corrected
+version of the word. The sysop can configure one or multiple dictionaries in
+SlyEdit.cfg with the dictionaryFilenames option. Dictionary files need to be
+in the format dictionary_<languageName>.txt, where <languageName> is the name
+of the language - For instance, dictionary_english.txt for English. Also, the
+dictionary filenames will be parsed and the language name will be used in the
+menu of dictionaries in the user options - The user is able to enable/disable
+the configured dictionaries for their own use for the spell checker.
+
+For the dictionaryFilenames option in SlyEdit.cfg, you can specify a comma-
+separated list of dictionary filenames. The dictionary filenames are in the
+format dictionary_<languageName>.txt, where <language> is the language name.
+In this list, the filenames can be in that format, or just <languageName>.txt,
+or just <languageName>. You can leave the setting blank to use all dictionary
+files that exist on the system.
+
+SlyEdit will search for the dictionary files in the following directories, in
+this order:
+1. sbbs/mods
+2. sbbs/ctrl
+3. SlyEdit's own directory
\ No newline at end of file