Skip to content

Commit

Permalink
Cosmetic improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
psoukie committed Dec 12, 2022
1 parent 9beecd1 commit d343700
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 18 deletions.
23 changes: 11 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ _ZipChord_ is a customizable hybrid keyboard input method for Windows that augme

## Installation

Download and save the executable **zipchord.exe** of the latest [release](https://github.com/psoukie/zipchord/releases) in a folder where you have read and write access, and run it. (Optionally, download a dictionary from the dictionaries folder to use as a starting point.)
Download and save the executable **zipchord.exe** of the latest [release](https://github.com/psoukie/zipchord/releases) in a folder where you have read and write access, and run it. You can also download a dictionary from the [dictionaries](https://github.com/psoukie/zipchord/tree/main/dictionaries) folder to use as a starting point.

(Note that _ZipChord_ has not been ported to MacOS because of its dependency on AutoHotKey.)
Note that _ZipChord_ only works on Windows because of its dependency on AutoHotKey.

## Using ZipChord

Expand All @@ -28,7 +28,7 @@ To open the menu, click the _ZipChord_ icon in the Windows tray or press and hol

The dictionary tab shows the currently loaded chord dictionary and the number of chords it contains. You can select a different dictionary file using the **Open** button, edit its chords directly in default text editor (**Edit**), and **Reload** the dictionary when you make changes to the chord file directly in an editor.

Notes:
**Notes:**
* See [below](#chord-dictionary) for more details about the chord dictionary file and advanced features.
* When you add chords by selecting text and pressing and holding Ctrl-C, the new chord is added automatically, and you do not need to open the menu to edit or reload the dictionary.

Expand All @@ -46,20 +46,19 @@ This tab allows you to adjust the sensitivity of the chord recognition, add a de

This tab allows you to change the typing and chord behavior to adjust how spaces and capitalization are handled around chords and punctuation.

**Smart spaces**
The smart spaces -- when enabled -- ensure correct spacing around chords and punctuation. This means that spaces are added automatically if you haven't typed one manually, but the smart spaces are also dynamically removed if they are followed by punctuation or you type another space manually. Smart spaces can be enabled as follows:
- In front of chords
- After chords
- After punctuation
**Smart spaces**: The smart spaces--when enabled--ensure correct spacing around chords and punctuation. This means that spaces are added automatically if you haven't typed one manually, but the smart spaces are also dynamically removed if they are followed by punctuation or you type another space manually. Smart spaces can be enabled as follows:
- **In front of chords**
- **After chords**
- **After punctuation**

**Auto-capitalization** offers three options:
- Off: Spaces and capitalization are not adjusted around punctuation.
- For chords only: Spaces are added and words are capitalized only when punctuation precedes or follows chorded entry.
- For all input: Spaces are always added after punctuation and words are capitalized even for regular typing.
- **Off:** Spaces and capitalization are not adjusted around punctuation.
- **For chords only:** Spaces are added and words are capitalized only when punctuation precedes or follows chorded entry.
- **For all input:** Spaces are always added after punctuation and words are capitalized even for regular typing.

### Enabling and Disabling the Chords

You can temporarily disable the chord recognition by unchecking the **Recognition enabled** checkbox.
You can temporarily disable the chord recognition by unchecking the **Use chord detection** checkbox.

## Chord Dictionary

Expand Down
12 changes: 6 additions & 6 deletions source/zipchord.ahk
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ SetWorkingDir %A_ScriptDir%
; ZipChord by Pavel Soukenik
; Licensed under GPL-3.0
; See https://github.com/psoukie/zipchord/
global version = "1.7.0"
global version = "1.7.1"

; Default (US English) keyboard and language settings:
global default_keys := "',-./0123456789;=[\]abcdefghijklmnopqrstuvwxyz"
Expand Down Expand Up @@ -130,17 +130,17 @@ Initialize() {
Gui, Add, Checkbox, vUI_delnonchords xs+20 Y+m Checked%delnonchords%, &Delete mistyped chords
;Gui, Add, GroupBox, xs ys+120 w320 h100 Section, Chord behavior
Gui, Tab, 3
Gui, Add, GroupBox, w320 h120 Section, Smart spaces
Gui, Add, GroupBox, w290 h120 Section, Smart spaces
;Gui, Add, Text, xs+20 ys+m +Wrap, When selected, smart spaces are dynamically added and removed as you type to ensure spaces between words, and avoid extra spaces around punctuation and doubled spaces when a manually typed space is combined with an automatic one.
Gui, Add, Checkbox, vUI_space_before xs+20 ys+30, &In front of chords
Gui, Add, Checkbox, vUI_space_before xs+20 ys+30, In &front of chords
Gui, Add, Checkbox, vUI_space_after xp y+10, &After chords
Gui, Add, Checkbox, vUI_space_punctuation xp y+10, &After punctuation
Gui, Add, Checkbox, vUI_space_punctuation xp y+10, After &punctuation
Gui, Add, Text, xs y+30, Auto-&capitalization:
Gui, Add, DropDownList, vUIcapitalization Choose%capitalization% AltSubmit Right xp+150 w130, Off|For chords only|For all input

Gui, Tab
Gui, Add, Checkbox, gUIControlStatus vUIon xs Y+m Checked%UIon%, Re&cognition enabled
Gui, Add, Button, Default w80 xs+220 y+m, OK
Gui, Add, Checkbox, gUIControlStatus vUIon xs Y+m Checked%UIon%, Use &chord detection
Gui, Add, Button, Default w80 xs+220 yp, OK
Gui, Tab, 4
Gui, Add, Text, X+m Y+m, ZipChord`nversion %version%
Gui, Font, Underline cBlue
Expand Down

0 comments on commit d343700

Please sign in to comment.