Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update JAWS settings for LUWRAIN application #5

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update JAWS settings for LUWRAIN application #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions jaws/LICENSE.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (C) 2023 Nikita Tseykovets <[email protected]>

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.
37 changes: 37 additions & 0 deletions jaws/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# JAWS Settings for LUWRAIN Application

Application settings that automatically enable JAWS sleep mode in a window of LUWRAIN self-voicing application.

## Package contents

* help*.html: Help files. There is the main english help.html file, as well as its translations, for example, help_ru.html in Russian.
* install*.vbs: Automatic installation script files. There is the main install.vbs file, as well as its localizers, for example, install_ru.vbs for installation in Russian.
* LICENSE.txt: File with the license text of install*.vbs scripts.
* luwrain*.JCF: JAWS application settings files for LUWRAIN (CONFIG File Type). There is the luwrain.JCF file for the LUWRAIN application running with the embedded JRE, as well as its analogues for the LUWRAIN application running with the locally installed JRE, for example, luwrain-base.JCF if an executable JAR file with the main class is called luwrain-base.jar.
* README.md: This file.
* style.css: A common cascading style sheets file for HTML help files.

## Localizing

To localize the package in new languages, you need to create a new script localizer and translate the help file.
It is advisable to send the created new localizations as a pull request to the upstream repository where this package is located.

### Creating a new script localizer

1. Create a copy of an existing script localizer, for example, the Russian install_ru.vbs script.
2. Name the new script localizer using the target language, for example, install_es.vbs for Spanish. Use commonly understood language designations, such as language codes of the ISO 639.
3. Open the new script localizer file in an editor and translate the string values of all variables whose names begin with "msg" into the target language.
Please note the following:
* It is recommended to save the script localizer file in UTF-16 Little Endian (with BOM) encoding to ensure Unicode support.
* Variables with translatable message strings begin after the comment line "Translatable message strings".
* Above each line of a Variable with translatable message string there is a comment line with the English text of the message.
* The code starting with the RunInstallation() procedure call does not need to be localization. It should be left as is.

### Translation of the help file

1. Create a copy of an existing help file, for example, the main english help.html file.
2. Name the new help file using the target language, for example, help_es.vbs for Spanish. Use commonly understood language designations, such as language codes of the ISO 639.
3. Open the new help file in an editor and translate its contents as a regular document in HTML format.
Please note the following:
* The Help file should be saved in UTF-8 (without BOM) encoding.
* In the lang attribute of the &lt;html&gt; tag, change the value to the target language code according to the ISO 639 standard.
13 changes: 0 additions & 13 deletions jaws/comments.ru.txt
View file
Open in desktop

This file was deleted.

