iankelling.org Git - spray/blob - Readme.org

   1 * spray.el
   2
   3 A speed reading mode for Emacs.
   4
   5 The algorithm is inspired from [[https://github.com/Miserlou/OpenSpritz][OpenSpritz]].
   6
   7
   8 ** Screencast
   9
  10 [[screencast.gif]]
  11
  12 The story continues at [[https://www.gnu.org/philosophy/right-to-read.html][gnu.org]]
  13
  14
  15 ** Deficiencies in similar projects which spray.el solves:
  16
  17 Mostly as of June 28, 2014.
  18
  19 For all other projects:
  20 - It is very difficult to save your place and come back later. Emacs has lots of built in features like bookmarks or just making a note which make this easy.
  21 - No keybinds. This is especially useful for common, quickly used functionality like pause and back up.
  22
  23 Specific projects:
  24 - https://github.com/jbmartinez/speed-readerff firefox extension.
  25 - https://github.com/cameron/squirt javascript bookmarklet.
  26 - https://github.com/Miserlou/OpenSpritz javascript bookmarklet.
  27   - Very difficult selecting where to start / what exactly to read.
  28   - Very difficult to figure out where you are within a document.
  29
  30
  31 - https://github.com/chaimpeck/spray website you paste text into.
  32   - Very difficult to figure out where you are within a document.
  33
  34 - https://github.com/xypiie/spread0r Perl program.
  35   - No apparent way to resize text.
  36   - Very difficult to figure out where you are within a document.
  37
  38
  39 - https://github.com/the-happy-hippo/sprits-it website or bookmarklet. Looks most promising of the web based projects.
  40   - Very difficult selecting where to start / what exactly to read.
  41   - Somewhat difficult to figure out where you are in a document.
  42
  43
  44 Programs that I, Ian Kelling, didn't try, and why. They also probably have a lot of the problems listed above.
  45 - https://github.com/pasky/speedread No simple way to resize text from default of too small.
  46 - https://github.com/ds300/jetzt Chrome plugin: Chrome is proprietary, and its open source version is unfriendly to linux distros so they don't package it, and it's readme does not list any benefit to this program over others.
  47 - https://github.com/Fr4ncis/openspritz-ios ios program. I don't have an ios device, and this does not appear to have any compelling features.
  48 - https://github.com/OnlyInAmerica/OpenSpritz-Android android program. If I knew how to quickly move reading material to my phone, I would try this out. But, it's readme shows that the program is pretty sparse and would have some of the same problems as listed above, so not worth it.
  49
  50
  51 Downsides compared to similar projects:
  52 - The emacs learning curve.
  53 - Would be hard to get running on a phone.
  54
  55 ** Installation
  56
  57 Put spray.el into a "load-path"ed directory, and load it in your init
  58 file.
  59
  60 : (require 'spray)
  61
  62 Then you can start spraying from the cursor position with =M-x
  63 spray-mode=. Binding some keys may also be useful.
  64
  65 : (global-set-key (kbd "<f6>") 'spray-mode)
  66
  67 ** Commands
  68
  69 In spray-mode buffers, following commands are available.
  70
  71 - =spray-start/stop= (SPC) ::
  72      pause or resume spraying
  73
  74 - =spray-backward-word= (h, <left>) ::
  75      pause and back to the last word
  76
  77 - =spray-forward-word= (l, <right>) ::
  78      inverse of =spray-backward-word=
  79
  80 - =spray-faster= (f) ::
  81      increases speed
  82
  83 - =spray-slower= (s) ::
  84      decreases speed
  85
  86 - =spray-quit= (q, <return>) ::
  87      quit =spray-mode=
  88
  89
  90 ** Customization
  91
  92 You may customize spray by modifying following items:
  93
  94 - [Variable] spray-wpm
  95 - [Variable] spray-height
  96 - [Variable] spray-margin-top
  97 - [Variable] spray-margin-left
  98 - [Variable] spray-ramp
  99 - [Keymap] spray-mode-map
 100 - [Face] spray-base-face
 101 - [Face] spray-accent-face
 102
 103 ** Algorithm details
 104
 105 *** Main algorithm code location
 106 In =./spray.el=, the functions =spray--word-at-point=, =spray--update= and =spray-start= contain the main algorithm of choosing a word, an accent character and an interval to display it. Word splitting is also duplicated the same way as in those functions throughout ./spray.el.
 107
 108 *** Algorithm translated from code to english
 109
 110 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.
 111
 112 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.
 113
 114 When started, an added delay is optionally added, based on the spray-ramp variable. See it's documentation for details.
 115
 116 The accent location is chosen as the nth character in a word, depending on its length, based on the following table
 117 | length | accent position |
 118 |      1 |               1 |
 119 |    2-5 |               2 |
 120 |    6-9 |               3 |
 121 |  10-13 |               4 |
 122 |    14+ |               5 |
 123
 124 *** Why?
 125 Based on a quick count, similar programs are implemented in 6 languages, 9 platforms and 11+ projects. Every one has a similar algorithm to choose a word, an accent character and an interval to display it. How to do that best is quite important. However, how each project does it is generally buried in unrelated code, and mostly undocumented. It is prohibitively time consuming to figure out the algorithm and differences between them for each project. This sucks. Users would like to know so they can pick one. Developers would like to know so they can get ideas and spread improvements among different projects.
 126
 127 So, I am opening a bug on every project I find, asking them to document what file and function(s) their algorithm is implemented in, and preferably to document it in english as well. This section is an example.
 128
 129
 130 ** Contributions are welcome!
 131
 132 There's lots of features and enhancements to do. The algorithm and interface could certainly be improved in various ways.