The Equalize Editor Users Guide

Table of Contents

Keyboard Input

The EE supports keyboard input from a standard computer keyboard or from a refreshable braille keyboard. These devices input keyboard characters and braille symbols using three major keyboard input modes provided by the EE, with specific input methods for special kinds of characters.

Input Modes

The EE provides three major keyboard input modes to support text and math entry using both computer and braille keyboards. One of these three keyboard input modes is always in effect, and interprets keyboard events received by the EE.

Special keystrokes change the keyboard input mode. They may be entered from either a computer or braille keyboard, and are examples of control characters supported by the EE.

The following control characters may be entered on a standard computer keyboard (using the Control key), or on any braille keyboard that provides a way to type control characters. These keystrokes may be entered from any keyboard input mode.

The EE supports the sequence == to enter a control character, to support braille keyboards that may not provide a way to type control characters.

Typing dots-123456 on a braille keyboard enters the = key, so the EE also supports dots-123456 dots-123456 as a way to type control characters.

The EE supports the sequence === to switch from Braille input mode to Qwerty input mode, or from any other input mode to Braille input mode. On a braille keyboard, typing dots-123456 three times has the same effect.

Switching to Braille input mode on a standard computer keyboard simulates a refreshable braille keyboard, by typing computer braille symbols that correspond to the desired braille signs.

The current keyboard input mode may also be changed on the Settings Page, and persists when you revisit the EE web application.

Control Keys

The EE supports operations normally activated with a control key combination. While these keys are easy to type from a computer keyboard, they are often less convenient to type from a braille keyboard.

To make these operations easier to type from a braille keyboard, the EE treats the sequence dots-123456 dots-123456 followed by a letter as equivalent to the corresponding control character.

Here are the control characters supported by the EE.

Menu Keys

The EE application menus support access keys for keyboard menu navigation.

The File Menu, Drive Menu, Edit Menu, and Help Menu may be accessed using the access keys Alt Shift F, Alt Shift D, Alt Shift E, and Alt Shift H, respectively. Accessing a menu opens a drop-down list of the menu items for that menu. These menu items may be navigated using the Up and Down arrow keys, or using the access keys for menu items that define them. Menu items that define access keys may also be activated using Alt Shift plus the access key, without having to access the parent menu.

Here are the access keys defined by the EE application menus.

Focus Word

The EE tracks the keyboard input focus word, that is, the literary braille word that contains the insertion point. The Unicode characters that are considered word separators are space U+0020, hyphen U+002D, dash U+2013, and long dash U+2014, and variations of these characters U+2010-U+2015. These word separators define the boundaries between words used to determine the characters contained in the focus word.

The focus word changes as you enter text or move the insertion point. When a word gains the input focus, the EE displays the uncontracted braille for the word, which you may then modify using contracted or uncontracted braille. When a word loses the input focus, the EE translates the word back into contracted form to be included in the braille output.

When a word gains the input focus, the EE will insert the uncontracted braille into the visual document as needed to allow the user to modify the focus word in uncontracted form. When a word loses the input focus, the EE will process any contracted and/or uncontracted braille input as needed to construct the contracted form of the focus word, and to update the visual form of the focus word for insertion into the document.

The focus word is only used in this way for literary text, not for math expressions.

Braille Input

The EE supports braille input according to the Rules of UEB, Second Edition, 2013. The following sections provide additional information for special kinds of braille symbols and Unicode characters, and how they are handled in the EE.

Hyphens/Dashes

The EE recognizes hyphen (as dots-36), dash (as dots-6 dots-36), and long dash (as dots-5 dots-6 dots-36), underscore (as dots-46 dots-36), and macron (as dots-4 dots-36). The EE recognizes space, hyphen, and dash as characters that mark word boundaries.

Within literary text, these characters are represented by:

The EE translates hyphens (U+002D, U+2010, and U+2011) to dots-36, shorter dashes (U+2012 and U+2013) to dots-6 dots-36 and longer dashes (U+2014 and U+2015) to dots-5 dots-6 dots-36. The EE back-translates hyphen to U+002D, dash to U+2013, and long dash to U+2014.

Numeric Mode

The EE supports the numeric indicators (digits, decimal point, numeric comma) in numeric mode within literary text.

The EE recognizes a numeral, or a decimal point or numeric comma followed by a numeral, as the start of numeric mode in literary text. The EE recognizes a numeral, a decimal point, a numeric comma, or a numeric space followed by a numeral, as a continuation of numeric mode in literary text.

The EE recognizes a numeric fraction line as a continuation of numeric mode in literary text.

The EE back-translates a simple fraction to the corresponding single-character Unicode vulgar fraction symbol when it is available. The EE translates a numeric mode sequence that contains more than one numeric fraction line as separate numeric instances, and translates each numeric fraction line into a textual fraction line.

The EE treats a space in literary text between two numerals as a numeric space. In all other cases, the space or any non-numeric mode symbol terminates numeric mode.

The EE includes a decimal point or numeric comma within the numeric mode indicator when it is followed by a numeral at the start of a word.

Vulgar Fractions

The EE recognizes Unicode characters used to represent a vulgar fraction, that is, a single character that includes both a single-digit numerator and a single-digit denominator separated by a short diagonal slash.

The EE supports the translation of Unicode vulgar fraction characters into Braille numeric fractions, and back-translates these numeric fractions using the Unicode vulgar fraction characters where available.

The following vulgar fraction characters are supported by the EE:

Quotation Marks

The EE recognizes the one-cell quotation marks (dots-236 and dots-356), as well as the following collection of quotation mark characters used in literary text:

