From 3f0db9463cca2e526ab99431f419b9c350589085 Mon Sep 17 00:00:00 2001 From: jeremymarch Date: Mon, 14 Jan 2019 01:28:43 -0500 Subject: [PATCH] update readme for 1.0 release --- README.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 47d0042..7756a36 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ Type polytonic Greek diacritics with ease. * Add diacritics in any order * Toggle diacritics on/off * breathings, accents, subscripts, macrons, breves, diaereses: no problem!\* -* (coming soon: choose precomposed, precomposed with private use area, or combining-only modes) +* Choose precomposed, precomposed with private use area, or combining-only modes. \* as long as your font supports it. @@ -20,10 +20,7 @@ For best results, use a polytonic Greek font such as: ## Installation: The extension is contained in the file hoplitekb.oxt. Download this file from the [**release**](https://github.com/jeremymarch/HopliteKB-LibreOffice/releases) tab above. From LibreOffice, add the extension by going to Tools -> Extension Manager and clicking Add; select the file hoplitekb.oxt and restart LibreOffice. -If you want to build the extension from source code, clone this repository. Now zip the contents of the **hoplitekb-ext** folder into a zip file and rename the zip **hoplitekb.oxt**. Be sure not to include the enclosing folder itself, i.e. hoplitekb-ext, in the zip file or the extension will fail to load. From the terminal, these steps can be easily combined by running -> **_zip -r ../hoplitekb.oxt \*_** - -from inside the hoplite-ext folder. Install hoplitekb.oxt in LibreOffice as above. +To build the extension from source code clone this repository. Run the build.sh script to build the extension. Install hoplitekb.oxt in LibreOffice as above. ## Use: Use your usual Greek keyboard to type base letters. Use this extension to add diacritics. After typing a vowel, while holding Control (Command on Mac), press a key 1-9 to toggle on/off diacritics. The 1-9 keys are bound to: @@ -37,8 +34,10 @@ Use your usual Greek keyboard to type base letters. Use this extension to add d 8. iota subscript 9. diaeresis -The key bindings can be changed in the file Accelerators.xcu; then rezip the extension and reinstall. +## Options: +The options menu can be accessed on Mac from LibreOffice -> Preferences -> LibreOffice Writer -> Hoplite Keyboard. On Linux and Windows it can be accessed from Tools -> Options -> LibreOffice Writer -> Hoplite Keyboard. On all platforms it can also be accessed from Tools -> Extension Manager; then select the extension and click the Options button. From the options menu you can select the unicode mode for diacritics. Precomposed mode will use precomposed characters when possible, falling back to combining diacritics for combinations where a precomposed character does not exist in the unicode standard. Precomposed with PUA (Private Use Area) mode is the same, but will also use the precomposed characters from the non-standard Private Use Area. These characters are not standard unicode, but are supported by some fonts such as New Athena Unicode and IFAOGrec Unicode. Combining-only mode will use combining diacritics to type decomposed characters. Few fonts handle combining diacritics well at this point; New Athena Unicode currently is the best. -## Why a LibreOffice extension? Why not offer this functionality system-wide? -The Windows, Mac, and Linux opererating systems do not provide the keyboard with the information necessary to toggle on/off diacritics. The Hoplite Keyboard started on iOS and Android where this information *is* provided to the keyboard. So for Windows, Mac, and Linux the only way to implement this is inside applications--hence a LibreOffice extension. +The key bindings can be changed in the file Accelerators.xcu. Then rebuild the extension and reinstall. +## Why a LibreOffice extension? Why not offer this functionality system-wide? +The Windows, Mac, and Linux opererating systems do not provide the keyboard with the information necessary to toggle on/off diacritics. The Hoplite Keyboard started on iOS and Android where this information *is* provided to the keyboard. So for Windows, Mac, and Linux the only way to implement this is inside applications.