57 changes: 57 additions & 0 deletions jaws/help.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
<!DOCTYPE html>
<!-- Translators: Replace the lang attribute value with the target language code according to ISO 639. See https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes -->
<html lang="en">
<head>
<meta charset="utf-8">
<title>JAWS Settings for LUWRAIN Application</title>
<link rel="stylesheet" type="text/css" media="screen" href="style.css">
</head>
<body>
<h1>JAWS Settings for LUWRAIN Application</h1>
<p>Application settings that automatically enable JAWS sleep mode in a window of LUWRAIN self-voicing application.</p>
<h2>Peculiarities</h2>
<ul>
<li>In the LUWRAIN application window, sleep mode of JAWS is enabled with unloading the synthesizer.</li>
<li>Braille sleep mode of JAWS does not enable, so the braille display keyboard can be used to enter commands and data in the LUWRAIN application window.</li>
<li>The settings are independent of the JAWS language and can therefore be used with any JAWS localization.</li>
<li>The settings support the LUWRAIN application running with both the embedded and locally installed JRE. However, to support a locally installed JRE, it may be necessary to rename the application settings file first. For more information, see "<a href="#options">LUWRAIN run Options Support</a>".</li>
</ul>
<h2>Installation</h2>
<p>The application settings can be added to JAWS manually or automatically.</p>
<p>To add the application settings manually follow these steps:</p>
<ol>
<li>Open the JAWS user settings directory. To do this:
<ol type="A">
<li>Open the Windows Start menu.</li>
<li>Move to the "All Programs" submenu and open it.</li>
<li>Move to the group of used version JAWS and open it.</li>
<li>Move to the "Explore JAWS" group and open it.</li>
<li>Move to "Explore My Settings" item and activate it.</li>
</ol>
Windows Explorer opens with a list of files and folders (for the current user) containing user settings of JAWS.</li>
<li>Copy all luwrain*.JCF files in this package to the JAWS user settings directory.</li>
</ol>
<p>The luwrain.JCF file is for the LUWRAIN application running with the embedded JRE, and the remaining luwrain*.JCF files are for the LUWRAIN application running with the locally installed JRE. However, to support a locally installed JRE, it may be necessary to rename the application settings file first. For more information, see "<a href="#options">LUWRAIN run Options Support</a>".</p>
<p>To add the application settings automatically run the install.vbs script (or one of the script localizers, for example, Russian install_ru.vbs, for installation with messages in the appropriate language). The script will add the application settings to all JAWS versions detected on the system and for all JAWS localization languages.</p>
<p>The automatic installation script is compatible with both windows based and console based script host. For greater automate the installation process without blocking dialog boxes, the main script (or any script localizer) can be run using the CScript script host, for example, with commands:
<blockquote><pre><code>CScript install.vbs //Nologo
CScript install_ru.vbs //Nologo //U</code></pre></blockquote></p>
<h2 id="options">LUWRAIN run Options Support</h2>
<p>The LUWRAIN application can be run in two ways:</p>
<ol>
<li>Running LUWRAIN with the embedded JRE: The recommended default option, which runs luwrain.exe via a shortcut or by directly running the executable file. The settings from the luwrain.JCF file are intended for this run option.</li>
<li>Running LUWRAIN with the locally installed JRE: An option for special needs and advanced users, which an executable JAR file is run using a separately Java Runtime Environment, for example, with a command:
<blockquote><pre><code>javaw -jar jar\luwrain-base.jar</code></pre></blockquote>
The settings from the luwrain-base.JCF file are intended for this run option.<br>
The name of the executable JAR file with the main class may change in different builds of LUWRAIN, so it is necessary to rename the settings file accordingly before installing it. If necessary, you can create several additional settings files (the automatic installation script copies them with wildcards as luwrain*.JCF).</li>
</ol>
<h2>Links</h2>
<ul>
<li><a href="https://luwrain.org/?lang=en" target="_blank">LUWRAIN platform page</a></li>
<li><a href="https://www.freedomscientific.com/products/software/jaws/" target="_blank">JAWS screen reader page</a></li>
<li><a href="https://github.com/luwrain/windows" target="_blank">Repository of the Windows-dependent part of LUWRAIN with this package</a>
<blockquote><pre><code>git clone https://github.com/luwrain/windows.git
cd windows/jaws</code></pre></blockquote></li>
</ul>
</body>
</html>
57 changes: 57 additions & 0 deletions jaws/help_ru.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
<!DOCTYPE html>
<!-- Translators: Replace the lang attribute value with the target language code according to ISO 639. See https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes -->
<html lang="ru">
<head>
<meta charset="utf-8">
<title>Настройки JAWS для приложения LUWRAIN</title>
<link rel="stylesheet" type="text/css" media="screen" href="style.css">
</head>
<body>
<h1>Настройки JAWS для приложения LUWRAIN</h1>
<p>Настройки для приложения, которые автоматически включают спящий режим JAWS в окне самоозвучивающегося приложения LUWRAIN.</p>
<h2>Особенности</h2>
<ul>
<li>В окне приложения LUWRAIN включается спящий режим JAWS с выгрузкой синтезатора.</li>
<li>Спящий режим JAWS для брайля не включается, поэтому клавиатура брайлевского дисплея может использоваться для ввода команд и данных в окне приложения LUWRAIN.</li>
<li>Настройки не зависят от языка JAWS, поэтому могут быть использованы с любой локализацией JAWS.</li>
<li>Настройки поддерживают приложение LUWRAIN, запускаемое как со встроенной, так и с локально установленной JRE. Однако для поддержки локально установленной JRE может потребоваться сперва переименовать файл настроек приложения. Подробнее см. «<a href="#options">Поддержка вариантов запуска LUWRAIN</a>».</li>
</ul>
<h2>Установка</h2>
<p>Настройки для приложения могут быть добавлены в JAWS вручную или автоматически.</p>
<p>Чтобы добавить эти настройки для приложения вручную, выполните следующие действия:</p>
<ol>
<li>Откройте директорию пользовательских настроек JAWS. Для этого:
<ol type="A">
<li>Откройте меню «Пуск» Windows.</li>
<li>Перейдите к подменю «Все программы» и откройте его.</li>
<li>Перейдите к группе используемой версии JAWS и откройте её.</li>
<li>Перейдите к группе «Файлы JAWS» и откройте её.</li>
<li>Перейдите к пункту «Мои настройки» и активируйте его.</li>
</ol>
Откроется Проводник Windows со списком файлов и папок (для текущего пользователя), содержащим пользовательские настройки JAWS.</li>
<li>Скопируйте все файлы luwrain*.JCF из этого пакета в директорию пользовательских настроек JAWS.</li>
</ol>
<p>Файл luwrain.JCF предназначен для приложения LUWRAIN, запускаемого со встроенной JRE, а остальные файлы luwrain*.JCF для приложения LUWRAIN, запускаемого с локально установленной JRE. Однако для поддержки локально установленной JRE может потребоваться сперва переименовать файл настроек приложения. Подробнее см. «<a href="#options">Поддержка вариантов запуска LUWRAIN</a>».</p>
<p>Чтобы добавить эти настройки для приложения автоматически, запустите скрипт install.vbs (или один из локализаторов скрипта, например, русский install_ru.vbs, для установки с сообщениями на соответствующем языке). Скрипт добавит эти настройки для приложения во все обнаруженные в системе версии JAWS и для всех языков локализации JAWS.</p>
<p>Скрипт автоматической установки совместим как с оконным, так и с консольным сервером сценариев. Для большей автоматизации процесса установки без блокирующих диалоговых окон основной скрипт (или любой локализатор скрипта) можно запускать с использованием сервера сценариев CScript, например, командами:
<blockquote><pre><code>CScript install.vbs //Nologo
CScript install_ru.vbs //Nologo //U</code></pre></blockquote></p>
<h2 id="options">Поддержка вариантов запуска LUWRAIN</h2>
<p>Приложение LUWRAIN может быть запущена двумя способами:</p>
<ol>
<li>Запуск LUWRAIN со встроенной JRE: Рекомендуемый вариант по умолчанию, при котором запускается luwrain.exe с помощью ярлыка или путём прямого запуска исполняемого файла. Для этого варианта запуска предназначены настройки из файла luwrain.JCF.</li>
<li>Запуск LUWRAIN с локально установленной JRE: Вариант для особых надобностей и опытных пользователей, при котором запускается исполняемый JAR-файл с использованием отдельной среды выполнения Java, например, командой:
<blockquote><pre><code>javaw -jar jar\luwrain-base.jar</code></pre></blockquote>
Для этого варианта запуска предназначены настройки из файла luwrain-base.JCF.<br>
Название исполняемого JAR-файла с основным классом может меняться в разных сборках LUWRAIN, поэтому требуется соответственно переименовывать и файл настроек перед его установкой. При необходимости можно создать несколько дополнительных файлов настроек (скрипт автоматической установки копирует их с подстановочными знаками как luwrain*.JCF).</li>
</ol>
<h2>Ссылки</h2>
<ul>
<li><a href="https://luwrain.org/?lang=ru" target="_blank">Страница платформы LUWRAIN</a></li>
<li><a href="https://www.freedomscientific.com/products/software/jaws/" target="_blank">Страница программы экранного доступа JAWS</a></li>
<li><a href="https://github.com/luwrain/windows" target="_blank">Репозиторий зависимой от Windows части LUWRAIN с этим пакетом</a>
<blockquote><pre><code>git clone https://github.com/luwrain/windows.git
cd windows/jaws</code></pre></blockquote></li>
</ul>
</body>
</html>
Loading