The EE follows the characters used in the literary text, with the exception that the non-directional quotation mark (U+0022) is translated into the one-cell open quotation mark (as dots-236) within the initial punctuation before a word, and into the one-cell close quotation mark (as dots-356) within the final punctuation after a word.

On back translation, the EE translates the one-cell quotation marks into the non-directional quotation mark (U+0022).

Letter Modifiers

The EE supports the following combining characters as braille letter modifiers.

The EE supports the following combining characters as additional braille letter modifiers.

These combining characters are designed to be used in combination with a base character.

The EE supports the use of these braille modifiers in combination with a base character, and will back-translate these combinations to a single-character Unicode equivalent when one is defined, or to a two-character Unicode sequence consisting of the spacing version of the modifier, followed by the base-character.

Spacing Modifiers

The EE supports spacing characters equivalent to combining characters where they are defined.

These characters are designed to be used in isolation without a base character.

The EE back-translates macron (dots-4 dots-36) as U+00AF MACRON.

The EE back-translates acute (dots-45 dots-34) as U+00B4 ACUTE ACCENT.

Math Equations

The EE supports entering equations using the Nemeth Braille Code for Mathematics and Science Notation, 1972 Revision. Typical printed math typography uses three main forms to arrange math within text documents.

Inline Math

An inline math expression is one that stands within the text of a paragraph, typeset along the existing baseline for the surrounding text.

A user can create an inline math expression within paragraph text by typing Ctrl-m to begin the math expression, and Ctrl-Shift-m to end the expression. The open Nemeth indicator dots-456 dots-146 can likewise be used to begin an inline math expression, and the close Nemeth indicator dots-456 dots-156 can be used to end the expression.

An inline math expression does not supply space characters before or after the expression, but they can be typed before or after the inline math expression as usual to create spaces in the braille output.

Display Math

A display math expression is one that stands between paragraphs in a document, typeset along its own baseline, and separated from the surrounding text by blank space. It is also often centered within the margins of the document.

A user can create a display math expression between paragraphs by typing Ctrl-Alt-m to begin the math expression, and Ctrl-Shift-m to end the expression. The open Nemeth indicator, preceded by an extra dots-456 indicator dots-456 dots-456 dots-146 can likewise be used to begin a display math expression, and the close Nemeth indicator after an extra dots-456 indicator dots-456 dots-456 dots-156 can be used to end the expression.

A display math expression does not supply newline characters before or after the expression, but they can be typed before or after the display math expression as usual to create new lines in the braille output.

Multi-Line Math

A multi-line math expression is one that includes a sequence of math expressions taken as a group, each with its own baseline, separated from the surrounding text by blank space, with the expressions aligned in a meaningful way with respect to each other.

A user can type Ctrl-m or the open Nemeth indicator dots-456 dots-146 to create an inline math expression, then press Ctrl-Enter to convert the inline math expression into a multi-line math expression, which will be a vertical list containing inline math expressions.

A user can type Ctrl-Alt-m or the open Nemeth indicator dots-6 dots-456 dots-146 to create a display math expression, then press Ctrl-Enter to convert the display math expression into a multi-line math expression, which will be a vertical list containing display math expressions.

Typing Ctrl-Enter after each math expression creates a new math expression in the list. Typing Ctrl-Shift-m or the close Nemeth indicator dots-456 dots-156 is used to move to the end of the multi-line math expression.

A multi-line math expression does not supply spaces or newlines before or after the expression, but they can be typed before or after the multi-line math expression as usual to create spaces or new lines in the braille output.

Termination

A user may indicate the end of a math expression of any form by terminating the expression using Ctrl-Shift-m, or by using the close Nemeth indicator dots-456 dots-156. Typing Ctrl-Space within an expression can also be used to move to the end of the expression.

File Formats

The EE creates text and math compound documents using four user-facing file formats.

These user-facing file formats employ several standard file formats to represent the text and math portions of a document.

EE Format (.ee)

The EE format for a document is the internal form used to encode text plus math documents in the EE. It consists of HTML and Content MathML elements that encode the text and math portions of the document.

The EE format is used to load and save documents to the file system to support document authoring. It may not be loaded directly into a web browser, or other applications that only support Presentation MathML.

HTML Format (.html)

The HTML format for a document is the external form used to encode text plus math documents by the EE for display within a web browser. It consists of HTML and Presentation MathML elements that encode the text and math portions of the document.

The HTML format is used to export and print documents for display within a web browser. It may not be loaded directly into the EE, or other applications that only support Content MathML.

BRF Format (.brf)

The BRF format for a document is the Braille Ready Format for a document, encoded using the computer braille encoding, for import into tools that can use it.

The BRF format may be imported by software commonly available on electronic braille notetakers, and may be printed by braille embossers to produce hard-copy braille. It may not be loaded directly into the EE.

BRL Format (.brl)

The BRL format for a document an external form used to display the Unicode Braille encoding of a document. It consists of HTML elements that contain Unicode Braille characters to be viewed by a suitable Braille font.

The BRL format may be used to produce visual representations of the braille signs used to communicate the document, typically used for braille instruction. It may not be loaded directly into the EE.

HTML

The Hypertext Markup Language (HTML) is a format used to represent rich text documents intended for display by a web browser. The HTML Living Standard that defines HTML is developed principally by the Web Hypertext Application Technology Working Group (WHATWG) with endorsement by the World Wide Web Consortium (W3C).

MathML

The Mathematical Markup Language (MathML) is a format used to represent mathematical expressions intended for inclusion in web documents. The MathML Recommendation that defines MathML is maintained by the World Wide Web Consortium (W3C).

