From: dalanicolai <dalanicolai@gmail.com>
To: Emacs Devel <emacs-devel@gnu.org>
Subject: Request for review `image-roll.el` for Emacs core (or ELPA)
Date: Mon, 18 Apr 2022 23:11:43 +0200 [thread overview]
Message-ID: <CACJP=3m7X1Cea33BQzddsd0qxNbwG1RzvPzv--eGY6OocRZZsw@mail.gmail.com> (raw)
[-- Attachment #1: Type: text/plain, Size: 2419 bytes --]
I have written a 'scroll/image roll' package that could be considered an
extension to image-mode.
The package provides a 'displaying' mechanism for displaying
images/documents as a single 'virtual scroll'. The main feature/advantage
of the package is that it allows for the 'much requested' continuous
scrolling.
In the package I have extracted (and improved) the 'display engine' (or
whatever to call it), from some earlier experiments of implementing
continuous scroll into doc-view and pdf-tools.
The current package can be used for displaying documents like books, but
also for displaying a selection of images. I first thought of calling it
papyrus.el (because scroll and bookroll, would clutter too much the Emacs
namespaces), but finally I thought, as it can be used to show images on a
toll, and can be considered an extension to image-mode, it would be better
to call it image-roll.el (or maybe just roll), opinions and suggestions
about the name are very welcome.
For testing, he package contains a `papyrus-demo` function that can simply
be called after loading the package (best after starting from emacs -Q).
Additionally, as a final step, and as an example of how the package can be
used, I have included an `image-roll-directory` function in the last
section (of 38 lines only) in the file, to provide an example of how the
package can be used to display all images within some directory on a 'roll'.
This is only a minimal example; as this does not have my priority, I did
not bother to make it 'fit/scale' the images.
However, I have written also an extension for `pdf-tools`, that provides a
toggle function so that users can toggle between the 'single' page
displaying, or the `image-roll` displaying. That file can be found here
<https://github.com/dalanicolai/pdf-tools/blob/papyrus-version/lisp/pdf-scroll.el>.
That file can simply be downloaded and loaded (after first setting the path
to image-roll.el at the top of the file, of course this requires pdf-tools
to be installed).
I would be happy with any feedback, and info about if and how (what is
required) this could be added to Emacs core. If you think this package is
not a good candidate for core (after the required modifications), then I
would also be happy if it could be added to ELPA (although the package on
itself is not very interesting, it should get used by 'extensions' e.g. for
pdf-tools, dired, doc-view, djvu.el etc.).
[-- Attachment #2: Type: text/html, Size: 2695 bytes --]
next reply other threads:[~2022-04-18 21:11 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-04-18 21:11 dalanicolai [this message]
2022-04-18 21:17 ` Request for review `image-roll.el` for Emacs core (or ELPA) dalanicolai
2022-04-19 5:57 ` dalanicolai
2022-04-19 7:15 ` Philip Kaludercic
2022-04-19 7:18 ` dalanicolai
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='CACJP=3m7X1Cea33BQzddsd0qxNbwG1RzvPzv--eGY6OocRZZsw@mail.gmail.com' \
--to=dalanicolai@gmail.com \
--cc=emacs-devel@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).