From: Ihor Radchenko <yantar92@posteo.net>
To: Stefan Monnier <monnier@iro.umontreal.ca>
Cc: emacs-orgmode@gnu.org
Subject: Re: Provide sane default for the @direntry
Date: Wed, 06 Mar 2024 11:17:30 +0000 [thread overview]
Message-ID: <87bk7r38z9.fsf@localhost> (raw)
In-Reply-To: <jwv5xy04h16.fsf-monnier+emacs@gnu.org>
Stefan Monnier <monnier@iro.umontreal.ca> writes:
> New version of the patch, which I believe address your comments.
Thanks!
The patches are against Emacs git repository, not against Org mode. May
your please port them?
See some more minor comments inline.
> Subject: [PATCH 1/2] * lisp/org/ox-texinfo.el: Remove redundant `:group`s
By our convention, we drop leading * in the first line of the commit message.
> ...
> * lisp/org/ox-texinfo.el (texinfo): Add entry for TEXINFO_DIR_NAME.
> (org-texinfo-template): Use sane defaults for `@direntry` and `@dircategory`.
>
> * doc/misc/org.org (Texinfo specific export settings): Adjust accordingly.
* etc/ORG-NEWS changelog entry is missing.
> +- =TEXINFO_DIR_NAME= ::
> +
> + #+cindex: @samp{TEXINFO_DIR_NAME}, keyword
> + The directory name of the document.
> + This is the short name under which the ~m~ command will find your
> + manual in the main Info directory. It defaults to the base name of
> + the Texinfo file.
> +
> + The full form of the Texinfo entry is ~* DIRNAME: NODE.~ where ~NODE~
> + is usually just ~(FILENAME)~. Normally this option only provides the
> + ~DIRNAME~ part, but if you need more control, it can also be the full
> + entry (recognized by the presence of parentheses or a leading ~* ~).
>
> - =TEXINFO_DIR_TITLE= ::
>
> #+cindex: @samp{TEXINFO_DIR_TITLE}, keyword
> - The directory title of the document.
> + Old and obsolete name of the =TEXINFO_DIR_NAME= option.
We can simply remove TEXINFO_DIR_TITLE from the manual.
Also, please update "Info directory file" section. In particular,
references to TEXINFO_DIR_TITLE.
> + (dn (or (plist-get info :texinfo-dirname)
> + (plist-get info :texinfo-dirtitle))) ;Obsolete name.
> + ;; Strip any terminating `.' from `dn'.
> + (dn (if (string-match "\\.\\'" dn) (substring dn 0 -1) dn))
`string-match' will throw an error when both :texinfo-dirname and
:texinfo-dirtitle records are not provided (nil).
--
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>
next prev parent reply other threads:[~2024-03-06 11:14 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-02-28 0:19 Provide sane default for the @direntry Stefan Monnier
2024-02-28 10:35 ` Ihor Radchenko
2024-03-02 20:01 ` Stefan Monnier
2024-03-04 11:09 ` Ihor Radchenko
2024-03-04 16:16 ` Stefan Monnier
2024-03-05 12:49 ` Ihor Radchenko
2024-03-05 19:27 ` Stefan Monnier
2024-03-06 11:17 ` Ihor Radchenko [this message]
2024-03-06 15:00 ` Stefan Monnier
2024-03-07 13:46 ` Ihor Radchenko
2024-03-08 8:09 ` Stefan Monnier
2024-03-08 10:49 ` Ihor Radchenko
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.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87bk7r38z9.fsf@localhost \
--to=yantar92@posteo.net \
--cc=emacs-orgmode@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/org-mode.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).