From d926858aeb7ca4d470dc4cd2ff1511279956e38e Mon Sep 17 00:00:00 2001 From: chrys Date: Mon, 18 Jun 2018 00:22:16 +0200 Subject: [PATCH] fix missing renames --- config/settings/settings.conf.storm | 2 +- docu/fenrir.1 | 16 ++++++++-------- docu/user.md | 16 ++++++++-------- docu/user.txt | 16 ++++++++-------- src/fenrirscreenreader/core/settingsData.py | 4 ++-- tools/fenrir-conf | 2 +- 6 files changed, 28 insertions(+), 28 deletions(-) diff --git a/config/settings/settings.conf.storm b/config/settings/settings.conf.storm index 821a1522..0668ae1a 100644 --- a/config/settings/settings.conf.storm +++ b/config/settings/settings.conf.storm @@ -120,7 +120,7 @@ timeFormat=%H:%M:%P dateFormat="%A, %B %d, %Y" autoSpellCheck=True spellCheckLanguage=en_US -scriptPath=/usr/share/fenrir/scripts +scriptPath=/usr/share/fenrirscreenreader/scripts # overload commands, and create new one without changing Fenrir default commandPath= #fenrirBGColor = the backgroundcolor diff --git a/docu/fenrir.1 b/docu/fenrir.1 index 520360a0..4f2e70e6 100644 --- a/docu/fenrir.1 +++ b/docu/fenrir.1 @@ -234,7 +234,7 @@ this installs Fenrir as the following \f[C] *\ Application:\[aq]\[aq]/opt/fenrir\[aq]\[aq] *\ Settings:\[aq]\[aq]/etc/fenrir\[aq]\[aq] -*\ Sound\ Icons:\[aq]\[aq]/usr/share/fenrir/\[aq]\[aq] +*\ Sound\ Icons:\[aq]\[aq]/usr/share/fenrirscreenreader/\[aq]\[aq] \f[] .fi .PP @@ -2158,7 +2158,7 @@ theme=default By default we ship two sound packs. 1. \[aq]\[aq]default\[aq]\[aq] opus encoded, for newer Sox versions 2. \[aq]\[aq]default\-wav\[aq]\[aq] wav encoded, just for compatibility -Sound packs are located at /usr/share/sounds/fenrir/ +Sound packs are located at /usr/share/sounds/fenrirscreenreader/ .PP Sound volume controls how loud the sounds for your selected sound pack are. @@ -2514,11 +2514,11 @@ The use of the dictionary with spellcheck: spellCheckLanguage=en_US Values: Text, see aspell dictionary\[aq]s. .PP Folder Path for your scripts "scriptKey" functionality: -scriptPath=/usr/share/fenrir/scripts Values: Text, Existing path on file +scriptPath=/usr/share/fenrirscreenreader/scripts Values: Text, Existing path on file system. .PP Override commands or create new ones without changing the Fenrir -defaults: commandPath=/usr/share/fenrir/commands Values: Text, Existing +defaults: commandPath=/usr/share/fenrirscreenreader/commands Values: Text, Existing path on file system. Subfolders in commandPath are: .IP \[bu] 2 @@ -2602,7 +2602,7 @@ Customization .SS Scripting .PP Scripts can be in any language, bash, python, sh or others. -Place your scripts in the directory /usr/share/fenrir/scripts/ (the path +Place your scripts in the directory /usr/share/fenrirscreenreader/scripts/ (the path is configurable in settings.conf). The script key is the applications key. Usually this key can be found on the keyboard located just left of the @@ -2611,7 +2611,7 @@ When you name a script, the key name appears in the script seperated by the sequence \f[B]\-\f[]. So, for example, if you have a python weather script you want assigned to the script key plus the letter w you would name the script -/usr/share/fenrir/scripts/weather__\-__key_w.py Then, to access the +/usr/share/fenrirscreenreader/scripts/weather__\-__key_w.py Then, to access the script, simply press the script key and the letter w. Scripts must be executable. So, make sure to chmod 755 your script when you place it in the scripts @@ -2639,11 +2639,11 @@ T} .PP Script that just speaks the current username when pressing ScriptKey + H.\\ File: -\[aq]\[aq]/usr/share/fenrir/scripts/helloWorld__\-__key_h.sh\[aq]\[aq]: +\[aq]\[aq]/usr/share/fenrirscreenreader/scripts/helloWorld__\-__key_h.sh\[aq]\[aq]: #!/bin/bash echo $1 .SS Commands .PP -You can place your own commands in "/usr/share/fenrir/commands" (path is +You can place your own commands in "/usr/share/fenrirscreenreader/commands" (path is configurable in settings.conf). Commands are python files with a special scheme. You can assign them to a shortcut using the filename without an diff --git a/docu/user.md b/docu/user.md index 60917166..a789dd2d 100644 --- a/docu/user.md +++ b/docu/user.md @@ -224,7 +224,7 @@ this installs Fenrir as the following * Application:''/opt/fenrir'' * Settings:''/etc/fenrir'' - * Sound Icons:''/usr/share/fenrir/'' + * Sound Icons:''/usr/share/fenrirscreenreader/'' to remove Fenrir just run uninstall.sh as root @@ -1044,7 +1044,7 @@ These are the pack of sounds used for sound icons. By default we ship two sound packs. 1. ''default'' opus encoded, for newer Sox versions 2. ''default-wav'' wav encoded, just for compatibility -Sound packs are located at /usr/share/sounds/fenrir/ +Sound packs are located at /usr/share/sounds/fenrirscreenreader/ Sound volume controls how loud the sounds for your selected sound pack are. volume=1.0 @@ -1391,11 +1391,11 @@ The use of the dictionary with spellcheck: Values: Text, see aspell dictionary's. Folder Path for your scripts "scriptKey" functionality: - scriptPath=/usr/share/fenrir/scripts + scriptPath=/usr/share/fenrirscreenreader/scripts Values: Text, Existing path on file system. Override commands or create new ones without changing the Fenrir defaults: - commandPath=/usr/share/fenrir/commands + commandPath=/usr/share/fenrirscreenreader/commands Values: Text, Existing path on file system. Subfolders in commandPath are: @@ -1489,9 +1489,9 @@ Values: on=''True'', off=''False'' # Customization ## Scripting -Scripts can be in any language, bash, python, sh or others. Place your scripts in the directory /usr/share/fenrir/scripts/ (the path is configurable in settings.conf). +Scripts can be in any language, bash, python, sh or others. Place your scripts in the directory /usr/share/fenrirscreenreader/scripts/ (the path is configurable in settings.conf). The script key is the applications key. Usually this key can be found on the keyboard located just left of the right most control key. -When you name a script, the key name appears in the script seperated by the sequence __-__. So, for example, if you have a python weather script you want assigned to the script key plus the letter w you would name the script /usr/share/fenrir/scripts/weather__-__key_w.py +When you name a script, the key name appears in the script seperated by the sequence __-__. So, for example, if you have a python weather script you want assigned to the script key plus the letter w you would name the script /usr/share/fenrirscreenreader/scripts/weather__-__key_w.py Then, to access the script, simply press the script key and the letter w. Scripts must be executable. So, make sure to chmod 755 your script when you place it in the scripts directory. The script gets some parameters from fenrir when it is executed. So that information is available in your script then. @@ -1505,14 +1505,14 @@ The script gets some parameters from fenrir when it is executed. So that informa ### Examples Script that just speaks the current username when pressing ScriptKey + H.\\ -File: ''/usr/share/fenrir/scripts/helloWorld__-__key_h.sh'': +File: ''/usr/share/fenrirscreenreader/scripts/helloWorld__-__key_h.sh'': #!/bin/bash echo $1 ## Commands -You can place your own commands in "/usr/share/fenrir/commands" (path is configurable in settings.conf). +You can place your own commands in "/usr/share/fenrirscreenreader/commands" (path is configurable in settings.conf). Commands are python files with a special scheme. You can assign them to a shortcut using the filename without an extension or place them in a hook trigger like OnInput or OnScreenChange. For further information see developer guide. Good Examples: ["date.py"](https///github.com/chrys87/fenrir/blob/master/src/fenrir/commands/commands/date.py) (announce the Date), ["shut_up.py"](https///github.com/chrys87/fenrir/blob/master/src/fenrir/commands/commands/shut_up.py) (interrupt output) the basic scheme for a command is as follows: diff --git a/docu/user.txt b/docu/user.txt index 5c8e1c60..ce8e7780 100644 --- a/docu/user.txt +++ b/docu/user.txt @@ -177,7 +177,7 @@ For Arch there are PKGBUILDs in the AUR: this installs Fenrir as the following * Application:''/opt/fenrir'' * Settings:''/etc/fenrir'' - * Sound Icons:''/usr/share/fenrir/'' + * Sound Icons:''/usr/share/fenrirscreenreader/'' to remove Fenrir just run uninstall.sh as root @@ -857,7 +857,7 @@ These are the pack of sounds used for sound icons. By default we ship two sound packs. - ''default'' opus encoded, for newer Sox versions - ''default-wav'' wav encoded, just for compatibility -Sound packs are located at /usr/share/sounds/fenrir/ +Sound packs are located at /usr/share/sounds/fenrirscreenreader/ Sound volume controls how loud the sounds for your selected sound pack are. volume=1.0 @@ -1160,11 +1160,11 @@ The use of the dictionary with spellcheck: Values: Text, see aspell dictionary's. Folder Path for your scripts "scriptKey" functionality: - scriptPath=/usr/share/fenrir/scripts + scriptPath=/usr/share/fenrirscreenreader/scripts Values: Text, Existing path on file system. Override commands or create new ones without changing the Fenrir defaults: - commandPath=/usr/share/fenrir/commands + commandPath=/usr/share/fenrirscreenreader/commands Values: Text, Existing path on file system. Subfolders in commandPath are: * ''commands'' = to create shortcut commands @@ -1249,9 +1249,9 @@ Interrupt current speech for time announcement: Values: on=''True'', off=''False'' ====== Customization ====== ===== Scripting ===== -Scripts can be in any language, bash, python, sh or others. Place your scripts in the directory /usr/share/fenrir/scripts/ (the path is configurable in settings.conf). +Scripts can be in any language, bash, python, sh or others. Place your scripts in the directory /usr/share/fenrirscreenreader/scripts/ (the path is configurable in settings.conf). The script key is the applications key. Usually this key can be found on the keyboard located just left of the right most control key. -When you name a script, the key name appears in the script seperated by the sequence __-__. So, for example, if you have a python weather script you want assigned to the script key plus the letter w you would name the script /usr/share/fenrir/scripts/weather__-__key_w.py +When you name a script, the key name appears in the script seperated by the sequence __-__. So, for example, if you have a python weather script you want assigned to the script key plus the letter w you would name the script /usr/share/fenrirscreenreader/scripts/weather__-__key_w.py Then, to access the script, simply press the script key and the letter w. Scripts must be executable. So, make sure to chmod 755 your script when you place it in the scripts directory. The script gets some parameters from fenrir when it is executed. So that information is available in your script then. @@ -1262,13 +1262,13 @@ The script gets some parameters from fenrir when it is executed. So that informa ==== Examples ==== Script that just speaks the current username when pressing ScriptKey + H.\\ -File: ''/usr/share/fenrir/scripts/helloWorld__-__key_h.sh'': +File: ''/usr/share/fenrirscreenreader/scripts/helloWorld__-__key_h.sh'': #!/bin/bash echo $1 ===== Commands ===== -You can place your own commands in "/usr/share/fenrir/commands" (path is configurable in settings.conf). +You can place your own commands in "/usr/share/fenrirscreenreader/commands" (path is configurable in settings.conf). Commands are python files with a special scheme. You can assign them to a shortcut using the filename without an extension or place them in a hook trigger like OnInput or OnScreenChange. For further information see developer guide. Good Examples: [[https://github.com/chrys87/fenrir/blob/master/src/fenrir/commands/commands/date.py|"date.py"]] (announce the Date), [[https://github.com/chrys87/fenrir/blob/master/src/fenrir/commands/commands/shut_up.py|"shut_up.py"]] (interrupt output) the basic scheme for a command is as follows: diff --git a/src/fenrirscreenreader/core/settingsData.py b/src/fenrirscreenreader/core/settingsData.py index a0a38ebe..e3b0d681 100644 --- a/src/fenrirscreenreader/core/settingsData.py +++ b/src/fenrirscreenreader/core/settingsData.py @@ -70,8 +70,8 @@ settingsData = { 'dateFormat': '%A, %B %d, %Y', 'autoSpellCheck': False, 'spellCheckLanguage': 'en_US', - 'scriptPath': '/usr/share/fenrir/scripts', - 'commandPath': '/usr/share/fenrir/commands', + 'scriptPath': '/usr/share/fenrirscreenreader/scripts', + 'commandPath': '/usr/share/fenrirscreenreader/commands', 'attributeFormatString': 'Background fenrirBGColor,Foreground fenrirFGColor,fenrirUnderline,fenrirBold,fenrirBlink, Font fenrirFont,Fontsize fenrirFontSize', 'autoPresentIndent': False, 'hasAttributes': True, diff --git a/tools/fenrir-conf b/tools/fenrir-conf index cdb2a8ff..99b571ac 100644 --- a/tools/fenrir-conf +++ b/tools/fenrir-conf @@ -176,7 +176,7 @@ timeFormat=%H:%M:%P dateFormat=%A, %B %d, %Y autoSpellCheck=True spellCheckLanguage=en_US -scriptPath=/usr/share/fenrir/scripts +scriptPath=/usr/share/fenrirscreenreader/scripts [focus] #follow the text cursor