From: Jose A Ortega Ruiz <jao@gnu.org>
To: 58131@debbugs.gnu.org
Subject: bug#58131: [PATCH] docview: new customization options for imenu
Date: Wed, 28 Sep 2022 03:21:31 +0100 [thread overview]
Message-ID: <87fsgcb5n8.fsf@mail.jao.io> (raw)
[-- Attachment #1: Type: text/plain, Size: 760 bytes --]
Tags: patch
A follow up to bug#58103 with a little fix for section title extraction
and a couple of easy to implement customizable options. I've tried to
document them clearly enough in the docstrings and then just mention
their existence in the manual: is that a good practice or do we prefer
some duplication?
Cheers,
jao
In GNU Emacs 29.0.50 (build 20, x86_64-pc-linux-gnu, cairo version
1.16.0) of 2022-09-27 built on rivendell
Repository revision: 7368cdd359325cb6ed83688178ae4b4eaf22f4d5
Repository branch: master
Windowing system distributor 'The X.Org Foundation', version 11.0.12101004
System Description: Debian GNU/Linux bookworm/sid
Configured using:
'configure --prefix=/usr/local/stow/emacs29 --with-x-toolkit=no
--with-imagemagick -C'
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-docview-new-customization-options-for-imenu.patch --]
[-- Type: text/patch, Size: 3979 bytes --]
From a434024c4e452b4f2495921832b00e801568939e Mon Sep 17 00:00:00 2001
From: Jose A Ortega Ruiz <jao@gnu.org>
Date: Wed, 28 Sep 2022 03:02:57 +0100
Subject: [PATCH] docview: new customization options for imenu
* doc/emacs/misc.texi (DocView Navigation):
* lisp/doc-view.el (doc-view-imenu-title-format, doc-view-imenu-flatten):
(doc-view--imenu-subtree): customizable format for imenu entry titles,
and flag to disable nested submenus.
* lisp/doc-view.el (doc-view--pdf-outline): clean up whitespace
markers '\r' and '\t' in imenu item titles.
---
doc/emacs/misc.texi | 9 +++++++--
lisp/doc-view.el | 29 +++++++++++++++++++++++++----
2 files changed, 32 insertions(+), 6 deletions(-)
diff --git a/doc/emacs/misc.texi b/doc/emacs/misc.texi
index 04f7f2e921..cef2580f3b 100644
--- a/doc/emacs/misc.texi
+++ b/doc/emacs/misc.texi
@@ -585,11 +585,16 @@ DocView Navigation
@code{doc-view-resolution}.
@vindex doc-view-imenu-enabled
+@vindex doc-view-imenu-flatten
+@vindex doc-view-imenu-format
When the @command{mutool} program is available, DocView will use it
to generate entries for an outline menu, making it accessible via the
@code{imenu} facility (@pxref{Imenu}). To disable this functionality
-even when @command{mutool} can be found on your system, customize
-the variable @code{doc-view-imenu-enabled} to the @code{nil} value.
+even when @command{mutool} can be found on your system, customize the
+variable @code{doc-view-imenu-enabled} to the @code{nil} value. You
+can further customize how @code{imenu} items are formatted and
+displayed using the variables @code{doc-view-imenu-format} and
+@code{doc-view-flatten}.
@node DocView Searching
@subsection DocView Searching
diff --git a/lisp/doc-view.el b/lisp/doc-view.el
index fa583df12b..9e3bb6e46c 100644
--- a/lisp/doc-view.el
+++ b/lisp/doc-view.el
@@ -219,6 +219,23 @@ doc-view-imenu-enabled
:type 'boolean
:version "29.1")
+(defcustom doc-view-imenu-title-format "%t (%p)"
+ "Format string for document section titles in imenu.
+
+The special markers '%t' and '%p' are replaced by the section
+title and page number in this format string, which uses
+`format-spec'.
+
+For instance, setting this variable to \"%t\" will produce items
+showing only titles and no page number."
+ :type 'string
+ :version "29.1")
+
+(defcustom doc-view-imenu-flatten nil
+ "Whether to generate a flat list of sections instead of a nested tree."
+ :type 'boolean
+ :version "29.1")
+
(defcustom doc-view-svg-background "white"
"Background color for svg images.
See `doc-view-mupdf-use-svg'."
@@ -1898,7 +1915,8 @@ doc-view--pdf-outline
(goto-char (point-min))
(while (re-search-forward doc-view--outline-rx nil t)
(push `((level . ,(length (match-string 1)))
- (title . ,(match-string 2))
+ (title . ,(replace-regexp-in-string "\\\\[rt]" " "
+ (match-string 2)))
(page . ,(string-to-number (match-string 3))))
outline)))
(nreverse outline)))
@@ -1911,11 +1929,14 @@ doc-view--imenu-subtree
level. Returns that imenu alist together with any other pending outline
entries at an upper level."
(let ((level (alist-get 'level (car outline)))
+ (nested (not doc-view-imenu-flatten))
(index nil))
- (while (and (car outline) (<= level (alist-get 'level (car outline))))
+ (while (and (car outline)
+ (or nested (<= level (alist-get 'level (car outline)))))
(let-alist (car outline)
- (let ((title (format "%s (%s)" .title .page)))
- (if (> .level level)
+ (let ((title (format-spec doc-view-imenu-title-format
+ `((?t . ,.title) (?p . ,.page)))))
+ (if (and nested (> .level level))
(let ((sub (doc-view--imenu-subtree outline act))
(fst (car index)))
(setq index (cdr index))
--
2.37.2
[-- Attachment #3: Type: text/plain, Size: 130 bytes --]
--
Too often we enjoy the comfort of opinion without the discomfort of
thought. -John F. Kennedy, 35th US president (1917-1963)
next reply other threads:[~2022-09-28 2:21 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-09-28 2:21 Jose A Ortega Ruiz [this message]
2022-09-28 11:08 ` bug#58131: [PATCH] docview: new customization options for imenu Lars Ingebrigtsen
2022-09-28 12:34 ` Eli Zaretskii
2022-09-28 14:05 ` Jose A Ortega Ruiz
2022-09-28 14:25 ` Eli Zaretskii
2022-09-28 15:14 ` Jose A Ortega Ruiz
2022-09-28 15:49 ` Eli Zaretskii
2022-09-28 15:55 ` Jose A Ortega Ruiz
2022-09-28 16:01 ` Eli Zaretskii
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=87fsgcb5n8.fsf@mail.jao.io \
--to=jao@gnu.org \
--cc=58131@debbugs.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).