unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: dieter@duenenhof-wilhelm.de (H. Dieter Wilhelm)
To: Drew Adams <drew.adams@oracle.com>
Cc: Stefan Monnier <monnier@iro.umontreal.ca>, emacs-devel@gnu.org
Subject: Re: [ELPA] New package: inform
Date: Fri, 08 May 2020 20:53:42 +0200	[thread overview]
Message-ID: <86imh6i7gp.fsf@duenenhof-wilhelm.de> (raw)
In-Reply-To: <2f8bf7aa-7160-44b0-9c7b-1ba97adb4496@default> (Drew Adams's message of "Fri, 8 May 2020 09:23:59 -0700 (PDT)")

Drew Adams <drew.adams@oracle.com> writes:

>> I assume it would be easier to create a collection of all
>> (important?)  Elisp related documents than the opposite.  Is it
>> possible to ask Emacs package archives programmatically which texinfo
>> docs are included?
>
> In `help-fns+.el' I do something similar: providing links to manual
> sections in `*Help*' output.  I handle the question of which manuals
> to treat with this user option:

I downloaded help-fns+.el and it provides, among other things, the
inverse functionality of inform: It is putting Info links in *Help*
buffers. :-) Which is a georgeous idea because herewith the
documentation loop between Help and Info documentation seems to be
closed, at least for many, many symbols! :-)

> ___
>
> help-cross-reference-manuals is a variable defined in `help-fns+.el'.
> Its value is (("emacs" "elisp"))

Oh, that means (("emacs" "elisp") nil), OK further

> Documentation: Manuals to search, for a `*Help*' buffer link to the
> manuals.  A cons.
>
>  The car is a list of manuals to search, or the symbol `all', to
>   search all.  If nil, then do not create a cross-reference link.
>
>  The cdr is a boolean:
>
>   Non-`nil' means search the manuals, then create a cross-ref link:
>         create it only if some search hits are found.
>
>   `nil' means create a cross-ref link without searching manuals
>         first (but only if there are some manuals to search).
    :set #'(lambda (sym defs) (custom-set-default sym defs) (setq Info-indexed-nodes ()))

Hmm, a setter function, why, that's over my horizon...

    :type '(cons
            (choice :tag "Which Manuals"
             (repeat :tag "Specific Manuals (files)" string) (const :tag
             "All Manuals" all))
            (boolean :tag "Search Before Creating Button?"))

Aha, I learned how to influence `customize' in a non trivial way, thank
you Drew.

> IOW, the car of the value is a whitelist of manuals to handle in this
> regard.
>
> The default value corresponds to what Stefan suggested for inform.el's
> links in Info: the manuals known to always be appropriate for such
> handling: Emacs, Elisp.
>
> Different users have different sets of Info manuals.  It's quite
> possible that some will have manuals that are similar to the Emacs and
> Elisp manuals in this regard.  They can just add them to the list of
> manuals to handle.  (And they can remove manuals from the list, of
> course.)

I agree that white- or blacklists should be customisable.

> You might want to have a user option for what you're considering wrt
> Info links: a whitelist of the manuals to treat.

Are you telling me that I can use, in these situtations, one variable
for two purposes?  1) For specifying and changing the list and 2)
switching a linking for lists off and on?

  '((list members) t) ; only these
  '((other members) nil) ; none of these
  '('all nil) ; no links
  '('all t) ; link everything?

Thanks
        Dieter

-- 
Best wishes
H. Dieter Wilhelm
Zwingenberg, Germany



  parent reply	other threads:[~2020-05-08 18:53 UTC|newest]

Thread overview: 35+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-05-07 19:36 [ELPA] New package: inform H. Dieter Wilhelm
2020-05-07 20:40 ` Stefan Monnier
2020-05-08  1:34   ` T.V Raman
2020-05-08  8:29     ` H. Dieter Wilhelm
2020-05-08  8:18   ` H. Dieter Wilhelm
2020-05-08 10:25     ` Eli Zaretskii
2020-05-08 11:06       ` H. Dieter Wilhelm
2020-05-08 11:39         ` Eli Zaretskii
2020-05-08 13:45         ` H. Dieter Wilhelm
2020-05-08 14:01           ` Eli Zaretskii
2020-05-08 15:04           ` Stefan Monnier
2020-05-10 18:19             ` H. Dieter Wilhelm
2022-12-25  9:39               ` Ihor Radchenko
2022-12-26  0:10                 ` Stefan Monnier
2022-12-26 20:41                   ` H. Dieter Wilhelm
2022-12-27 10:54                     ` Ihor Radchenko
2022-12-27 22:38                       ` H. Dieter Wilhelm
2020-05-08 11:45       ` Maurizio Boriani
2020-05-08 16:23     ` Drew Adams
2020-05-08 16:38       ` Drew Adams
2020-05-08 18:53       ` H. Dieter Wilhelm [this message]
2020-05-08 21:55         ` Drew Adams
2020-05-08 22:02           ` Drew Adams
2020-05-09  9:46       ` Jean-Christophe Helary
2020-05-09 13:06         ` help-fns+ (WAS: [ELPA] New package: inform) Noam Postavsky
2020-05-09 13:16           ` Jean-Christophe Helary
2020-05-09 17:27         ` [ELPA] New package: inform Drew Adams
2020-05-10  1:05           ` Jean-Christophe Helary
2020-05-09 17:10   ` H. Dieter Wilhelm
2023-02-01 19:08   ` H. Dieter Wilhelm
2023-02-01 19:21     ` H. Dieter Wilhelm
2020-05-09  3:51 ` Richard Stallman
2020-05-09  9:38   ` H. Dieter Wilhelm
2020-05-09  9:51     ` Eli Zaretskii
2020-05-09 15:29       ` H. Dieter Wilhelm

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=86imh6i7gp.fsf@duenenhof-wilhelm.de \
    --to=dieter@duenenhof-wilhelm.de \
    --cc=drew.adams@oracle.com \
    --cc=emacs-devel@gnu.org \
    --cc=monnier@iro.umontreal.ca \
    /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).