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 17:25:19 +0300 Message-ID: <83edvvinjk.fsf@gnu.org> References: <87fsgcb5n8.fsf@mail.jao.io> <83k05nisp2.fsf@gnu.org> <87a66j7fwh.fsf@mail.jao.io> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="12187"; 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 16:29:07 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 1odY3f-0002yq-Be for geb-bug-gnu-emacs@m.gmane-mx.org; Wed, 28 Sep 2022 16:29:07 +0200 Original-Received: from localhost ([::1]:48418 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1odY3e-00017v-2W for geb-bug-gnu-emacs@m.gmane-mx.org; Wed, 28 Sep 2022 10:29:06 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:54498) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1odY0z-0007Sn-NC for bug-gnu-emacs@gnu.org; Wed, 28 Sep 2022 10:26:22 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:34956) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1odY0f-0003Iy-Vw for bug-gnu-emacs@gnu.org; Wed, 28 Sep 2022 10:26:21 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1odY0f-0007dQ-Lu for bug-gnu-emacs@gnu.org; Wed, 28 Sep 2022 10:26: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 14:26: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.166437513529315 (code B ref 58131); Wed, 28 Sep 2022 14:26:01 +0000 Original-Received: (at 58131) by debbugs.gnu.org; 28 Sep 2022 14:25:35 +0000 Original-Received: from localhost ([127.0.0.1]:34034 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1odY0F-0007cl-2k for submit@debbugs.gnu.org; Wed, 28 Sep 2022 10:25:35 -0400 Original-Received: from eggs.gnu.org ([209.51.188.92]:52840) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1odY09-0007cU-Rz for 58131@debbugs.gnu.org; Wed, 28 Sep 2022 10:25:33 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:50514) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1odY04-0003E6-Li; Wed, 28 Sep 2022 10:25:24 -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=XjZeueXZ/kHbw18ACvNBVxB85yiw1nkcwDc3JDYybDk=; b=IVxBL30vZxdZ 3y7Q0BkpVQjUkjmaMQW7FD8RamxsdNIJoWqayxeLPuNqVuB270c+8HfLOiWmvkpmf7YnQpmCZ7rwT 3gyV5avFcG90I2qqmihByN3dMzQrhz5RIBLy27akSUGutfrWYL6FrKvTVYBfvFZ8tj4KU4TlveKMP 67UDzuxq6teM/gLS/hMj77WBVO+ew24EGGAC8sigVrjtWKZC5HwCpCE6ixi3J5iTHxGl3/8W9yNtd 7uEtnjGyOU5UodXasTdjxDc/YRgbVegtW+175fC5CRL2mY8OvIybZbSMwk8kr+EKIUDJEupcGI2oP AAg93UanGBV52ECTMeg/cQ==; Original-Received: from [87.69.77.57] (port=3803 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 1odY04-0006x6-4F; Wed, 28 Sep 2022 10:25:24 -0400 In-Reply-To: <87a66j7fwh.fsf@mail.jao.io> (message from Jose A Ortega Ruiz on Wed, 28 Sep 2022 15:05:50 +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:243808 Archived-At: > From: Jose A Ortega Ruiz > Cc: 58131@debbugs.gnu.org > Date: Wed, 28 Sep 2022 15:05:50 +0100 > > >> +(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'. > > > > Will users immediately understand what you mean by "document section > > title" here? If no, perhaps a sentence explaining what that is would > > be beneficial. > > 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. > >> +(defcustom doc-view-imenu-flatten nil > >> + "Whether to generate a flat list of sections instead of a nested tree." > > > > This doesn't mention imenu in the doc string; should it? > > Given that the name of the variable does, i think mentioning it would > just make that first sentence longer without adding too much > information. But again, as the implementor of the functionality, > everything feels "obvious" to me. My suggestion is Whether to flatten the list of sections in an imenu or show it nested.