| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| howto:editor:slyedit [2018/11/12 13:07] – [Getting SlyEdit] nightfox | howto:editor:slyedit [2022/12/16 08:43] (current) – [Configuration with Synchronet] Nightfox |
|---|
| ====== SlyEdit ====== | ====== SlyEdit installation ====== |
| SlyEdit version 1.62 (released on 2018-11-11) is the second full-featured full screen editor for Synchronet, written by ''[[person:nightfox]]'' in JavaScript. SlyEdit can run in one of two styles, to mimic the look & feel of IceEdit or DCT Edit, two popular BBS message editors from the 1990s. The style is specified by a command-line argument. SlyEdit also supports customization of options via a configuration file and colors via theme files.\\ | SlyEdit is the second full-featured full screen editor for Synchronet, written by ''[[person:nightfox]]'' in JavaScript. SlyEdit can run in one of two styles, to mimic the look & feel of IceEdit or DCT Edit, two popular BBS message editors from the 1990s. The style is specified by a command-line argument. SlyEdit also supports customization of options via a configuration file and colors via theme files.\\ |
| \\ | \\ |
| SlyEdit will recognize the user's terminal size and set up the screen accordingly. The width of the edit area will always be 80 characters and support up to 79 characters of text; however, an increased terminal size will provide more room for information to be displayed such as the message area, from/to names, etc. Also, a terminal height greater than the standard 24 or 25 characters will provide a taller edit area, allowing more of the message to be seen on the screen at a time.\\ | The ''[[module:slyedit]]'' module page describes SlyEdit's features and configuration files in more detail. This page discusses SlyEdit's setup with Synchronet. |
| | \\ |
| | SlyEdit will recognize the user's terminal size and set up the screen accordingly.\\ |
| \\ | \\ |
| Thanks go out to all the sysops and users who have reported bugs, made suggestions, and helped test SlyEdit, including the following people: | Thanks go out to all the sysops and users who have reported bugs, made suggestions, and helped test SlyEdit, including the following people: |
| |
| ===== Getting SlyEdit ===== | ===== Getting SlyEdit ===== |
| SlyEdit can be acquired by browsing to the ''[[dev:CVS]]'' and download the SlyEdit .js files from the ''[[dir:exec]]'' directory and the SlyEdit .cfg and SlyEdit_Taglines.txt files from the ''[[dir:ctrl]]'' directory. Place the files in the respective directories in your Synchronet directory tree. | As of Synchronet 3.16, SlyEdit is included with Synchronet. The latest version of SlyEdit can also be acquired by browsing to the [[https://gitlab.synchro.net/main/sbbs/-/tree/master/exec|exec directory]] in the Synchronet ''[[dev:git]]'' repository and download the SlyEdit .js files and the SlyEdit .cfg and SlyEdit_Taglines.txt files from [[https://gitlab.synchro.net/main/sbbs/-/tree/master/ctrl|ctrl]]. Additionally, there is some SlyEdit documentation in text file format in the [[https://gitlab.synchro.net/main/sbbs/-/tree/master/docs|docs directory]]. |
| |
| ===== Installation ===== | ===== Installation ===== |
| Copy the .js files to the ''[[dir:exec]]'' directory and the .cfg files into the ''[[dir:ctrl]]'' directory. If you make any changes to the SlyEdit configuration file (SlyEdit.cfg) or color theme files, it is recommended that you save your modified configuration/theme files to the ''[[dir:mods]]'' directory so that any modifications you make to them won't be accidentally overwritten when updating the Synchronet files from the Synchronet ''[[dev:CVS]]'' repository. | Copy the .js files to the ''[[dir:exec]]'' directory and the .cfg files into the ''[[dir:ctrl]]'' directory. If you make any changes to the SlyEdit configuration file (SlyEdit.cfg) or color theme files, it is recommended that you save your modified configuration/theme files to the ''[[dir:mods]]'' directory so that any modifications you make to them won't be accidentally overwritten when updating the Synchronet files from the Synchronet ''[[dev:git]]'' repository. |
| |
| ===== Configuration with Synchronet ===== | ===== Configuration with Synchronet ===== |
| Make sure any or all of these configurations (as desired) are in [[util:SCFG]]->External Programs->External Editors. | Make sure any or all of these configurations (as desired) are in [[util:SCFG]]->External Programs->External Editors. Note that the ARS requirements string is "ANSI AND COLS 80". This means that the user's terminal must support ANSI and have a width of at least 80 columns. |
| |
| For IceEdit style:\\ | For IceEdit style:\\ |
| Internal Code SLYICE | Internal Code SLYICE |
| Command Line ?slyedit %f ICE | Command Line ?slyedit %f ICE |
| Access Requirements ANSI | Access Requirements ANSI AND COLS 80 |
| Intercept I/O No | Intercept I/O No |
| Native Executable No | Native Executable No |
| Use Shell to Execute No | Use Shell to Execute No |
| Word Wrap Quoted Text Yes | Record Terminal Width Yes |
| | Word Wrap Quoted Text Yes, for terminal width |
| Automatically Quoted Text All | Automatically Quoted Text All |
| Editor Information Files QuickBBS MSGINF/MSGTMP | Editor Information Files QuickBBS MSGINF/MSGTMP |
| Internal Code SLYDCT | Internal Code SLYDCT |
| Command Line ?slyedit %f DCT | Command Line ?slyedit %f DCT |
| Access Requirements ANSI | Access Requirements ANSI AND COLS 80 |
| Intercept I/O No | Intercept I/O No |
| Native Executable No | Native Executable No |
| Use Shell to Execute No | Use Shell to Execute No |
| Word Wrap Quoted Text Yes | Record Terminal Width Yes |
| | Word Wrap Quoted Text Yes, for terminal width |
| Automatically Quoted Text All | Automatically Quoted Text All |
| Editor Information Files QuickBBS MSGINF/MSGTMP | Editor Information Files QuickBBS MSGINF/MSGTMP |
| Internal Code SLYRAND | Internal Code SLYRAND |
| Command Line ?slyedit %f RANDOM | Command Line ?slyedit %f RANDOM |
| Access Requirements ANSI | Access Requirements ANSI AND COLS 80 |
| Intercept I/O No | Intercept I/O No |
| Native Executable No | Native Executable No |
| Use Shell to Execute No | Use Shell to Execute No |
| Word Wrap Quoted Text Yes | Record Terminal Width Yes |
| | Word Wrap Quoted Text Yes, for terminal width |
| Automatically Quoted Text All | Automatically Quoted Text All |
| Editor Information Files QuickBBS MSGINF/MSGTMP | Editor Information Files QuickBBS MSGINF/MSGTMP |
| \\ | \\ |
| |
| Upgrading to version 1.34 | New in version 1.80 |
| | ------------------- |
| | New configuration settings have been added in SlyEdit.cfg: |
| | ^Setting ^ Description^ |
| | | allowColorSelection | Whether or not to let the user change the text color | |
| | | saveColorsAsANSI | Whether or not to save message color/attribute codes as ANSI (if not, they will be saved as Synchronet attribute codes) | |
| | |
| | The TextEditColor setting has been removed from the color theme configuration files. |
| | |
| | New in version 1.71 |
| | ------------------- |
| | There is a new setting in SlyEdit.cfg, allowSpellCheck, which specifies whether the spell check feature is allowed. Valid values are true and false; it defaults to true if not specified. You might want to disable spell check if, for instance, the spell check feature causes an "out of memory" error on your system. |
| | |
| | New in version 1.68 |
| | ------------------- |
| | Each paragraph of text written in a message is now saved as one long line so that they can be wrapped appropriately according to the terminal/reader width (which should work online as well as in offline readers). Also, message uploads are now supported by typing /UPLOAD (or /UL) on a line by itself (the uploaded message will replace any message written into the editor). Also, now honors the SUB_ANON and SUB_AONLY flags for the sub-boards when cross-posting so that the "from" name is "Anonymous" if either of those flags enabled. |
| | |
| | New in version 1.67 |
| | -------------------- |
| | Version 1.67 added the ability to change the message subject. Note that if using a Synchronet 3.17c development build, this requires a build from July 21, 2019 or newer (that build added the ability to use the RESULT.ED file, even if the editor is configured for QuickBBS MSGINF/MSGTMP). |
| | |
| | 1.66 update |
| | ----------------- |
| | For dictionaries with localized spellings, the filenames can have a "-supplemental" at the |
| | end of their name before the extension if they only contain words that are unique to a |
| | particular region that don't exist for all regions. Also, dictionary filenames can just |
| | contain the language without a localization if they contain words common to all regions. |
| | For example: |
| | ^ Filename ^ Description ^ |
| | | dictionary_en.txt | General English dictionary with spellings common to all regions | |
| | | dictionary_en-US-supplemental.txt | English word spellings only specific to the US | |
| | | dictionary_en-US.txt | Full English US dictionary | |
| | |
| | New in 1.64 |
| | ----------------- |
| | Version 1.64 added a spell checker feature. There is a new option for SlyEdit.cfg, |
| | dictionaryFilenames, which is a comma-separated list of filenames. The filenames |
| | are in the format dictionary_<language>.txt, where <language> is the language name. |
| | For dictionaryFilenames, you can also just specify the language names if you want. |
| | The dictionary filenames will be looked for in sbbs/mods, sbbs/ctrl, and then the |
| | directory where SlyEdit.js is located. |
| | |
| | New in version 1.63 |
| | ------------------------- |
| | This version allows using the full width of the terminal for message text. |
| | After upgrading to this version, if you are using a Synchronet build from |
| | April 13th, 2019 or later, ensure that the "Record Terminal Width" setting |
| | in SCFG is enabled for SlyEdit. This helps ensure that Synchronet re-wraps |
| | message text for readers if the author used a different terminal width than |
| | the reader. |
| | |
| | New in version 1.34 |
| ------------------------- | ------------------------- |
| This version includes a new configuration option in SlyEdit.cfg for Ice-style colors (in the [ICE_COLORS] section): menuOptClassicColors. If this option is set to false, then new colors will be used for Ice-style menu options. If this is set to false, then the classic Ice-style menu option colors will be used. | This version includes a new configuration option in SlyEdit.cfg for Ice-style colors (in the [ICE_COLORS] section): menuOptClassicColors. If this option is set to false, then new colors will be used for Ice-style menu options. If this is set to false, then the classic Ice-style menu option colors will be used. |
| |
| Upgrading to version 1.33 | New in version 1.33 |
| ------------------------- | ------------------------- |
| In this version, taglines can now be optionally prefixed with some text and/or surrounded by double quotes. Also, the list of taglines can optionally be shuffled before being displayed to the user. Three new configuration settings have been added in this version to configure these options: | In this version, taglines can now be optionally prefixed with some text and/or surrounded by double quotes. Also, the list of taglines can optionally be shuffled before being displayed to the user. Three new configuration settings have been added in this version to configure these options: |
| | shuffleTaglines | Whether or not to shuffle (randomize) the list of taglines displayed to the user for selection. | | | shuffleTaglines | Whether or not to shuffle (randomize) the list of taglines displayed to the user for selection. | |
| |
| Upgrading to version 1.32 | New in version 1.32 |
| ------------------------- | ------------------------- |
| A new color setting has been added, listBoxItemHighlight, which is used for the currently selected item in a list box. | A new color setting has been added, listBoxItemHighlight, which is used for the currently selected item in a list box. |
| |
| \\ | \\ |
| Upgrading to version 1.29 | New in version 1.29 |
| ------------------------- | ------------------------- |
| A new "text replacements" (AKA macros) feature has been added. This feature lets you (the sysop) define words to be replaced with other text. This feature can be used, for instance, to replace commonly misspelled words with their correct versions or to replace swear words with less offensive words as the user types a message. For more details, see the section regarding text replacements in SlyEdit's readme file. | A new "text replacements" (AKA macros) feature has been added. This feature lets you (the sysop) define words to be replaced with other text. This feature can be used, for instance, to replace commonly misspelled words with their correct versions or to replace swear words with less offensive words as the user types a message. For more details, see the section regarding text replacements in SlyEdit's readme file. |
| |
| \\ | \\ |
| Upgrading to version 1.28 | New in version 1.28 |
| ------------------------- | ------------------------- |
| New general color settings (for both the DCT-style and Ice-style theme files): | New general color settings (for both the DCT-style and Ice-style theme files): |
| |
| \\ | \\ |
| Upgrading to version 1.20 | New in version 1.20 |
| ------------------------- | ------------------------- |
| Version 1.20 added a cross-posting feature, and there is a new configuration setting and some new color settings for cross-posting. Also, starting with version 1.20, you can put your customized SlyEdit configuration file (SlyEdit.cfg) and color theme files in the ''[[dir:mods]]'' directory so that they won't be accidentally overwritten when updating the Synchronet files from the Synchronet ''[[dev:CVS]]'' repository. | Version 1.20 added a cross-posting feature, and there is a new configuration setting and some new color settings for cross-posting. Also, starting with version 1.20, you can put your customized SlyEdit configuration file (SlyEdit.cfg) and color theme files in the ''[[dir:mods]]'' directory so that they won't be accidentally overwritten when updating the Synchronet files from the Synchronet ''[[dev:git]]'' repository. |
| |
| New setting for SlyEdit.cfg: | New setting for SlyEdit.cfg: |
| |
| \\ | \\ |
| Upgrading to version 1.18 | New in version 1.18 |
| ------------------------- | ------------------------- |
| * **Important:** If you use Digital Distortion's Message Lister on your BBS, then you must update Digital Distortion's Message Lister must to at least version 1.36 in order for message quoting with author's initials to work properly when replying to a message from Digital Distortion's Message Lister. The latest version of the Digital Distortion BBS doors & add-ons can be downloaded from the [[http://digdist.synchro.net/DigDistBBSStuff/DigDistBBSStuff.html|Digital Distortion BBS Doors and Tools page]]. | * **Important:** If you use Digital Distortion's Message Lister on your BBS, then you must update Digital Distortion's Message Lister must to at least version 1.36 in order for message quoting with author's initials to work properly when replying to a message from Digital Distortion's Message Lister. The latest version of the Digital Distortion BBS doors & add-ons can be downloaded from the [[http://digdist.synchro.net/DigDistBBSStuff/DigDistBBSStuff.html|Digital Distortion BBS Doors and Tools page]]. |
| |
| \\ | \\ |
| Upgrading to version 1.17 | New in version 1.17 |
| ------------------------- | ------------------------- |
| Starting with version 1.17, when replying to a message, quoted lines from the previous message will be prefixed with the last author's initials by default. If desired, this behavior can be disabled by adding the following line in the [BEHAVIOR] section of SlyEdit.cfg: | Starting with version 1.17, when replying to a message, quoted lines from the previous message will be prefixed with the last author's initials by default. If desired, this behavior can be disabled by adding the following line in the [BEHAVIOR] section of SlyEdit.cfg: |
| |
| \\ | \\ |
| Upgrading to version 1.16 | New in version 1.16 |
| ------------------------- | ------------------------- |
| As of version 1.16, the configuration files may be placed in the ''[[dir:ctrl]]'' directory if desired. This change was made for SlyEdit's inclusion in the Synchronet ''[[dev:CVS]]'' repository. The .js files can be placed anywhere, but for the standard Synchronet installation from the ''[[dev:CVS]]'' repository, the .js files will be in the ''[[dir:exec]]'' directory. | As of version 1.16, the configuration files may be placed in the ''[[dir:ctrl]]'' directory if desired. This change was made for SlyEdit's inclusion in the Synchronet ''[[dev:git]]'' repository. The .js files can be placed anywhere, but for the standard Synchronet installation from the ''[[dev:git]]'' repository, the .js files will be in the ''[[dir:exec]]'' directory. |
| |
| \\ | \\ |
| Upgrading to version 1.15 | New in version 1.15 |
| ------------------------- | ------------------------- |
| In version 1.15, the configuration setting splitLongQuoteLines was removed and replaced with the reWrapQuoteLines setting. Refer to the list of settings above for its description. | In version 1.15, the configuration setting splitLongQuoteLines was removed and replaced with the reWrapQuoteLines setting. Refer to the list of settings above for its description. |
| |
| \\ | \\ |
| Upgrading to version 1.08 | New in version 1.08 |
| ------------------------- | ------------------------- |
| Starting with version 1.08, the "Expand Line Feeds to CRLF" for SlyEdit in SCFG should now be set to Yes. This option enables Synchronet to save messages properly, regardless of whether Synchronet is running in Windows or a *nix system. The SCFG examples above reflect this option. Enabling this option fixes problems with line wrapping that was seen on Linux Synchronet systems when the messages were sent across some networks to other BBSs. Thanks goes to Access Denied, sysop of The Pharcyde, for helping to test this. | Starting with version 1.08, the "Expand Line Feeds to CRLF" for SlyEdit in SCFG should now be set to Yes. This option enables Synchronet to save messages properly, regardless of whether Synchronet is running in Windows or a *nix system. The SCFG examples above reflect this option. Enabling this option fixes problems with line wrapping that was seen on Linux Synchronet systems when the messages were sent across some networks to other BBSs. Thanks goes to Access Denied, sysop of The Pharcyde, for helping to test this. |
| \\ | \\ |
| |
| Upgrading to version 1.07 | New in version 1.07 |
| ------------------------- | ------------------------- |
| Starting with version 1.07, the option "Expand Line Feeds to CRLF" in SCFG should now be set to Yes. Refer to the example configuration near the top of this article. | Starting with version 1.07, the option "Expand Line Feeds to CRLF" in SCFG should now be set to Yes. Refer to the example configuration near the top of this article. |