Content MathML

Content MathML is a subset of MathML used to represent the functional structure of mathematical expressions, rather than the arrangement of symbols used to communicate them. It allows mathematical software to exchange formulas in an unambiguous manner.

Presentation MathML

Presentation MathML is a subset of MathML used to represent the visual notation of mathematical expressions, rather than the operations used to construct them. It allows mathematical software to display formulas in a manner that can be understood by human users.

Unicode

Unicode is the universal standard for electronic encoding and transmission of text characters, from any language, as numeric character code values. Unicode contains character sets for literary text, mathematical symbols, punctuation, braille, and many other languages. An exhaustive list of Unicode character symbols may be found at Unicode Character Code Charts

Unicode character code values are often expressed as hexadecimal values, prefixed by U+. For example, the Unicode Braille patterns have numerical values between U+2800 and U+28FF.

Unicode Braille

Unicode Braille is an encoding for Braille symbols using Unicode characters in the range U+2800-U+28FF. It encodes all possible 8-dot Braille symbols. A braille font with glyphs these characters may be used to display braille symbols as visual dot patterns, either with or without shadow dots for braille dots not included in each symbol.

BRF

Braille Ready Format is a file format used to represent braille symbols for electronic transmission. It is a plain-text file where each braille symbol is encoded using the ASCII characters U+0020-U+003F and U+005F-U+007E. BRF files are typically used for braille print embossing and electronic braille notetakers.

MathJax

MathJax is a JavaScript library that can be used to support Presentation MathML within browsers that do not provide native support for math, allowing Presentation MathML to be used in a portable fashion within HTML web pages.

MathJax is typically used within a web page by providing special elements in the document header to load and/or configure the MathJax library. See the MathJax Documentation for more details.

The EE application menu provides File, Drive, Edit, and Help menus.

Each of these menus and many of the menu items may be activated from the keyboard using Alt Shift plus letter access key combinations. While the key combinations Alt plus letter may also work, these may be intercepted by the browser under some circumstances.

Many of the menu items may also be activated using a single-key press after accessing the containing menu. For example, the File Open operation may be invoked by typing Alt Shift F, O.

The File Menu provides menu items to load and store documents in the local file system and to view the document source, in a variety of different file formats, and to export them into a browser web page where they may be printed.

Create a new empty document.

The EE discards the contents of the current document to create a new empty document, where you can enter the text and math contents of the new document.

You can also type Alt Shift F, N to create a new empty document.

This operation does not modify any file in the file system.

Load a document from a file in the local file system.

The EE loads the document using HTML and Content MathML to represent the text and math portions of the document.

You can also type Alt Shift F, O to open an existing document.

This operation does not modify any file in the file system.

Store a document to the file last used to access it.

The EE stores the document using HTML and Content MathML to allow it to retrieve the text and math portions of the document.

You can also type Alt Shift F, S to store a document to the file last used to access it.

This operation modifies the file in the file system.

Store a document to a different file in the local file system.

The EE stores the document using HTML and Content MathML to allow it to retrieve the text and math portions of the document.

You can also type Alt Shift F, A to store a document to a different file.

This operation modifies the file in the file system.

View the XML markup source for a document.

The EE opens a browser page in a new tab to display the XML markup source for the document using the HTML and Content MathML that represents the text and math portions of the document.

Store a document that can be viewed in a web browser.

The EE stores the document using HTML and Presentation MathML to allow browsers that support Presentation MathML to display the document.

Open a browser web page to display the document.

The EE opens a browser web page in a new tab and places the contents of the document in the web page. The EE creates the web page using HTML and Presentation MathML to allow browsers that support Presentation MathML to display the document.

Open a browser web page to print the document.

The EE opens a browser web page in a new tab and places the contents of the document in the web page. The EE creates the web page using HTML and Presentation MathML, then invokes the browser print dialog to print the page.

View the HTML markup source for a document.

The EE opens a browser page in a new tab to display the XML markup source for the document using the HTML and Presentation MathML that represents the text and math portions of the document.

Store a document as a BRF Braille Ready File.

The EE stores the document using the computer braille encoding for import into tools that can use it.

View the BRF markup source for a document.

The EE opens a browser page in a new tab to display the BRF encoding for the document using the computer braille markup that represents the braille version of the document.

Store a document as a web browser file to display the Unicode braille encoding of the document.

The EE stores the document using an HTML header around the Unicode braille encoding of the document. Loading this document in a web browser displays the braille dots using an appropriate braille font.

Open a browser web page to display the Unicode braille encoding of a document.

The EE opens a browser web page in a new tab and places the Unicode braille encoding of the document in the web page. The EE creates the web page using an HTML header around the Unicode braille, and displays the braille dots using an appropriate braille font.

Open a browser web page to print the Unicode braille encoding of a document.

The EE opens a browser web page in a new tab and places the Unicode braille encoding of the document in the web page. The EE creates the web page using an HTML header around the Unicode braille, then invokes the browser print dialog to print the page.

Clear the contents of the current document.

The EE discards the contents of the current document, so you can enter the text and math contents for a new document.

You can also type Alt Shift F, C to clear the contents of the current document.

This operation does not modify any file in the file system.

The Drive Menu provides menu items to load and store documents in the Google Drive shared file system.

Load a document from the shared file system.

The EE loads the document using HTML and Content MathML to represent the text and math portions of the document.

You can also type Alt Shift D, O to open an existing shared document.

This operation does not modify any file in the file system.

Store a document to the shared document last used to access it.

