Re: Provide sane default for the @direntry

[Ihor Radchenko]

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>