migrate docs to docsify

dictation-toolbox · Dec 12, 2023 · 213ba0c · 213ba0c
1 parent ae3dd1b
commit 213ba0c
Show file tree

Hide file tree

Showing 62 changed files with 187 additions and 281 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
diff --git a/Run_Caster_DNS.bat b/Run_Caster_DNS.bat
diff --git a/CasterQuickReference.pdf → docs/.nojekyll b/CasterQuickReference.pdf → docs/.nojekyll
diff --git a/docs/CasterQuickReference.pdf b/docs/CasterQuickReference.pdf
diff --git a/docs/readthedocs/Caster_Commands/Alias.md → docs/Caster_Commands/Alias.md b/docs/readthedocs/Caster_Commands/Alias.md → docs/Caster_Commands/Alias.md
diff --git a/...s/Application_Commands_Quick_Reference.md → ...s/Application_Commands_Quick_Reference.md b/...s/Application_Commands_Quick_Reference.md → ...s/Application_Commands_Quick_Reference.md
diff --git a/docs/readthedocs/Caster_Commands/Bringme.md → docs/Caster_Commands/Bringme.md b/docs/readthedocs/Caster_Commands/Bringme.md → docs/Caster_Commands/Bringme.md
diff --git a/...Commands/CCR_languages_Quick_Reference.md → ...Commands/CCR_languages_Quick_Reference.md b/...Commands/CCR_languages_Quick_Reference.md → ...Commands/CCR_languages_Quick_Reference.md
diff --git a/...s/Caster_Commands/CasterQuickReference.md → docs/Caster_Commands/CasterQuickReference.md b/...s/Caster_Commands/CasterQuickReference.md → docs/Caster_Commands/CasterQuickReference.md
@@ -1,8 +1,15 @@
 # Caster Quick Reference