The EE stores the document using HTML and Content MathML to allow it to retrieve the text and math portions of the document.

You can also type Alt Shift D, S to store a document to the shared document last used to access it.

This operation modifies the shared document in the shared file system.

Store a document to a new document in the shared file system.

The EE stores the document using HTML and Content MathML to allow it to retrieve the text and math portions of the document.

You can also type Alt Shift D, A to store a document to a new shared document.

This operation modifies the document in the shared file system.

Store a document to replace an existing document in the shared file system.

The EE stores the document using HTML and Content MathML to allow it to retrieve the text and math portions of the document.

You can also type Alt Shift D, R to store a document to replace an existing shared document.

This operation modifies the document in the shared file system.

The Edit Menu provides operations to copy and paste document data from the system clipboard in a variety of different clipboard formats to export them into other applications.

Copy the current selection to the system clipboard.

The EE copies the current selection to the system clipboard using HTML and/or Content MathML to represent the text and math portions of the document.

The Copy operation may also be invoked using Ctrl-c.

Replace the current selection from the system clipboard.

The EE pastes HTML and/or Content MathML from the system clipboard to replace the current selection in the document.

The Paste operation may also be invoked using Ctrl-v.

Copy the entire document to the system clipboard.

The EE copies the entire document to the system clipboard using HTML and/or Content MathML to represent the text and math portions of the document.

The Copy All operation may also be invoked using Ctrl-a Ctrl-c.

Replace the entire document from the system clipboard.

The EE pastes HTML and/or Content MathML from the system clipboard to replace the entire document.

The Paste All operation may also be invoked using Ctrl-a Ctrl-v.

Copy presentation markup for the current selection to the system clipboard.

The EE copies the current selection to the system clipboard using HTML and/or Presentation MathML to represent the text and math portions of the document.

The Copy HTML operation may also be invoked using Ctrl-p.

Copy presentation markup for the entire document to the system clipboard.

The EE copies the entire document to the system clipboard using HTML and/or Presentation MathML to represent the text and math portions of the document.

The Copy All HTML operation may also be invoked using Ctrl-a Ctrl-p.

Copy presentation markup for all of the math in the entire document to the system clipboard.

The EE copies the Presentation MathML for each of the math elements in the entire document to the system clipboard. The math markup is assembled into a single multi-line math expression.

The Copy All Math operation can be used to export math expressions into Microsoft Word.

The Help Menu provides access to online documentation, configuration settings, software licensing, and version information.

Open the EE Welcome document.

The Welcome document provides a one-page quick-start introduction that describes how to choose the keyboard input mode and start using the EE.

You can also type Alt Shift H, W to open the EE Welcome document.

Open the EE Tutorial document.

The Getting to Know the EE Tutorial provides a mutli-page self-guided gentle introduction to the topics you need to start using the EE.

You can also type Alt Shift H, T to open the EE Tutorial document.

Open the EE Users Guide.

The Users Guide (this document) provides more detailed instructions for how to use the EE, including keyboard input, braille input, application menu items, and screen reader configuration information.

You can also type Alt Shift H, U to open the EE Users Guide.

Open the EE Samples Folder.

The EE Samples folder contains sample files that can be opened using the EE.

You can also type Alt Shift H, M to open the EE Samples Folder.

Open the EE Settings Page.

The Settings Page provides a web form to select custom values for settings that affect the EE behavior, including application settings, braille settings, and font settings.

You can also type Alt Shift H, G to open the EE Settings Page.

Open the EE Terms of Service document.

The Terms of Service document describes the end user license agreement under which the EE is provided free of charge to individual users, including students and teachers at educational institutions. Please contact us at ee@equalizelearning.com for information about other uses of the EE, which we would be happy to encourage!

Open the EE Privacy Policy document.

The Privacy Policy document says that when we receive information about you, such as when you report issues, we do not share your personal information with anyone. It just takes a few more words to say that in a way that ensures everyone remains safe when they use the web site!

Display version information about the EE.

The About page provides version number and copyright information for the EE, and an email link to report issues. Please include the EE version number when reporting issues.

Editor Settings

The Settings page provides options that customize the behavior of the EE, including application settings, braille settings, and font settings.

Application Settings

The Application Settings control overall behavior and appearance of the EE as an editing application, including the keyboard input mode, the visibility of editor output panels, and access to editor symbol palettes.

Keyboard Input

The Keyboard Input settings provide an alternative means to set the keyboard input mode. Selecting one of the keyboard input settings changes the keyboard input mode to match the selected option. The current keyboard input mode is saved into local storage, and restored on return to the EE web application page.

Editor Panels

The Editor Panels settings provide a means to enable or disable output panels that form the EE user interface. Enabling the Quick Buttons makes visible the top row of buttons for common math operations. Disabling the Side Palettes can be convenient to allow more horizontal space for the main input area. Disabling the Braille Bar output panel allows more vertical space for the main input area.

Symbol Palettes

The Symbol Palettes settings provide a means to enable or disable, and open or close, side bar palettes one at a time.

The Side Palettes may be enabled or disabled as a group, as described above, or they may be enabled or disabled one at a time. Marking a palette as Active includes it in the list of palettes to be displayed, and marking it as Open expands the palette to provide access to the buttons it contains.

The All Palettes check boxes may be used to mark all of the palettes as either active or inactive, or open or closed.

Braille Settings

The Braille Settings control the generation of braille output from the EE, including the use of the MathJax library, the activation of specific contracted braille rule groups, and parameters that affect the application of braille formatting rules for displaying, saving, and printing braille output.

Math Output

