Copyright 2024 Brad Neil (http://friedorange.xyz/)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Overview

QSTL performs a word-for-word swap, according to the chosen dictionary. If the input text contains words that are not found in the dictionary, you will be prompted to define them. Definitions may specify two possible outputs for a given word; you will be prompted to choose between these after every word has been defined.

As QSTL is designed to operate offline, you must have a Unicode Quikscript font installed in order to use it.

Usage

1. Choose a dictionary file (CSV format where each line contains a definition of the form: EXAMPLE,)
2. Choose an input text file (plain text only; no PDF, web-page or word-processing formats allowed)
3. Enter the Quikscript spellings for any undefined words, as prompted*
4. Choose the appropriate form of each homograph, as prompted (see the footnote)
5. Click Save output as... to save the transliterated text
6. Don't forget to click Show dictionary and then Save output as... to save your new dictionary definitions.
   HINT: this step can be performed at any time, allowing you to work across multiple sessions

*For homographs (words with the same conventional spelling, but different pronunciations), separate the two Quikscript spellings with a vertical bar character "|". For example, you could define "READ" as "|".

WARNING: Loading an input file or dictionary restarts the entire process. Clicking Transliterate text restarts the homograph selection stage, if it was in progress.

Details

• The Transliterate text button forces the transliteration to occur at any time, skipping any undefined words and leaving any homographs in limbo. Partially transliterated texts are acceptable input to QSTL, as it does not attempt to transliterate existing Quikscript text.
• The Create dictionary template button places a template for the required dictionary definitions in the output box. You can save this and use your favourite spreadsheet application or text editor to edit it and combine it with another dictionary.
• The Show dictionary button places the current dictionary, including any new definitions, in the output box. If you wish to manually edit the dictionary: make changes in the output box as desired, then click Save output as... and reload the dictionary with that file.
• The Save output as... button captures the contents of the output box and initiates your browser's download interface, allowing you to save it to a file. The default filename depends on the last thing that was placed in the output box.
• The Undo button backtracks through your history of entered definitions (during the current session), allowing you to fix any mistakes without manually editing the dictionary. Currently, this is not implemented for homograph choices.

NOTE: if the dictionary contains multiple entries for the same word, the last definition will override any previous ones.