The NBP Editor

Version: 1.14.148
Date: 2017-11-22 12:50 UTC
Organization: National Braille Press
Contact: Brian Mac Donald
Address:
88 St. Stephen Street
Boston, MA 02115
United States of America

Contents

1   General Notes

Several key bindings are described within this document. They aren't actually part of the editor itself, but, rather, are part of the B2G's user interface. They're more fully documented within the User Interface Manual.

A quick way to invoke the editor is to press Space+ed (dots 1246).

2   The Main Screen

The main screen contains the following screen elements:

2.2   Current Path

This region shows the absolute path to the file that's currently being edited. If it's a new file (see the New action) then it says:

[new file]

2.3   Edit Area

This region is where the content of the file is loaded and can be modified. If the file is empty then it says:

[empty file]

2.3.1   Braille Indicators

Dots 78 [⣀] represents the cursor. This is the location where new characters are inserted and where existing characters are deleted.

Dot 8 [⢀] represents either selected text (see Selecting Text) or highlighted text (see Highlighting Text).

2.3.3   Editing

Typing Any Character

Insert that character immediately to the left of the cursor, and then move the cursor one character to the right.

  • To type a control character:
    1. Press Space+x (dots 1346).
    2. Type the corresponding letter.
  • To type any character by its Unicode value:
    1. Press Space+u (dots 136).
    2. Enter the hexadecimal representation of that character's Unicode value.
    3. Press Enter (dot 8).
Dot8

The Enter key.

  • At the start of a line, insert a blank line above it.
  • At the end of a line, start a new line below it.
  • In the middle of a line, split that line just before the character where the cursor is.
Dot7
The Backspace key. Delete the character to the left of the cursor. If text has been selected then delete all of it.
Space+d (dots 145)
The Delete key. Delete the character where the cursor is. If text has been selected then delete all of it.

2.3.4   Selecting Text

Press Backward together with a cursor routing key to mark the start of a text selection. If text has already been selected then its start is adjusted.

Press Forward together with a cursor routing key to mark the end of a text selection. If text has already been selected then its end is adjusted.

Press Space+Dot8+a (dot 1) to select all of the text.

Press any cursor routing key (by itself) to clear the text selection and set the cursor's location.

2.3.5   Clipboard

The editor doesn't have its own clipboard - it uses Android's global clipboard. This means that text can be easily copied between the editor and other apps.

Space+Dot8+x (dots 1346)
Cut (copy and then delete) the current text selection to the clipboard.
Space+Dot8+c (dots 14)
Copy the current text selection to the clipboard. If text hasn't been selected then copy all of the text to the clipboard.
Space+Dot8+v (dots 1236)
Paste (insert) what's on the clipboard into the text at the cursor's location.

2.3.6   Highlighting Text

Press Space + one of the following letters together with Dot8 to turn on the corresponding type of highlighting, and together with Dot7 to turn it off:

Letter Dots Type
b 12 Bold
i 24 Italics
s 234 Strike Through
u 136 Underline

More than one type of highlighting may be turned on at the same time. A quick way to turn all of them off at once is to press Space+h (dots 125) together with Dot7.

If a character is marked as being highlighted (see Braille Indicators) then you can press Dot3 together with the corresponding cursor routing key to find out how it has been highlighted.

2.3.7   Finding Text

To find text:

  1. Press Space+f (dots 124).
  2. Enter the text.
  3. Press Enter (dot 8).

The text is interpreted as a sequence of space-separated words.

  • The amount of space between words doesn't matter. Any amount of space within the text matches any amount of space within the file.
  • The first word within the text only needs to match the end of a word within the file. Enter a space before it to ensure that it matches a whole word.
  • The last word within the text only needs to match the start of a word within the file. Enter a space after it to ensure that it matches a whole word.

A case-insensitive, forward search is performed. If the text is found then the braille display is panned such that its leftmost cell is where the text starts.

To continue searching forward for the same text without reentering it, press Space+Dot8+f (dots 124).

To search backward for the same text without reentering it, press Space+Dot7+f (dots 124).