The Math Output settings control the use of the MathJax library header in HTML markup generated by the EE. The MathJax library may be included in files saved using the Save HTML menu item, and in web pages created using the Export HTML and Print HTML options, each of which is controlled by the corresponding check box.

The EE creates the markup using HTML headers to allow the MathJax library to display the document in browsers that do not support Presentation MathML. These settings can also be used to work around known issues with native MathML support in any particular browser.

The EE includes the following HTML header in markup it creates for display by MathJax:

<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=MML_CHTML">

Braille Rules

The Braille Rules settings control the use of specific groups of literary contractions by the braille translation library used by the EE. Each of these groups may be enabled or disabled individually to control whether or not those contractions are used on output when converting to contracted form, and whether or not they are understood on input.

The rules are grouped according to the sections of the UEB Rules document. If the Contracted Braille (all rules) box is unchecked, the behavior of the EE should conform to the use of uncontracted braille.

The Initial-letter contractions and Final-letter groupsigns may be enabled as a group, or according to the dot prefix that begins each contraction.

Braille Formats

The Braille Formats settings control the use of indentation within Braille markup created by the EE. These settings can be used to affect Braille displayed on screen within the EE web application, Braille displayed on an attached Braille terminal, and Braille saved in BRF Braille Ready Files using the Save BRF menu item.

Additional options are provided to control the use of indentation within displayed math equations contained in the document.

These options include specification of the overall line width, the indentation of the first line within a paragraph or a math equation, and the indentation of runover lines within a paragraph or math equation.

Font Settings

The Font Settings control the document styles used for the HTML files generated by the EE in support of the menu items on the File menu.

Font Size

The Font Size settings control the document font size. There is one font size used for generated HTML files, and one for generated BRL files.

Web Browsers

Presentation MathML

The following paragraphs describe web browser support for Presentation MathML on Windows.

The Math Output Settings can be used to work around any issues with web browser support for Presentation MathML in any browser.

Chromium

The Chromium browser engine is used in several popular browsers, including Chrome, Edge, and Opera. Chromium provides native support for Presentation MathML using the built-in MathML Feature, which is working its way into the stable releases of these browsers.

The implementation status of Presentation MathML support in Chromium is that the MathML Feature is now available since version 109, as of January 2023. As of version 108, the Chromium browser engine supports Presentation MathML in its Save as PDF option.

Chrome

Chrome provides native support for Presentation MathML using the built-in MathML Feature in Chromium, which is now part of the Chrome Stable Release.

Edge

Edge provides native support for Presentation MathML using the built-in MathML Feature in Chromium, which is working its way into the Edge Stable Release.

Safari

Safari provides native support for Presentation MathML using the built-in MathML support in Webkit, which has been available since Safari 5.1, released in 2011.

Firefox

Firefox provides native support for Presentation MathML using the built-in MathML support in Gecko, which has been available since Firefox 3, released in 2008.

The Firefox-specific Save As PDF option may be used to save native Presentation MathML into a PDF document.

Opera

Opera provides native support for Presentation MathML using the built-in MathML Feature in Chromium, which is working its way into the Opera Stable Release.

The Opera-specific Save As PDF option may be used to save native Presentation MathML into a PDF document.

File System Access

The File Menu operations use the File System Access API for those browsers that support it. Specifically, the EE looks for the methods showOpenFilePicker and showSaveFilePicker on the browser window object.

The EE implements fallback methods for File System Access for those browsers that do not support it. The fallback method for File Open is to use an internal <input type="file"> element to prompt the user to select the file to upload into the editor document. The fallback method for File Save is to use an internal <a download="name"> element to prompt the user to select the file to download from the editor document.

The Chromium browsers (Chrome, Edge, Opera) support the File System Access API, Firefox does not.

As a browser user, it is usually a good idea to specify a preferred folder for browser downloads, and to specify that the browser should always ask the user where to save files. These settings will help make the File System Access from the browser more understandable. See the browser settings documentation for details on how to use these settings.

Clipboard Access

The Edit Menu operations use the Clipboard API for those browsers that support it. Specifically, the EE uses the methods navigator.clipboard.writeText for the copy operations, and navigator.clipboard.readText for the paste operations.

Chromium

The Chromium browsers (Chrome, Edge, Opera) support the Clipboard API. When a paste operation is invoked from the menu, the browser displays a confirmation dialog box

This file wants to see text and images copied to the clipboard.
and the paste operation will continue after the user selects the Allow button on the dialog.

Firefox

Firefox supports navigator.clipboard.writeText (for copy) by default, but navigator.clipboard.readText (for paste) is only available if dom.events.asyncClipboard.readText is set to true from the Firefox about:config page.

When this flag is enabled, and a paste operation is invoked from the menu, Firefox displays a confirmation dialog box containing the single word Paste, and the paste operation will continue after the user selects the Paste button on the dialog. The Paste button may be selected using the mouse, or by pressing the P key.

Export, Print, and PDF

The EE provides an Export HTML menu item that opens a new browser page and places the contents of the document in the page. This new page can be printed or saved to a PDF file in the usual ways supported by the browser.

The EE provides a Print HTML menu item to print files. It exports the document to a new browser page, as described above, and invokes the browser print support directly.

The EE does not provide a separate Save as PDF menu item, but the Print menu item can be used to invoke the browser Save as PDF support to create PDF files that include both text and math markup.

A file created by the Save HTML menu item can be loaded directly into a browser as an HTML file, and printed or saved to a PDF file in the usual ways supported by the browser.

Screen Readers

General Settings

The EE is designed to work with a wide range of screen readers, using as few custom configuration settings as possible. There are some settings required for the EE to work properly, and others where the EE is designed to work with any setting value in use.