+
 [Caster Quick Reference](https://github.com/dictation-toolbox/Caster/blob/master/CasterQuickReference.pdf) with universal commands for navigation and editing.
 
 These commands are active all the time and provide input commands for letters, numbers, and punctuation, as well as the ability to easily manipulate windows and text. A few examples from the document are: 
 
 - `window right` moves the active window to the right-hand side of the screen.
 - `prekris` inserts a pair of brackets `()` and moves the cursor inside them.
 - `shackle` selects the current line.
+
+
+
+  ```pdf
+  CasterQuickReference.pdf
+  ```
diff --git a/docs/readthedocs/Caster_Commands/Keyboard.md → docs/Caster_Commands/Keyboard.md b/docs/readthedocs/Caster_Commands/Keyboard.md → docs/Caster_Commands/Keyboard.md
diff --git a/docs/readthedocs/Caster_Commands/Mouse.md → docs/Caster_Commands/Mouse.md b/docs/readthedocs/Caster_Commands/Mouse.md → docs/Caster_Commands/Mouse.md
diff --git a/...dthedocs/Caster_Commands/Record_Macros.md → docs/Caster_Commands/Record_Macros.md b/...dthedocs/Caster_Commands/Record_Macros.md → docs/Caster_Commands/Record_Macros.md
diff --git a/...docs/Caster_Commands/Text_Manipulation.md → docs/Caster_Commands/Text_Manipulation.md b/...docs/Caster_Commands/Text_Manipulation.md → docs/Caster_Commands/Text_Manipulation.md
diff --git a/...s/Caster_Commands/Using_Voice_Commands.md → docs/Caster_Commands/Using_Voice_Commands.md b/...s/Caster_Commands/Using_Voice_Commands.md → docs/Caster_Commands/Using_Voice_Commands.md
diff --git a/...edocs/Caster_Settings/companion_config.md → docs/Caster_Settings/companion_config.md b/...edocs/Caster_Settings/companion_config.md → docs/Caster_Settings/companion_config.md
diff --git a/docs/readthedocs/Caster_Settings/hooks.md → docs/Caster_Settings/hooks.md b/docs/readthedocs/Caster_Settings/hooks.md → docs/Caster_Settings/hooks.md
diff --git a/docs/readthedocs/Caster_Settings/rules.md → docs/Caster_Settings/rules.md b/docs/readthedocs/Caster_Settings/rules.md → docs/Caster_Settings/rules.md
diff --git a/docs/readthedocs/Caster_Settings/settings.md → docs/Caster_Settings/settings.md b/docs/readthedocs/Caster_Settings/settings.md → docs/Caster_Settings/settings.md
diff --git a/...adthedocs/Caster_Settings/transformers.md → docs/Caster_Settings/transformers.md b/...adthedocs/Caster_Settings/transformers.md → docs/Caster_Settings/transformers.md
diff --git a/...omize_Caster/Creating_Hooks_and_Events.md → ...omize_Caster/Creating_Hooks_and_Events.md b/...omize_Caster/Creating_Hooks_and_Events.md → ...omize_Caster/Creating_Hooks_and_Events.md
@@ -2,7 +2,7 @@
 
 Hooks are a new concept to Caster 1.x.x. The basic idea is that Caster itself defines "events." Event objects contain immutable information about the stuff going on in the "guts" of Caster. Those objects are fed to "hooks", user-defined listeners, which can do whatever they want with that event data.  
 
-Hooks and Events make use of dependency injection and class inheritance through base classes. This design pattern coupled with loosely coupled code leads to less bugs and more productivity, and so the use of hooks rather than "guts" modifications is encouraged whenever possible. This should allow a decent amount of customization to happen without needing to make changes in the "guts" (Nexus, GrammarManager, CCRMerger, etc. of Caster. 
+Hooks and Events make use of dependency injection and class inheritance through base classes. This design pattern coupled with loosely coupled code leads to less bugs and more productivity, and so the use of hooks rather than "guts" modifications is encouraged whenever possible. This should allow a decent amount of customization to happen without needing to make changes in the "guts" (Nexus, GrammarManager, CCRMerger, etc. of Caster). 
 
 All new hooks are set to `false` by default unless they' are defined as defaults in `settings.py`  under `default_hooks`. 
 

diff --git a/...omize_Caster/Customizing_Starter_Rules.md → ...omize_Caster/Customizing_Starter_Rules.md b/...omize_Caster/Customizing_Starter_Rules.md → ...omize_Caster/Customizing_Starter_Rules.md
diff --git a/...ting_Started/Choose_Recognition_Engine.md → ...ting_Started/Choose_Recognition_Engine.md b/...ting_Started/Choose_Recognition_Engine.md → ...ting_Started/Choose_Recognition_Engine.md
@@ -1,6 +1,6 @@
 # Choose a Speech Recognition Engine
 
-Caster currently supports the following speech recognition engines on Microsoft Windows Vista through Windows 10. This is a brief overview of the supported speech recognition engines.
+Caster currently supports the following speech recognition engines on Microsoft Windows 10 through Windows 11. This is a brief overview of the supported speech recognition engines. Windows Vista and Windows 8 may work but are no longer supported.
 
 ## Dragon NaturallySpeaking
 

diff --git a/...tting_Started/Getting_Started_Overview.md → ...tting_Started/Getting_Started_Overview.md b/...tting_Started/Getting_Started_Overview.md → ...tting_Started/Getting_Started_Overview.md
diff --git a/..._to_Speak_Code/How_to_Speak_Code_Intro.md → ..._to_Speak_Code/How_to_Speak_Code_Intro.md b/..._to_Speak_Code/How_to_Speak_Code_Intro.md → ..._to_Speak_Code/How_to_Speak_Code_Intro.md
diff --git a/...ed/How_to_Speak_Code/Speaking/Examples.md → ...ed/How_to_Speak_Code/Speaking/Examples.md b/...ed/How_to_Speak_Code/Speaking/Examples.md → ...ed/How_to_Speak_Code/Speaking/Examples.md
diff --git a/...s/Installation/Troubleshooting_Install.md → docs/Installation/Troubleshooting_Install.md b/...s/Installation/Troubleshooting_Install.md → docs/Installation/Troubleshooting_Install.md
@@ -4,7 +4,7 @@ In the previous install documentation, each speech recognition engine has its ow
 
 ## Caster
 
-On startup Caster checks for missing python dependencies.    When a dependency is missing, Caster will print out the appropriate commands to the status window for the end-user to fix the issue in command prompt/terminal.
+On startup Caster checks for missing python dependencies. When a dependency is missing, Caster will print out the appropriate commands to the status window for the end-user to fix the issue in command prompt/terminal.
 
 - To fix `ERROR:action.exec:Execution failed: Function(mouse_alternates): [Error 126] The specified module could not be found`. Triggered by using the `Legion` command.
 
@@ -20,8 +20,7 @@ Please raise an issue if you find Legion still doesn't work on Windows 10 after
     - [Proof of Concept](https://github.com/dictation-toolbox/dragonfly/issues/11) work around but the project needs an active developer with C#. This allows Caster and Dragonfly to only elevate specific functionality that is necessary such as Key/Text actions and application context details.
     - Advanced [Workaround](https://groups.google.com/g/dragonflyspeech/c/2VrJKBI2mSo/m/R4zl6u2mBwAJ) - Editing natlink.exe with hex editor and re-signing with self signed certificate - **Use at your own risk!** Instructions note disadvantages.
 
-- Fix `TypeError: command must be a non-empty string, not ['C:\\Python27\\Scripts\\pip.exe', 'search', 'castervoice']`
-
+- Fix `TypeError: command must be a non-empty string, not ['C:\\Python27\\Scripts\\pip.exe', 'search', 'castervoice'`
     - Update Dragonfly `python -m pip install dragonfly2 --upgrade` in command prompt
 
 - To fix `ImportError: No module named win32con`

diff --git a/docs/Installation/Windows/Dragon_NaturallySpeaking.md b/docs/Installation/Windows/Dragon_NaturallySpeaking.md
@@ -0,0 +1,73 @@
+# Dragon NaturallySpeaking Install
+
+**Install Dragon NaturallySpeaking** (DPI / DNS)- Caster only supports Dragon NaturallySpeaking v13-v16 and Windows 10 or higher. Natlink v16 is beta in Natlink.
+
+After installing Dragon, you can configure the DNS settings based on your preference.
+
+- Disabling the DNS Browser plug-ins due to instability of Internet browsers and DNS is recommended.
+- Disable all the checkboxes in the “Correction” menu, except for the “Automatically add words to the active vocabulary” option.
+    - Under the “Commands” menu check the “Require click to select…” checkboxes.  Otherwise you will find yourself accidentally clicking buttons or menu items instead of inserting text into your editor. I’ve disabled the other checkboxes in that menu as well.
+- Set the “speed versus accuracy” slider in the “Miscellaneous” menu to a fairly high value.
+- Uncheck the “Use the dictation box for unsupported applications” checkbox.
+
+### Preinstall Natlink requirements
+
+- DPI 16, 15, 14, 13 or derivative of the same version
+- Download and install  [**Python 3.10.X 32 bit**](https://www.python.org/downloads/release/python-3810/) as `Windows x86 MSI installer` and **Optionally** select **add Python to Path**.
+- Make sure any previous versions of Natlink are unregistered and uninstalled. (Dragon must be close during that process)
+
+### Caster
+
+1. Download Caster from the [master branch](https://github.com/dictation-toolbox/Caster/archive/master.zip).
+2. Open up the zip file downloaded
+3. Copy the contents of `Caster-master` folder. You can put it anywhere but it is common to use `%USERPROFILE%\Documents\Caster`.
+4. Install dependencies and set up Natlink by running `Caster/Install_Caster_DNS-WSR.bat`. 
+5. *Optional Step* for Caster's`Legion` MouseGrid - Legion Feature available on Windows 10 and above
+    - The Legion MouseGrid requires [Microsoft Visual C++ Redistributable Packages for Visual Studio 2015, 2017 and 2019 (x86).](https://support.microsoft.com/en-nz/help/2977003/the-latest-supported-visual-c-downloads) 
+
+### Install Natlink
+
+1. Download the latest [Natlink](https://github.com/dictation-toolbox/natlink/releases)
+
+   - Python 3.10.X 32 bit is required. (if you don't have Python 3.10 installed Natlink Installer will install it off path for you automatically)
+   - Do not uncheck the default `Py Launcher`
+
+2. Run the Natlink Installer and a GUI should pop up at the end.
+
+   - Note: After install natlink can be reconfigured Using `Configure Natlink via CLI` Natlink start menu.
+   - **Optionally** install other Python packages via commandline with Natlink's python interpreter utilizing `Natlink Python Environment` 
+
+3. Configure the Natlink GUI
+
+   ![natlink_gui](/images/natlink_gui.png)
+
+   - **Optionally** Check the relevant project Dragonfly or Unimacro to configure the file path to the grammars.
+
+4. Start Dragon start Dragon, the `Messages from Natlink` window should show loading a dragonfly script.  In the picture blow is an example loading module`_caster` is `_caster.py`.
+
+   ![natlink_running](/images/natlink_running.png)
+
+Scrips starting with an underscore and ending in .py `_*.py` will be imported in alphabetical order, except `__init__.py` will be loaded first if it exists. 
+
+### Update Caster
+
+1. Backup `%USERPROFILE%\Documents\Caster`
+2. Delete `%USERPROFILE%\Documents\Caster`
+3. Repeat Steps `1.- 4.` within the Caster install section
+
+### Natlink FAQ
+
+1. Cannot load compatibility module support `(GUID = {dd990001-bb89-1d2-b031-0060088dc929}))` aka  **natlink.pyd**
+    - Natlink failed to load go to https://github.com/dictation-toolbox/natlink for support.
+
+#### How do I reconfigure Natlink after installation?
+
+- After install natlink can be reconfigured Using `Configure Natlink via GUI` or `Configure Natlink via CLI` Natlink start menu.
+
+#### How can I install other Python packages with Natlink?
+
+- Natlink requires a specific Python interpreter. You can access the Python environment via `Natlink Python Environment` from the natlink start menu
+
+#### Where are natlink configuration files located?
+
+- The natlinkconfig_gui or natlinkconfig_cli creates configuration files in`%UserProfile%\.natlink` as `natlink.ini`.
diff --git a/...ocs/Installation/Windows/Kaldi_Windows.md → docs/Installation/Windows/Kaldi_Windows.md b/...ocs/Installation/Windows/Kaldi_Windows.md → docs/Installation/Windows/Kaldi_Windows.md
diff --git a/...ion/Windows/Windows_Speech_Recognition.md → ...ion/Windows/Windows_Speech_Recognition.md b/...ion/Windows/Windows_Speech_Recognition.md → ...ion/Windows/Windows_Speech_Recognition.md
@@ -5,8 +5,7 @@ Caster currently supports Windows Speech Recognition (WSR) on Microsoft Windows
 ## 1. Python
 
 - **First** Download and install  [Python 3](https://www.python.org/downloads/release/python-388/) listed as `Windows x86-64 MSI installer`.`
-
-      - Make sure to select `Add python to path`. This can be done manually by searching for "edit environment variables for your account" and adding your Python folder to the list of Path values.
+   - Make sure to select `Add python to path`. This can be done manually by searching for "edit environment variables for your account" and adding your Python folder to the list of Path values.
 
 ## 2. Caster
 

diff --git a/docs/LICENSE.md b/docs/LICENSE.md
diff --git a/docs/README.md b/docs/README.md
@@ -7,8 +7,7 @@
 
   - [Caster voice coding: Advent of Code 2018](https://youtu.be/oDsMGroASSw?t=3) - Programming with Go
   - [VimGolf and Project Euler](https://www.youtube.com/watch?v=T1bKAqDhH_E)
-  - [Dictating maths into scientific notebook](https://www.youtube.com/watch?v=oq8EoPu0cGY&t=3s) and [Dictating math by voice using Caster](https://www.youtube.com/watch?v=z-iHvPmjcas)
-
+
 - Read the [Frequently Asked Questions - FAQ](https://caster.readthedocs.io/en/latest/readthedocs/meta/Caster_FAQ/)
 
 - [Getting started with Caster - ReadTheDocs](https://caster.readthedocs.io/en/latest/readthedocs/Getting_Started/Getting_Started_Overview/)
@@ -43,7 +42,7 @@
 
 - The [DictationToolbox.org](https://dictation-toolbox.github.io/dictation-toolbox.org/) (WIP) is a curated webpage of information related to voice programming and accessibility. Content Includes: User Tips, Hardware, Videos, Blogs, Repositories, Presentations, and etc. Pull requests welcome!
 
-## Feature List
+## Feature List <!-- {docsify-ignore} -->
 
 - Configurable [Settings](https://caster.readthedocs.io/en/latest/readthedocs/User_Dir/Caster_User_Dir/)
 

diff --git a/...n/Advanced_Caster_Rules/Advanced_Rules.md → ...n/Advanced_Caster_Rules/Advanced_Rules.md b/...n/Advanced_Caster_Rules/Advanced_Rules.md → ...n/Advanced_Caster_Rules/Advanced_Rules.md
diff --git a/...Construction/Advanced_Caster_Rules/CCR.md → ...Construction/Advanced_Caster_Rules/CCR.md b/...Construction/Advanced_Caster_Rules/CCR.md → ...Construction/Advanced_Caster_Rules/CCR.md
diff --git a/...ion/Advanced_Caster_Rules/ContextStack.md → ...ion/Advanced_Caster_Rules/ContextStack.md b/...ion/Advanced_Caster_Rules/ContextStack.md → ...ion/Advanced_Caster_Rules/ContextStack.md
diff --git a/...ruction/Advanced_Caster_Rules/NodeRule.md → ...ruction/Advanced_Caster_Rules/NodeRule.md b/...ruction/Advanced_Caster_Rules/NodeRule.md → ...ruction/Advanced_Caster_Rules/NodeRule.md
diff --git a/...ruction/Basic_Caster_Rules/Basic_Rules.md → ...ruction/Basic_Caster_Rules/Basic_Rules.md b/...ruction/Basic_Caster_Rules/Basic_Rules.md → ...ruction/Basic_Caster_Rules/Basic_Rules.md
diff --git a/...ion/Basic_Caster_Rules/Your_First_Rule.md → ...ion/Basic_Caster_Rules/Your_First_Rule.md b/...ion/Basic_Caster_Rules/Your_First_Rule.md → ...ion/Basic_Caster_Rules/Your_First_Rule.md
diff --git a/...truction/Intro_Into_Rules_and_Grammars.md → ...truction/Intro_Into_Rules_and_Grammars.md b/...truction/Intro_Into_Rules_and_Grammars.md → ...truction/Intro_Into_Rules_and_Grammars.md
diff --git a/...hedocs/Rule_Construction/Loading_Rules.md → docs/Rule_Construction/Loading_Rules.md b/...hedocs/Rule_Construction/Loading_Rules.md → docs/Rule_Construction/Loading_Rules.md
diff --git a/...uction/Migrating_From_Dragonfly-Caster.md → ...uction/Migrating_From_Dragonfly-Caster.md b/...uction/Migrating_From_Dragonfly-Caster.md → ...uction/Migrating_From_Dragonfly-Caster.md
diff --git a/...s/Rule_Construction/Taxonomy_of_a_Rule.md → docs/Rule_Construction/Taxonomy_of_a_Rule.md b/...s/Rule_Construction/Taxonomy_of_a_Rule.md → docs/Rule_Construction/Taxonomy_of_a_Rule.md
diff --git a/...thedocs/Third-party_Integrations/Aenea.md → docs/Third-party_Integrations/Aenea.md b/...thedocs/Third-party_Integrations/Aenea.md → docs/Third-party_Integrations/Aenea.md
diff --git a/...hedocs/Third-party_Integrations/Sikuli.md → docs/Third-party_Integrations/Sikuli.md b/...hedocs/Third-party_Integrations/Sikuli.md → docs/Third-party_Integrations/Sikuli.md
diff --git a/docs/readthedocs/User_Dir/Caster_User_Dir.md → docs/User_Dir/Caster_User_Dir.md b/docs/readthedocs/User_Dir/Caster_User_Dir.md → docs/User_Dir/Caster_User_Dir.md
diff --git a/docs/_config.yml b/docs/_config.yml