rope-read-mode

https://github.com/marcowahl/rope-read-mode.git

git clone 'git://github.com/marcowahl/rope-read-mode.git'


---

What rope-read-mode is

rope-read-mode reverses every other line in the visible part of a buffer. When every other line has been reversed reading is like following a rope.

Illustration

Benefits

• rope-read-mode often allows fluent reading by finding the start of the next line easily.
• Have an alternative view on text.
• Have fun.

Price

Typically you need to invest some time to learn to read upside-down lines.

Usage

Type M-x rope-read-mode in a buffer and see how the transformation performs.

Interrupt rope-read-mode any time with C-g. Type M-x rope-read-mode again or press ‘q’ to leave the mode.

When rope-read-mode is active you can use any method to reach a location of interest followed by a press on ‘g’ to trigger a refresh of the view.

In rope-read-mode you can use:

• q to quit.
• SPC / S-SPC to scroll a screen.
• v / V y to scroll one line.
• g to refresh rope read.
• ? to open the help buffer.

For convenience command rope-read-mode can be bound to a key sequence. For example to activate or deactivate rope-read-mode by pressing scroll lock two times use the line

(global-set-key (kbd "<Scroll_Lock> <Scroll_Lock>") 'rope-read-mode)

Image files

The reverse representation of lines is realized with images. They get collected in directory rope-read-image-overlay-path. You can delete this directory any time.

Install

Emacs Package

When installed as Emacs package then there is no need of a special configuration.

Install from el file

If you just have the emacs-lisp file then:

• load the file into Emacs
• do M-x eval-buffer

That's it. You installed rope-read-mode and M-x rope-read-mode is available.

Dependencies

• Emacs is running under X.
• The programm convert of the ImageMagick-suite is available.

The convert program has the job to create images of lines and rotate them.

Development

Known Bugs

• rope-read-mode sometimes spontaneously fails.
  • In this case a refresh with ‘g’ might help.
  • You can always try ‘C-g q’ and start again.
• rope-read-mode often does not work for org-mode files.
  • Possibly this is due to the interference of overlays of org and rope-read.

Wishes

• Quicker transformation.

Vision

rope-read-mode gets rope-mode which allows also editing. rope-mode would provide a further possibility for the user to use Emacs, just as changing the default font.

Lentic Literate Style

This program is written in emacs lisp in lentic style based on the ‘lentic’ package .

This means the that this file can be regarded just as an emacs lisp file. But actually this file contains extra comments which allow the interpretation of the file as Org file. Lentic-mode makes it easy to write this style.

A possible initialization of lentic is this:

(global-lentic-start-mode)

Find more about lentic at .

Communication

Use the GitHub infrastructure i.e. pull requests or https://github.com/marcowahl/rope-read-mode/issues. Or contact the author directly.

Contribution

Contributions in any respect are welcome, e.g. ideas and improvements.

Contributors

Syohei YOSHIDA

Marco WAHL

Links

• rope-read for firefox at https://greasyfork.org/en/scripts/10634-rope-read

• ‘spray’ which is available as Elpa package realizes another alternative view mode.

• ‘fliptext’ which also is available as Elpa package realizes an

  ˙ʇxǝʇ pǝddılɟ ɹoɟ poɥʇǝɯ-ʇnduı

History

201501151211	v0.1 New option rope-read-calculate-exact-y-coordinates
201501311657	v0.2 Replace whenever a line is ready
201503160841	Dropped option heuristic y-coordinates calculation
201503161010	v0.3 Operations based on visual movement-commands