X-Git-Url: https://iankelling.org/git/?a=blobdiff_plain;f=Readme.org;h=de7876abbcb1658360a2b60da86e6d879e299903;hb=953a89d762763da1c7d408aaa20f2b73b7c512c0;hp=069f8e59f7662bd37f7017e7f17c1938167576b4;hpb=555c855bfb380aae0091cd8e6e698dfa0a40feb4;p=spray diff --git a/Readme.org b/Readme.org index 069f8e5..de7876a 100644 --- a/Readme.org +++ b/Readme.org @@ -92,6 +92,7 @@ You may customize spray by modifying following items: - [Variable] spray-height - [Variable] spray-margin-top - [Variable] spray-margin-left +- [Variable] spray-ramp - [Keymap] spray-mode-map - [Face] spray-base-face - [Face] spray-accent-face @@ -103,9 +104,11 @@ In =./spray.el=, the functions =spray--word-at-point=, =spray--update= and =spra *** Algorithm translated from code to english -Words are split at space, tab and newline characters, and if any of the characters =.!?;= appear in a word, a blank word is appended to the current word. +Words are split at space, tab, newline, and emdash characters. If any of the characters =.!?;= appear at the end of the word, a blank word is appended to the current word. -Each word is displayed for (60 / the choosen wpm) seconds, except if the word contains : or , or is greater than 9 characters long, in which case it is displayed for twice as long. +Each word is displayed for (60 / the choosen wpm) seconds, except if the word ends with ,:— or is greater than 9 characters long, in which case it is displayed for twice as long. + +When started, an added delay is optionally added, based on the spray-ramp variable. See it's documentation for details. The accent location is chosen as the nth character in a word, depending on its length, based on the following table | length | accent position |