3   The Actions Menu

Press Android's Back key to leave the menu without selecting an action.

3.1   Edit

Perform an action on the text currently being edited.

  • If text hasn't been selected:

    Paste

    Paste (insert) what's on the clipboard into the text at the cursor's location.

    Select All

    Select all of the text.

  • If text has been selected:

    Copy

    Copy the current text selection to the clipboard.

    Cut

    Copy the current text selection to the clipboard and then delete it.

    Uppercase

    Translate all of the lowercase letters within the current text selection to uppercase.

    Lowercase

    Translate all of the uppercase letters within the current text selection to lowercase.

    Bold

    Make the current text selection bold.

    Italics

    Italicize the current text selection.

    Strike

    Add a strike through the current text selection.

    Subscript

    Add subscript highlighting to the current text selection.

    Superscript

    Add superscript highlighting to the current text selection.

    Underline

    Add an underline to the current text selection.

3.2   New

Start editing a new file. The Edit Area and the Current Path are both cleared. If the Edit Area contains changes then they're first saved (see the Save Changes dialog).

3.3   Open

Edit an existing file. If the Edit Area contains changes then they're first saved (see the Save Changes dialog). The File Finder is used to locate the file.

3.4   Save

Save the current file to persistent storage. The content of the Edit Area is written to the file referenced by the Current Path. If the path isn't known then the Save As action is automatically performed instead. The File Saved dialog is presented once the file has been successfully saved.

3.5   Save As

Save the current file to a new location, in a different format, etc. The Confirm Format dialog is first used in order to ensure that it'll be saved in the desired format. The File finder is then used either to locate or to specify the desired location. The File Saved dialog is presented once the file has been successfully saved.

3.6   Send

Send the current file to someone via EMail, to another device via Bluetooth, etc. If you haven't already done so, you'll be asked to select how files are to be sent. First choose the mechanism, and then select one of the following actions:

Just Once
Your current choice is temporary; you'll be asked again the next time. Select this action if you're not yet sure, if you think you might want to use another mechanism later, etc.
Always
Your current choice is to be made permanent; it'll be difficult to change it later. Only select this action if you're absolutely sure.

3.6.1   EMail

Sending a file via EMail requires that:

  • You have access to the internet.
    • To configure a Wi-Fi connection, go to Settings -> Wi-Fi. A shortcut is to press Space+s (dots 234), and then type the letter w (dots 2456).
  • You've defined at least one EMail account. To define an EMail account, go to Settings -> Add Account -> EMail.

Android's EMail composition app will be launched, the current file will be attached to the message being composed, and you'll be placed into the (empty) message body editing area. Other fields (the recipient, the subject, etc) will also be empty and need to be filled in.

3.7   Delete

Delete an existing file. The File Finder is used to locate it. The "Delete File" dialog is used in order to ensure that the correct file will be deleted.

3.8   More

This is an Androidism rather than an editor action. Android limits the number of menu items that may be on the screen at the same time. This pseudo action is presented if that limit has been exceeded, and causes the menu to be scrolled forward in order to show the next set of items.

4   The File Finder

The file finder is used to locate a file for editing (see the Open action), for saving (see the Save As action), etc.

4.1   Location Listing

The initial screen presents a list of the available locations where files can be stored. For each of them, a descriptive label and the absolute path are shown. This listing may contain:

current
The folder that contains the current file. This location isn't listed if a new file is being edited.
documents
The folder within internal storage that's used as the primary location for storing documentation. This location is always listed. If the folder doesn't yet exist then it's created.
sdcard
The first partition on the removable SD card. This location isn't listed if an SD card hasn't been inserted, hasn't been formatted, is corrupt, etc.
usb
The first partition on the removable USB mass storage device. This location isn't listed if a USB mass storage device hasn't been inserted, hasn't been formatted, is corrupt, etc.

Selecting the desired location goes to its top-level Folder Listing. Alternatively, one of the following actions may be selected:

Cancel
Return to the file currently being edited.

4.2   Folder Listing