The following paragraphs describe general settings common to all screen readers. Additional sections provide specific instructions needed to set up specific screen readers. Any screen reader not listed below may be supported by using the general settings descriptions to determine screen reader settings that will allow the EE to operate properly.

Braille Input

Each screen reader provides a way to choose the Braille code used to translate input received by the screen reader from an attached Braille device. The selected Braille Input code typically includes a choice of input language, choice of Braille standard, and choice of Computer Braille, Uncontracted Braille, or Contracted Braille.

Since the EE performs its own Braille translation, it needs to receive Braille symbols untranslated by the screen reader. These Braille symbols may be generated as Braille key input from an attached Braille device, or as six-key Braille input from the home row keys of a computer keyboard.

The recommended setting for Braille Input for the EE is to use Computer Braille input, so the EE can receive and process the raw Braille symbols collected by the braille device.

Braille Output

Each screen reader provides a way to choose the Braille code used to output information to an attached Braille device. The selected Braille Output code typically includes a choice of output language, choice of Braille standard, and choice of Computer Braille, Uncontracted Braille, or Contracted Braille.

Since the EE performs its own Braille translation, it generates Unicode Braille that is designed not to be translated by the screen reader. However, the Braille Output setting may be used to translate other text that appears in the EE user interface, including menu item labels, button tool tips, and palette labels.

The EE will operate properly with any selection for the Braille Output translation setting.

Current Word

Each screen reader provides a way to choose the Braille translation of the Current Word that has the input focus. Typically this setting is a switch that, when selected, shows the Current Word in Computer Braille code, and when not selected, shows the Current Word using the selected Braille Output translation setting.

This setting only affects read-only text that appears in the EE user interface for menu item labels and palette labels, and does not affect the Unicode Braille generated by the EE for document content.

The EE will operate properly with either selection for the Current Word translation setting.

Braille Messages

Braille Messages are interactive notifications that may be spoken aloud and displayed in Braille on an attached Braille device. These notifications are typically created by ARIA live messages.

Screen readers often provide settings to enable showing Braille Messages in Braille, and to specify the amount of time to display them.

Setting Braille Messages to Off instructs the screen reader not to display these messages in Braille, but only to read them aloud.

The EE uses ARIA live messages to support self-voicing feedback during math expression entry. Displaying such messages on the Braille display works well for occasional messages, but can overwhelm when they occur frequently, as they do in the EE.

For this reason, the recommended setting for the EE is to disable Braille Messages, which allows the EE to provide Braille and speech feedback on each keystroke.

Forms Mode

Forms Mode allows a screen reader user to enter information with interactive controls, such as combo boxes, menu buttons, and text input areas, that often appear on web forms. Since these controls require the user input focus, Forms Mode is also known as Focus Mode.

The screen reader is said to be in Forms Mode (Focus Mode) when the user interacts with application or form controls within a web page, and in Browse Mode when using screen reader commands to navigate the content of the web page.

The EE uses interactive controls for text and math entry, and so Forms Mode is used to interact with the editor.

Screen readers often provide a setting to enable Auto Forms Mode, which instructs the screen reader to switch to Forms Mode when tab and/or arrow key navigation reaches a form control, to allow the user to interact directly with the control, simplifying the use of the control.

Screen readers often provide Manual Forms Mode keyboard commands to switch into or out of Forms Mode when Auto Forms Mode is not used. Usually, Enter or Space manually switches into Forms Mode, allowing the user to interact with a control, and Escape manually switches out of Forms Mode, allowing the user to navigate the web page.

Screen readers often provide an Auto Focus setting to automatically pull the input focus to a focusable form control when one is present on a web page. Such settings can be used to pull the input focus into an application like the EE when the page loads, without the need for additional user action.

Auto Forms Mode and Auto Focus make it easier to navigate to the EE input panel, but the EE should also operate properly using Manual Forms Mode keyboard commands. The EE is designed to work with Auto Forms Mode, which is the recommended setting.

JAWS Settings

JAWS has a large number of settings that can be modified by the user. Typing JAWS + 6 opens the JAWS Settings Center, which provides access to many of these settings.

These settings may be specified for a specific application by choosing the application name on the Settings Center Application drop down, or they may be specified for all applications by choosing the Default (All Applications) selection.

In addition to specifying settings on a per-application basis, settings may also be specified on a per-domain basis to control JAWS behavior when the browser visits web pages from a particular web domain.

The JAWS Script Manager may be used to create domain settings files in the JAWS Settings Folder. Typing JAWS + 0 opens the JAWS Script Manager, which provides access to various types of configuration files in the JAWS Settings Folder.

See the JAWS Help Topics for further details on how to use the JAWS Settings Center and the JAWS Script Manager. Typing JAWS + J, F1 opens the JAWS Help Topics.

JAWS Basic Setup

The Equalize Editor provides a JAWS configuratiaon file called ee.jcf which needs to be saved into your JAWS Settings Folder with the name www.lakepinesbraille.com.jcf.

Using this name instructs JAWS to use this configuration, but only when using a browser that is viewing the web site www.lakepinesbraille.com.

This way the configuration needed for the Equalize Editor does not affect using JAWS with other applications, or with other web sites.

Use the link below to download the JAWS configuration file for the Equalize Editor.

Save this file in your JAWS Settings Folder on your local machine:

C:\Users\[name]\AppData\Roaming\Freedom Scientific\JAWS\[year]\Settings\enu

where [name] is your Windows user name, and [year] is your JAWS version year.

