aboutsummaryrefslogtreecommitdiffstats
path: root/doc/misc
diff options
context:
space:
mode:
authorStefan Monnier2024-03-02 14:48:29 -0500
committerStefan Monnier2024-03-03 16:57:56 -0500
commit5254c582efb3e7171e955dde653e7530d2d3ffef (patch)
tree3d3ba6364d647e6f06db272d481f3062da4c2b37 /doc/misc
parentdb7b87867b3002d72444f06110e3625aa8de680e (diff)
downloademacs-5254c582efb3e7171e955dde653e7530d2d3ffef.tar.gz
emacs-5254c582efb3e7171e955dde653e7530d2d3ffef.zip
ox-texinfo:: Require only TEXINFO_DIR_CATEGORY
Until now @dircategory/@direntry entries were added only if both TEXINFO_DIR_CATEGORY and TEXINFO_DIR_TITLE were set. And the setting of TEXINFO_DIR_TITLE had to be careful to provide exactly the right syntax. This patch changes various things in this regard: - Only require TEXINFO_DIR_CATEGORY in order to generate `@dircategory` and `@direntry`. - Use the document title by default if TEXINFO_DIR_DESC is missing. - Use the filename by default when TEXINFO_DIR_TITLE is missing. - Try and make it harder to provide a direntry that does not have the right format or refers to a different filename than the one we're outputting to. * lisp/org/ox-texinfo.el: Remove redundant `:group` arguments. Prefer #' to quote function names. (org-texinfo-template): Use sane defaults for `@direntry`. * doc/misc/org.org (Texinfo specific export settings): Adjust accordingly.
Diffstat (limited to 'doc/misc')
-rw-r--r--doc/misc/org.org11
1 files changed, 9 insertions, 2 deletions
diff --git a/doc/misc/org.org b/doc/misc/org.org
index 05ab5b36ca0..f4590525892 100644
--- a/doc/misc/org.org
+++ b/doc/misc/org.org
@@ -15322,11 +15322,18 @@ the general options (see [[*Export Settings]]).
15322 15322
15323 #+cindex: @samp{TEXINFO_DIR_TITLE}, keyword 15323 #+cindex: @samp{TEXINFO_DIR_TITLE}, keyword
15324 The directory title of the document. 15324 The directory title of the document.
15325 This is the short name under which the ~m~ command will find your
15326 manual in the main Info directory. It defaults to the base name of
15327 the Texinfo file.
15328
15329 If you need more control, it can also be the full entry using the
15330 syntax ~* TITLE: (FILENAME).~.
15325 15331
15326- =TEXINFO_DIR_DESC= :: 15332- =TEXINFO_DIR_DESC= ::
15327 15333
15328 #+cindex: @samp{TEXINFO_DIR_DESC}, keyword 15334 #+cindex: @samp{TEXINFO_DIR_DESC}, keyword
15329 The directory description of the document. 15335 The directory description of the document.
15336 Defaults to the title of the document.
15330 15337
15331- =TEXINFO_PRINTED_TITLE= :: 15338- =TEXINFO_PRINTED_TITLE= ::
15332 15339
@@ -15422,7 +15429,7 @@ Here is an example that writes to the Info directory file:
15422 15429
15423#+begin_example 15430#+begin_example
15424,#+TEXINFO_DIR_CATEGORY: Emacs 15431,#+TEXINFO_DIR_CATEGORY: Emacs
15425,#+TEXINFO_DIR_TITLE: Org Mode: (org) 15432,#+TEXINFO_DIR_TITLE: Org Mode
15426,#+TEXINFO_DIR_DESC: Outline-based notes management and organizer 15433,#+TEXINFO_DIR_DESC: Outline-based notes management and organizer
15427#+end_example 15434#+end_example
15428 15435
@@ -15830,7 +15837,7 @@ Texinfo code.
15830,#+TEXINFO_HEADER: @syncodeindex pg cp 15837,#+TEXINFO_HEADER: @syncodeindex pg cp
15831 15838
15832,#+TEXINFO_DIR_CATEGORY: Texinfo documentation system 15839,#+TEXINFO_DIR_CATEGORY: Texinfo documentation system
15833,#+TEXINFO_DIR_TITLE: sample: (sample) 15840,#+TEXINFO_DIR_TITLE: sample
15834,#+TEXINFO_DIR_DESC: Invoking sample 15841,#+TEXINFO_DIR_DESC: Invoking sample
15835 15842
15836,#+TEXINFO_PRINTED_TITLE: GNU Sample 15843,#+TEXINFO_PRINTED_TITLE: GNU Sample