A folder listing presents a list of the files and/r folders that the current folder contains. A forward slash [/] is appended to the name of each folder within the listing.

Folders that aren't readable won't be listed. The listing may be further constrained by editor features (e.g. the "Select Format" dialog).

  • Selecting a file causes the editor to act on that file.

  • Selecting a folder goes to its listing.

  • Additionally, one of the following actions may be selected:

    Parent Folder

    Go to the listing for the folder that contains the one currently being listed. If currently listing the system root folder then go to the Location Listing.

    Cancel

    Return to the file currently being edited.

For actions that only require read access to the selected file (e.g. the Open action):

  • The listing won't contain files that aren't readable.

For actions that require write access to the selected file (e.g. the Save As action):

  • These additional actions may also be selected:

    Type File Name

    Go to the Path Editor so that the name of a new file can be entered.

4.3   Path Editor

The absolute path of the folder currently being listed is shown within a read-only field, and the name of the file currently being edited is shown within an editable field. If the file name extension is being imposed (e.g. by the Select Format dialog) then it's shown in bold and can't be edited.

Forward slashes [/] may be appended to and/or inserted into the file name. This is how a subfolder (to any depth) can be specified.

Any number of parent folder references [../] may be prepended to the file name in order to escape the folder currently being listed.

One of the following actions may be selected:

Done
Create the file (including its subfolder if specified), and then select it.
Back
Return to the Folder Listing.
Cancel
Return to the file currently being edited.

5   Dialogs

5.1   Confirm Format

This dialog is presented in order to confirm that the file will be saved in the desired format. If the file's path isn't known (a new file is being edited) then the Select Format dialog is used instead.

One of the following must be confirmed:

no extension
The file's name doesn't have an extension.
unrecognized extension
The file's name has an extension that the editor doesn't support.
an extension along with a description of its corresponding format
The extension corresponds to one of the editor's Supported Formats.

One of the following actions may be selected:

OK
Save the file as is. If its name has either no extension or an unrecognized extension then its content is assumed to be plain text.
Change
Use the Select Format dialog to choose a supported format.
Cancel
Return to the file currently being edited.

5.2   Select Format

This dialog is presented so that one of the editor's Supported Formats can be selected when saving a file. The File Finder is then used either to locate an existing file or to enter a new file name.

Each listed format shows its corresponding file extension and its description. Folder listings will be filtered based on the selected extension. If the special format all files is selected then folder listings won't be filtered, and the file will be saved in the format associated with the extension of the selected or entered file's name.

One of the following actions may also be selected:

Cancel
Return to the file currently being edited.

5.3   Save Changes

This dialog is presented before a new file is edited if the Edit Area contains changes.

One of the following actions may be selected:

Save First
The Save action is performed before the new file is edited.
Cancel This Action
Return to the file currently being edited.
Continue without Saving
Edit the new file without first saving the current changes.

5.4   File Saved

This dialog is presented in order to confirm that a file has been successfully saved. It contains the file's absolute path. Select OK to clear it.

5.5   Delete File

This dialog is presented before a file is actually deleted in order to ensure that the correct file has been chosen.

One of the following confirmations may be selected:

Yes
Delete the file.
No
Don't delete the file.

6   Appendices

6.1   Supported Formats

6.1.1   Editable

Editable Formats
Extension Description
.brf Formatted ASCII Braille
.brl Unformatted ASCII Braille
.doc Microsoft Word 1997-2007
.docm Microsoft Word 2007+ XML (macro-enabled)
.docx Microsoft Word 2007+ XML (macro-free)
.html HyperText Markup Language
.mhtml MIME HTML
.odt Open Document Text
.rtf Rich Text
.txt Plain Text

6.1.2   View-only

Editable Formats
Extension Description
.kwb BrailleNote Keyword Braille
.kwt BrailleNote Keyword Text

6.1.3   Save-only

Save-only Formats
Extension Description
.epub Electronic Publication
.oxps Open XML Paper Specification
.pdf Portable Document Format
.ps PostScript
.xps Microsoft XML Paper Specification