Here is the link: www.lakepinesbraille.com.jcf

When saving the file, make sure to put it in the JAWS Settings Folder, with the file name as shown above.

The next time you visit the Equalize Editor web site, JAWS should use the new configuration. You can check the JAWS Settings Center (JAWS + 6) for the application www.lakepinesbraille.com (Domain) which should include setting the Braille Input Translation to Computer Braille.

The configuration settings included in this file are explained in the following sections, so you can choose those settings that will be most helpful for your accessibility needs.

JAWS Advanced Setup

The JAWS settings for the Equalize Editor can also be set manually.

• Type JAWS + 6 to open the JAWS Settings Center.

• Select www.lakepinesbraille.com as the Application.

Modify the following settings:

[Braille -> General -> Translation]

• Set Output to UEB Grade 2

• Set Input to Computer Braille

• Set Show current word in Computer Braille to Off

[Braille -> Flash Messages]

• Set Enable Flash Messages to Off

[Forms Mode]

• Set Select Forms Mode to Auto

[Web/HTML/PDFs -> Miscellaneous]

• Set Page Refresh Filter to Suppress All Refreshes

Press OK to apply the changes.

Suggested Settings

The following JAWS settings are recommended for web pages that contain the EE.

The effects of these settings are explained in more detail below.

Braille Output

Braille -> General -> Translation -> Output -> Unified English Braille Grade 2

This setting controls the Braille code used to output information to an attached Braille device.

Setting this option to Unified English Braille Grade 2 instructs JAWS to translate user interface text output from the EE. See the general comments in the Braille Output section for more information.

Braille Input

Braille -> General -> Translation -> Input -> Computer Braille

This setting controls the Braille code used to input information from an attached Braille device.

Setting this option to Computer Braille instructs JAWS not to translate Braille input sent to the EE. See the general comments in the Braille Input section for more information.

Current Word

Braille -> General -> Translation -> Show current word in Computer Braille -> Off

This setting controls the Braille code used to output the Current Word.

Setting this option Off instructs JAWS to use the Braille Output code setting for the Current Word. See the general comments in the Current Word section for more information.

Flash Messages

Braille -> Flash Messages -> Enable Flash Messages -> Off

This setting controls whether or not ARIA live messages, which normally should be spoken aloud, are also displayed briefly on the Braille device output.

Setting this option Off instructs JAWS not to display these messages on the Braille device output, but only to read them aloud.

See the general comments in the Braille Messages section for more information.

Forms Mode

Forms Mode -> Select Forms Mode -> Auto

Forms Mode affects how JAWS navigates web content in an interactive browser page.

Setting this option to Auto instructs JAWS to switch to Forms Mode on navigation to the EE to allow the user to interact directly with the EE input area.

See the general comments in the Forms Mode section for more information.

Page Refresh

Web / HTML / PDFs > Miscellaneous -> Page Refresh Filter -> Suppress All Refreshes

Dynamic web pages like the EE web page require special techniques to control the JAWS page refresh behavior.

JAWS provides the key combination JAWS + Escape to refresh the braille page manually. This key combination can be used when JAWS fails to keep up with dynamic page changes used by the EE.

One such case is when the Braille display shows the message App CTL equation btn instead of the braille translation of the formula in the edit window. Pressing JAWS + Escape will restore the Braille display to the correct state.

The Page Refresh Filter setting may be used to control the JAWS page refresh behavior automatically.

The recommended setting for the EE is to disable the JAWS page refresh behavior by setting the Page Refresh Filter setting to Suppress All Refreshes. It is recommended that this setting be used for the EE web site without affecting other applications, as described above.

Tutor Messages

Options -> Basics -> Tutor Messages -> Announce custom messages only

JAWS announces short phrases to assist novice users with menu and control usage. For example, JAWS announces the phrase "type in text" when a text area receives the input focus. These messages can be controlled using Options -> Basics -> Tutor Messages from the JAWS window, but not through the JAWS Settings Center. This setting has three options:

Since this setting cannot be controlled by the JAWS Settings Center, it also cannot be placed in domain settings files. While the recommended setting for the EE is to use Announce custom messages only, the EE will operate properly with any setting.

NVDA Settings

NVDA has a large number of settings that can be modified by the user. Typing NVDA + Ctrl + G opens the NVDA Settings Dialog, which provides access to many of these settings. By default, the NVDA Settings Dialog modifies the NVDA normal configuration.

These settings may also be specified as part of a named configuration profile using the Configuration Profiles Dialog, which can be activated by typing NVDA + N, C. This dialog may be used to create new configuration profiles.

To activate a configuration using the Configuration Profiles dialog, select the configuration in the drop down list and press Enter. When a named configuration is active, the NVDA Settings Dialog can be used to modify settings that apply to the active configuration.

Once a configuration profile is created, an input gesture may be defined to activate and deactivate it. The Input Gestures Dialog, activated by typing NVDA + N, P, N, contains a Configuration Profiles section that includes an option for each configuration profile to define the input gesture for the profile.

See the NVDA User Guide for further details on how to use the NVDA Configuration Profiles Dialog and the NVDA Input Gestures Dialog. Typing NVDA + N, H, U opens the NVDA User Guide.

NVDA Basic Setup

The Equalize Editor provides an NVDA Configuration File called ee.ini which needs to be saved into your NVDA Configuration Folder.

The ee.ini file provides the Equalize Editor profile. It is only active when you manually activate the ee profile, so no other applications or web pages are affected once you manually deactivate it.

To activate the Equalize Editor configuration, type NVDA + N, C to open the Configuration Profiles dialog, and manually select the ee profile.

