From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#58131: [PATCH] docview: new customization options for imenu Date: Wed, 28 Sep 2022 18:49:58 +0300 Message-ID: <83bkqzijmh.fsf@gnu.org> References: <87fsgcb5n8.fsf@mail.jao.io> <83k05nisp2.fsf@gnu.org> <87a66j7fwh.fsf@mail.jao.io> <83edvvinjk.fsf@gnu.org> <877d1n7cqi.fsf@mail.jao.io> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="2627"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 58131@debbugs.gnu.org To: Jose A Ortega Ruiz Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Wed Sep 28 19:14:18 2022 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1odadV-0000YP-LC for geb-bug-gnu-emacs@m.gmane-mx.org; Wed, 28 Sep 2022 19:14:17 +0200 Original-Received: from localhost ([::1]:56978 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1odadT-0007vX-Lg for geb-bug-gnu-emacs@m.gmane-mx.org; Wed, 28 Sep 2022 13:14:15 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:35224) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1odZKx-0001Ak-BT for bug-gnu-emacs@gnu.org; Wed, 28 Sep 2022 11:51:03 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:35205) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1odZKx-0005Xe-31 for bug-gnu-emacs@gnu.org; Wed, 28 Sep 2022 11:51:03 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1odZKv-0003ff-TZ for bug-gnu-emacs@gnu.org; Wed, 28 Sep 2022 11:51:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 28 Sep 2022 15:51:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 58131 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 58131-submit@debbugs.gnu.org id=B58131.166438021114023 (code B ref 58131); Wed, 28 Sep 2022 15:51:01 +0000 Original-Received: (at 58131) by debbugs.gnu.org; 28 Sep 2022 15:50:11 +0000 Original-Received: from localhost ([127.0.0.1]:34281 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1odZK6-0003e7-RG for submit@debbugs.gnu.org; Wed, 28 Sep 2022 11:50:11 -0400 Original-Received: from eggs.gnu.org ([209.51.188.92]:46350) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1odZK5-0003dt-7f for 58131@debbugs.gnu.org; Wed, 28 Sep 2022 11:50:10 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:42446) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1odZJz-0005ME-AC; Wed, 28 Sep 2022 11:50:03 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=References:Subject:In-Reply-To:To:From:Date: mime-version; bh=8R1kZSjGqL+U9m67MBHe2XHDyNGoij/Xf6lBVH8IAnY=; b=hF6I0RwGbyDa HYTNUChAalwJ0gZf/JdNoJQuZpczs+leDnTGqRS0ryEv3V9DkUlX47H9e9R6BXOk29UjOe18KVSrI DMa40PQ57qLCc/ldllrI21UjHJWUYAnwEK4RV5UgoeQ651Km+zPDdTPU2rjxMcj/c1Sp0B2lkDyYL LEtAXcXMhII74bDs1oFOrh0MCKX41jdQ8bFh31W7r8HA3IU6vFM8VbG6eu8eo2D8RHeDWIsSG1K1b JXEBtzWzcWIlZE6qIKpFezxTLCl9nCASkDLoKl3UgiRUgpLXZyfXBFacaT7pgFzBQ0KXNiRD7TSNh XGIj2YW8kume4ghleVw8DQ==; Original-Received: from [87.69.77.57] (port=1041 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1odZJy-0000xF-Js; Wed, 28 Sep 2022 11:50:03 -0400 In-Reply-To: <877d1n7cqi.fsf@mail.jao.io> (message from Jose A Ortega Ruiz on Wed, 28 Sep 2022 16:14:13 +0100) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.io gmane.emacs.bugs:243832 Archived-At: > From: Jose A Ortega Ruiz > Cc: 58131@debbugs.gnu.org > Date: Wed, 28 Sep 2022 16:14:13 +0100 > > >> I would say they will: in the context of a docview imenu for a PDF > >> document, there's little else it could reasonably be. But i'm biased: do > >> you think otherwise? > > > > FWIW, I couldn't understand what that means. > > > > How does being in the context of docview imenu for a PDF document help > > understanding that here? "Document section title" is general enough > > terminology. Using a "construct state" here doesn't help, either. > > To me, the context is that this is read by a user of the functionality, > wanting to fine-tune it (i rarely start exploring a functionality by > reading the docstring of one of its customizable variables). Think about the various Help commands, such as 'apropos': they show the doc strings or just their first sentence entirely out of any context. Users who invoke such commands should be capable to understand at a glance whether the command/variable is something they should examine further. So having important keywords in there helps immensely to make such triage steps much faster and more efficient. > Barring that: the Imenu section of the manual calls the items being > formatted here simply "definitions". If we assume that the user knows > about imenu in general, one could have: > > "Format string for the imenu definitions extracted from documents." > > Or, perhaps, trying to provide the missing context for not-yet-users: > > "Format string for the section titles extracted by imenu from docview documents." > > Any better? Yes, thanks. My suggestion is a very minor variation of the latter: Format spec for imenu's display of section titles from docview documents.