Skip to content

ringawho/org-sliced-images

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 

Repository files navigation

org-sliced-images MELPA

This package displays org-mode inline images in a sliced manner, like the built-in insert-sliced-image. This improves the image scrolling experience.

Installation

Get me on MELPA! use-package example:

(use-package org-sliced-images
  :config
  (defalias 'org-remove-inline-images #'org-sliced-images-remove-inline-images)
  (defalias 'org-toggle-inline-images #'org-sliced-images-toggle-inline-images)
  (defalias 'org-display-inline-images #'org-sliced-images-display-inline-images))

The above aliases must be present regardless of how the package is loaded.

Usage

The package is intended to be used exactly like vanilla org, on account of the above aliases.

Concerning BEG and END arguments to the some of the functions, the beginning of the link to the image is the point considered.

Customization

  • org-sliced-images-consume-dummies Dummy lines are used to support slice overlays. If non-nil, lines matching dummy lines coming directly after a link will be overlaid, instead of adding new ones.
  • org-sliced-images-round-image-height If non-nil, round the height of images to be a multiple of the font height. This is useful for avoiding gaps when prefixing display lines with extra characters, as with org-indent-mode or line numbers.

Comparisons

Here's how this package compares to other attempts to make image scrolling nice.

  • iscroll: iscroll works by making you rebind your movement keys to a function that calculates and adds a vertical scroll. org-sliced-images works by inserting images as slices when they are toggled; you can then move over these slices however you want, resulting in a faster and more "native" experience.
  • pixel-scroll -based methods: These only work with the mouse wheel and are very resource intensive.

Todo

About

Smoother scrolling with sliced images in org-mode

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Emacs Lisp 100.0%