Use the link below to download the NVDA configuration file for the Equalize Editor.

Save this file in your NVDA Profiles Folder on your local machine:

C:\Users\[name]\AppData\Roaming\nvda\profiles

where [name] is your Windows user name.

Here is the link: ee.ini

When saving the file, make sure to put it in the NVDA Profiles Folder, with the file name as shown above.

The configuration settings included in this file are explained in the following sections, so you can choose those settings that will be most helpful for your accessibility needs.

NVDA Advanced Setup

The NVDA settings for the Equalize Editor can also be set manually.

Type NVDA + Ctrl + P to open the NVDA Configuration Profiles dialog.

• Create a new profile named ee if one does not already exist.

• Select ee and press Manual activate to activate the ee profile.

• Close the the NVDA Configuration Profiles dialog.

Type NVDA + Ctrl + G to open the NVDA Settings Center.

Modify the following settings:

[Braille]

• Set Output Table to UEB Code Grade 2

• Set Input Table to Unicode Braille

• Set Expand to computer braille for the word at the cursor to Off

• Set Show Messages to Disabled

[Browse Mode]

• Set Enable browse mode on page load to Off

• Set Automatic focus mode for focus changes to On

• Set Automatic focus mode for caret movement to On

• Set Automatically set system focus to focusable elements to On

Press OK to apply the changes.

NVDA Gestures Setup (Basic)

NVDA gestures provide a convenient way to activate and deactivate the ee configuration profile, so the custom settings it needs are not used for other applications or other web pages.

The Equalize Editor provides an NVDA Gestures File called gestures.ini that may be added to your NVDA gestures.ini file to assign the keyboard gesture NVDA + E to activate and deactivate the ee configuration profile. Alternatively you can create your own custom gesture to perform the same functions.

Use the link below to download the NVDA gestures file for the Equalize Editor.

Remember to add it to any existing gestures.ini file you may already have.

Save this file in your NVDA Configuration Folder on your local machine:

C:\Users\[name]\AppData\Roaming\nvda

where [name] is your Windows user name.

Here is the link:

gestures.ini

When saving the file, make sure to add it to any existing gestures.ini file you may already have.

NVDA Gestures Setup (Advanced)

The input gesture for the Equalize Editor can also be created manually.

After the ee configuration profile is created, an input gesture may be defined to activate and deactivate it. The Input Gestures Dialog, activated by typing NVDA + N, P, N, contains a Configuration Profiles section that includes an option for each configuration profile to define the input gesture for the profile.

Type NVDA + N, P, N to activate the NVDA Input Gestures Dialog.

Open the Configuration Profiles and then Activates or deactivates the ee configuration profile.

Press the Add button to add a new gesture, then NVDA + E to assign the new input gesture.

After these steps, typing NVDA + E activates and deactivates the Equalize Editor profile.

You can choose any key combination you prefer as the input gesture for the Equalize Editor profile.

Suggested Settings

The following NVDA settings are recommended for web pages that contain the EE.

The effects of these settings are explained in more detail below.

Input Table

Braille -> Input Table -> Unicode Braille

This setting controls the Braille code used to input information from an attached Braille device.

Setting this option to Unicode Braille instructs NVDA not to translate Braille input sent to the EE. See the general comments in the Braille Input section for more information.

NVDA provides a variety of 8 dot computer braille options that may also be used for the Input Table setting.

Output Table

Braille -> Output Table -> UEB Code Grade 2

This setting controls the Braille code used to output information to an attached Braille device.

Setting this option to UEB Code Grade 2 instructs JAWS to contract Braille output from the EE user interface. See the general comments in the Braille Output section for more information.

NVDA provides a variety of other options that may also be used for the Output Table setting.

Current Word

Braille -> Expand to computer braille for the word at the cursor -> On

This setting controls the Braille code used to output the Current Word.

Setting this option to On instructs NVDA to use Computer Braille for the current word. Otherwise, the braille code for the current word is controlled by the Output Table setting.

See the general comments in the Current Word section for more information.

Braille Messages

Braille -> Show Messages -> Disabled

This setting controls whether or not ARIA live messages, which normally should be spoken aloud, are also displayed briefly on the Braille device output.

Setting this option to Disabled instructs NVDA not to display these messages on the Braille device output, but only to read them aloud.

See the general comments in the Braille Messages section for more information.

Focus Mode

Browse Mode -> Automatic focus mode for focus changes -> On

This setting instructs NVDA to enable automatic focus mode during tab navigation.

Browse Mode -> Automatic focus mode for caret movement -> On

This setting instructs NVDA to enable automatic focus mode during arrow key navigation.

Browse Mode -> Automatically set system focus to focusable elements -> On

This setting instructs NVDA to pull input focus to a focusable element when a page loads.

See the general comments in the Forms Mode section for more information.

Nemeth Braille

The EE supports the Nemeth Braille Code for Mathematics and Science Notation, 1972 Revision.

The Braille Authority of North America (BANA) has approved a sequence of Nemeth Updates, some of which are supported by the EE as described below.

The following sections describe support for certain specific Nemeth Braille forms in the EE.

Underbar Short Form

Following a single letter or digit, the EE outputs the short form for both the overbar modifier, as described in Nemeth Braille Code: Rule XIV §86b, and the underbar modifier, as described in Nemeth Update: Rule XIV §86c.

Per Mille Symbol

The EE supports the per mille symbol ‰ as dots-4 dots-356 dots-356, as described in Nemeth Update: Rule XXII §162, and the per myriad symbol ‱ as dots-4 dots-356 dots-356 dots-356.