From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp1.migadu.com ([2001:41d0:303:e16b::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms13.migadu.com with LMTPS id YA8aIc46ymblnQAA62LTzQ:P1 (envelope-from ) for ; Sat, 24 Aug 2024 19:55:58 +0000 Received: from aspmx1.migadu.com ([2001:41d0:303:e16b::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp1.migadu.com with LMTPS id YA8aIc46ymblnQAA62LTzQ (envelope-from ) for ; Sat, 24 Aug 2024 21:55:58 +0200 X-Envelope-To: larch@yhetil.org Authentication-Results: aspmx1.migadu.com; dkim=fail ("body hash did not verify") header.d=adamkovic.org header.s=fm2 header.b="b cySVAx"; dkim=fail ("body hash did not verify") header.d=messagingengine.com header.s=fm1 header.b=d42v4pCd; spf=pass (aspmx1.migadu.com: domain of "emacs-orgmode-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="emacs-orgmode-bounces+larch=yhetil.org@gnu.org"; dmarc=fail reason="SPF not aligned (relaxed)" header.from=adamkovic.org (policy=none) ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1724529358; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type:in-reply-to:in-reply-to: references:references:list-id:list-help:list-unsubscribe: list-subscribe:list-post:dkim-signature; bh=Mn5aKs5q5i4ZCeMx3aVIKstNBSD0L/07aHUv9I4VKMc=; b=nkWmxt1/DZHWWyi5to/CWIRm78s+3tP7Wwop7Gl5MFvo29WyINkvKTM1yXKmpBLZIsiWAr 1hPohOiL+8JALVudCSsvcOwNfz5z+8hJ3QhJxH9NiXXYEpjy8oy3maXR8FLDEZD5HqD5sp cDIGa76LGt8ntfF0A0wcjTH0AGWY0Ohjd1fY7YAqCDBlmOfbEX5SST23Lj0nuMjRudbFCU Y9DpC19GWiMJbwtOaO2ZbOa9kgpC3CFepZfss4hvqKs2mwjVgHy1mhWMwg5zHl1p3Ka8U1 BVzEW3LPGL9KFknMtGpIy0KuCxVhbswsfqCOV7fouOsVU2G+er2vht85P9m0cQ== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=fail ("body hash did not verify") header.d=adamkovic.org header.s=fm2 header.b="b cySVAx"; dkim=fail ("body hash did not verify") header.d=messagingengine.com header.s=fm1 header.b=d42v4pCd; spf=pass (aspmx1.migadu.com: domain of "emacs-orgmode-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="emacs-orgmode-bounces+larch=yhetil.org@gnu.org"; dmarc=fail reason="SPF not aligned (relaxed)" header.from=adamkovic.org (policy=none) ARC-Seal: i=1; s=key1; d=yhetil.org; t=1724529358; a=rsa-sha256; cv=none; b=MKWlUmP7xpVyv1htQ1wsR8/PdvMPsz4IgC4CJZLcQLB2m/bORA/2YvfHPtR/LoJpHVtayH 7xkXYYMPJqESuxK0Adpa5lGSWFe6JTfJ6Fx0dKhPwyrTa6v8foOZaBqgNP2ucEPJLzAeaq 2McWbTsTliN6Gnv/8c47V5uwRpJk0Nv1KS2+8+DHXKFWqcUnvbZ5xbR2Zgj7ZpN00wDlr+ gvItR/B3/Cq/9CWtvwNmnN9ogiSM2e+EllMKyop3n+j2WHRkieEQuFPuZwW0lctvhEDHlW Hjh4v4mb4QaoclRKDRuaT8QNCJ9QlvidF3xvsnwEn5nncBgbtzFCk+HzqFAU6A== Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 5FC5B670E9 for ; Sat, 24 Aug 2024 21:55:57 +0200 (CEST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1shwqj-0008W3-Eb; Sat, 24 Aug 2024 15:55:01 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1shwqh-0008Vq-92 for emacs-orgmode@gnu.org; Sat, 24 Aug 2024 15:54:59 -0400 Received: from fout5-smtp.messagingengine.com ([103.168.172.148]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1shwqd-0008FQ-I0 for emacs-orgmode@gnu.org; Sat, 24 Aug 2024 15:54:59 -0400 Received: from phl-compute-05.internal (phl-compute-05.nyi.internal [10.202.2.45]) by mailfout.nyi.internal (Postfix) with ESMTP id 6508B1390C58; Sat, 24 Aug 2024 15:54:54 -0400 (EDT) Received: from phl-mailfrontend-01 ([10.202.2.162]) by phl-compute-05.internal (MEProxy); Sat, 24 Aug 2024 15:54:54 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=adamkovic.org; h=cc:cc:content-type:content-type:date:date:from:from :in-reply-to:in-reply-to:message-id:mime-version:references :reply-to:subject:subject:to:to; s=fm2; t=1724529294; x= 1724615694; bh=mQ38sqe9M6NfHnY8/mli1edoZgh3Zz2w7uugyUdMuRs=; b=b cySVAxMBpkoFrH7/4vEZ1lPmZ8ZLthXWhqNHklUP0vvOCiBfhiVN2FdUWF5X3Yp8 wtOxbNRVxGXN8Z/DMXGcw8ftAKjPHRvvruS9G1Y4bf1lMIMXoGkyPDDg3vtogh46 nUVYYzl+RjSjk6zRckJ78Tfe9t8x4elv23eXiOdvR4qp1QiUwpObq72na+nswJV7 Z9aLpvv9hnjjwGiadk/ZwyueS9Fyh5rxIccgnXKUEoX9xOS2sPJNT1ZTpOfJl5sN 08vsi1MMXjTv3L4gbJ2h8TaK516kwlMcXdHitOCWBbbL6leH4FuygJSC28QZZTC1 qT7lYBw0DTSFoQsl/XSuA== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:cc:content-type:content-type:date:date :feedback-id:feedback-id:from:from:in-reply-to:in-reply-to :message-id:mime-version:references:reply-to:subject:subject:to :to:x-me-proxy:x-me-proxy:x-me-sender:x-me-sender:x-sasl-enc; s= fm1; t=1724529294; x=1724615694; bh=mQ38sqe9M6NfHnY8/mli1edoZgh3 Zz2w7uugyUdMuRs=; b=d42v4pCdEKZfaMQ7lTEf3jtFthLCIcWKUvcr+Azk+IvX JUnyniuktHJS+8jMTvYX6ueJNZc+YRHmawtVYJTS9n4oM577kwa5Qvmj78NL8aiE jN5uu+wGeRqGrrvaJISKv5/zuKQE2cdWQsvpzgYSG3UeFvb0E6Q/dGue8Kmovehx xUNtHGW0Q9YuJOFXmbtQ8H6ygnsZy6O5BDrw6vuqMCPGCx/JQFKXK1Ny5iIDjcth 4dmQ434xjU2XyBr8eGaQbtSzghz/n8bEOqgWUXui6kT33XjTgLPlIgHtMQV0mRnt 5tfJ35ZmHu+Xg/X+q6GO2ME7a3OgbEOvjGRNLAxsDA== X-ME-Sender: X-ME-Received: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgeeftddruddvgedgudegfecutefuodetggdotefrod ftvfcurfhrohhfihhlvgemucfhrghsthforghilhdpggftfghnshhusghstghrihgsvgdp uffrtefokffrpgfnqfghnecuuegrihhlohhuthemuceftddtnecunecujfgurhephffvuf gjfhevfffkgggtsehmtderredttdejnecuhfhrohhmpeftuhguohhlfhcutegurghmkhho vhhitgcuoehruhguohhlfhesrggurghmkhhovhhitgdrohhrgheqnecuggftrfgrthhtvg hrnhephfefudfgveehieejudfhudfhveffleffgfejvdetgedvjeevtedtkeelhfehgedv necuvehluhhsthgvrhfuihiivgeptdenucfrrghrrghmpehmrghilhhfrhhomheprhhuug holhhfsegruggrmhhkohhvihgtrdhorhhgpdhnsggprhgtphhtthhopedvpdhmohguvgep shhmthhpohhuthdprhgtphhtthhopeihrghnthgrrhelvdesphhoshhtvghordhnvghtpd hrtghpthhtohepvghmrggtshdqohhrghhmohguvgesghhnuhdrohhrgh X-ME-Proxy: Feedback-ID: i88214938:Fastmail Received: by mail.messagingengine.com (Postfix) with ESMTPA; Sat, 24 Aug 2024 15:54:53 -0400 (EDT) From: Rudolf =?utf-8?Q?Adamkovi=C4=8D?= To: emacs-orgmode@gnu.org Subject: [PATCH v3] Improvements to Texinfo exporter (was: [PATCH] Re: Texinfo: Custom navigation and links in headings) In-Reply-To: References: CC: yantar92@posteo.net Date: Sat, 24 Aug 2024 21:54:51 +0200 Message-ID: MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Received-SPF: pass client-ip=103.168.172.148; envelope-from=rudolf@adamkovic.org; helo=fout5-smtp.messagingengine.com X-Spam_score_int: -27 X-Spam_score: -2.8 X-Spam_bar: -- X-Spam_report: (-2.8 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, RCVD_IN_VALIDITY_SAFE_BLOCKED=0.001, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-orgmode@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+larch=yhetil.org@gnu.org Sender: emacs-orgmode-bounces+larch=yhetil.org@gnu.org X-Migadu-Country: US X-Migadu-Flow: FLOW_IN X-Migadu-Queue-Id: 5FC5B670E9 X-Migadu-Scanner: mx13.migadu.com X-Migadu-Spam-Score: -5.48 X-Spam-Score: -5.48 X-TUID: 7CWwDaqCNcfs --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Rudolf Adamkovi=C4=8D writes: > I will fix the bug today. And fixed. CHANGE 1/3 I split `ALT_NAVIGATION' to =20=20 `ALT_NEXT' `ALT_PREVIOUS' `ALT_UP' =20=20 to support commas in node names. =20=20 (I am open to renaming to `TEXINFO_UP', etc.) CHANGE 2/3 I added a 3rd patch that makes =20=20 numeric values of `toc' in `#+OPTIONS' =20=20 work out of the box, like in e.g. HTML exports. CHANGE 3/3 Further, I improved commit messages, documentation, and the like. Ready for review ... again! Rudy --=-=-= Content-Type: text/x-patch Content-Disposition: attachment; filename=0001-ox-texinfo-Support-alternative-navigation.patch >From 7a8692ec67360414143524d49a098fd99fce03a3 Mon Sep 17 00:00:00 2001 From: Rudolf Adamkovic Date: Sat, 24 Aug 2024 21:35:44 +0200 Subject: [PATCH 1/3] ox-texinfo: Support alternative navigation * doc/org-manual.org (Headings and sectioning structure): Describe the new feature. * etc/ORG-NEWS (Texinfo exports can use alternative navigation): Announce the new feature. * lisp/ox-texinfo.el (org-texinfo-headline, org-texinfo-template): Use the `ALT_NEXT', `ALT_PREVIOUS', and `ALT_UP' Org properties when generating Texinfo @node lines for Next, Previous, and Up pointers. * testing/lisp/test-ox-texinfo.el (test-ox-texinfo/alt-title, test-ox-texinfo/alt-navigation/all-directions, test-ox-texinfo/alt-navigation/one-direction, test-ox-texinfo/alt-navigation/no-directions, test-ox-texinfo/alt-navigation/with-alt-title, test-ox-texinfo/alt-navigation/top/default, test-ox-texinfo/alt-navigation/top/default): Test the new feature to avoid regressions in the future. --- doc/org-manual.org | 20 +++ etc/ORG-NEWS | 8 + lisp/ox-texinfo.el | 103 +++++++----- testing/lisp/test-ox-texinfo.el | 290 ++++++++++++++++++++++++++++++++ 4 files changed, 382 insertions(+), 39 deletions(-) diff --git a/doc/org-manual.org b/doc/org-manual.org index 9365c66b1..049454624 100644 --- a/doc/org-manual.org +++ b/doc/org-manual.org @@ -15999,6 +15999,26 @@ the node in which a reader enters an Info manual. As such, it is expected not to appear in printed output generated from the =.texi= file. See [[info:texinfo::The Top Node]], for more information. +#+cindex: @samp{ALT_NEXT}, property +#+cindex: @samp{ALT_PREVIOUS}, property +#+cindex: @samp{ALT_UP}, property +Texinfo automatically sets the /Next/, /Previous/, and /Up/ pointers, +reflecting the hierarchy of your document. If you want to use a +different hierarchy, or no hierarchy at all, set the =ALT_NEXT=, +=ALT_PREVIOUS=, and =ALT_UP= properties to the relevant titles. For +example: + +#+begin_example +,* Mathematical Logic + :PROPERTIES: + :ALT_TITLE: Logic + :END: +,* Proposition + :PROPERTIES: + :ALT_UP: Logic + :END: +#+end_example + *** Indices :PROPERTIES: :DESCRIPTION: Creating indices. diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS index 392788055..49dafcd5d 100644 --- a/etc/ORG-NEWS +++ b/etc/ORG-NEWS @@ -77,6 +77,14 @@ You can now create links to =shortdoc= documentation groups for Emacs Lisp functions (see =M-x shortdoc-display-group=). Requires Emacs 28 or newer. +*** Texinfo exports can use alternative navigation + +You can now alter the Texinfo navigation hierarchy by specifying the +/Next/, /Previous/, and /Up/ pointers in the =ALT_NEXT=, +=ALT_PREVIOUS=, and =ALT_UP= properties, respectively. For more +information, see "13.14.6 Headings and sectioning structure" section +of the Org manual. + ** New and changed options # Chanes deadling with changing default values of customizations, diff --git a/lisp/ox-texinfo.el b/lisp/ox-texinfo.el index 6adee9fca..808dc22f6 100644 --- a/lisp/ox-texinfo.el +++ b/lisp/ox-texinfo.el @@ -512,46 +512,63 @@ INFO is a plist used as a communication channel. See ;; Else use format string. (fmt (format fmt text)))) +(defun org-texinfo--node-line (headline info) + "Return node line for HEADLINE. + +INFO is a plist used as a communication channel." + (let ((next (org-element-property :ALT_NEXT headline)) + (previous (org-element-property :ALT_PREVIOUS headline)) + (up (org-element-property :ALT_UP headline))) + (string-trim-right + (concat (format "@node %s" (org-texinfo--get-node headline info)) + (if (or next previous up) ", ") + (and next (org-texinfo--sanitize-node next)) + (if (or previous up) ", ") + (and previous (org-texinfo--sanitize-node previous)) + (if (or up) ", ") + (and up (org-texinfo--sanitize-node up)))))) + (defun org-texinfo--get-node (datum info) "Return node or anchor associated to DATUM. -DATUM is a headline, a radio-target or a target. INFO is a plist -used as a communication channel. The function guarantees the +DATUM is org-data (root), a headline, a radio-target or a target. INFO +is a plist used as a communication channel. The function guarantees the node or anchor name is unique." - (let ((cache (plist-get info :texinfo-node-cache))) - (or (cdr (assq datum cache)) - (let* ((salt 0) - (basename - (org-texinfo--sanitize-node - (pcase (org-element-type datum) - (`headline - (org-texinfo--sanitize-title - (org-export-get-alt-title datum info) info)) - (`radio-target - (org-export-data (org-element-contents datum) info)) - (`target - (org-element-property :value datum)) - (_ - (or (org-element-property :name datum) - (org-export-get-reference datum info)))))) - (name basename)) - ;; Org exports deeper elements before their parents. If two - ;; node names collide -- e.g., they have the same title -- - ;; within the same hierarchy, the second one would get the - ;; smaller node name. This is counter-intuitive. - ;; Consequently, we ensure that every parent headline gets - ;; its node beforehand. As a recursive operation, this - ;; achieves the desired effect. - (let ((parent (org-element-lineage datum 'headline))) - (when (and parent (not (assq parent cache))) - (org-texinfo--get-node parent info) - (setq cache (plist-get info :texinfo-node-cache)))) - ;; Ensure NAME is unique and not reserved node name "Top", - ;; no matter what case is used. - (while (or (string-equal "Top" (capitalize name)) - (rassoc name cache)) - (setq name (concat basename (format " (%d)" (cl-incf salt))))) - (plist-put info :texinfo-node-cache (cons (cons datum name) cache)) - name)))) + (if (eq (org-element-type datum) 'org-data) "Top" + (let ((cache (plist-get info :texinfo-node-cache))) + (or (cdr (assq datum cache)) + (let* ((salt 0) + (basename + (org-texinfo--sanitize-node + (pcase (org-element-type datum) + (`headline + (org-texinfo--sanitize-title + (org-export-get-alt-title datum info) info)) + (`radio-target + (org-export-data (org-element-contents datum) info)) + (`target + (org-element-property :value datum)) + (_ + (or (org-element-property :name datum) + (org-export-get-reference datum info)))))) + (name basename)) + ;; Org exports deeper elements before their parents. If + ;; two node names collide -- e.g., they have the same + ;; title -- within the same hierarchy, the second one + ;; would get the smaller node name. This is + ;; counter-intuitive. Consequently, we ensure that every + ;; parent headline gets its node beforehand. As a + ;; recursive operation, this achieves the desired effect. + (let ((parent (org-element-lineage datum 'headline))) + (when (and parent (not (assq parent cache))) + (org-texinfo--get-node parent info) + (setq cache (plist-get info :texinfo-node-cache)))) + ;; Ensure NAME is unique and not reserved node name "Top", + ;; no matter what case is used. + (while (or (string-equal "Top" (capitalize name)) + (rassoc name cache)) + (setq name (concat basename (format " (%d)" (cl-incf salt))))) + (plist-put info :texinfo-node-cache (cons (cons datum name) cache)) + name))))) (defun org-texinfo--sanitize-node (title) "Bend string TITLE to node line requirements. @@ -875,7 +892,12 @@ holding export options." ;; Configure Top Node when not for TeX. Also include contents ;; from the first section of the document. "@ifnottex\n" - "@node Top\n" + ;; Top node. + (org-element-map (plist-get info :parse-tree) 'org-data + (lambda (root) + (org-texinfo--node-line root info)) + info t) + "\n" (format "@top %s\n" title) (let* ((first-section (org-element-map (plist-get info :parse-tree) 'section @@ -1118,7 +1140,10 @@ holding contextual information." (concat ;; Even if HEADLINE is using @subheading and al., leave an ;; anchor so cross-references in the Org document still work. - (format (if notoc? "@anchor{%s}\n" "@node %s\n") node) + (if notoc? + (format "@anchor{%s}" node) + (org-texinfo--node-line headline info)) + "\n" (format command full-text) contents)))))) diff --git a/testing/lisp/test-ox-texinfo.el b/testing/lisp/test-ox-texinfo.el index b16a344e7..fb0269649 100644 --- a/testing/lisp/test-ox-texinfo.el +++ b/testing/lisp/test-ox-texinfo.el @@ -345,5 +345,295 @@ body (should-not (org-element-contents section)) (should (eq first-heading (org-element-parent section))))))) + +;;; Alternative title and navigation + +(ert-deftest test-ox-texinfo/alt-title () + "Test alternative titles." + (should + (org-test-with-temp-text + (string-join + (list "* Title 1" + ":PROPERTIES:" + ":ALT_TITLE: Title 2" + ":END:") + "\n") + (let ((export-buffer "*Test Texinfo Export*") + (org-export-show-temporary-export-buffer nil)) + (org-export-to-buffer 'texinfo export-buffer + nil nil nil nil nil + #'texinfo-mode) + (with-current-buffer export-buffer + (goto-char (point-min)) + (re-search-forward "^@node Title 2$")))))) + +(ert-deftest test-ox-texinfo/alt-title/sanitized () + "Test sanitized alternative titles." + (should + (org-test-with-temp-text + (string-join + (list "* Title 1" + ":PROPERTIES:" + ":ALT_TITLE: (Foo:) Bar, baz." + ":END:") + "\n") + (let ((export-buffer "*Test Texinfo Export*") + (org-export-show-temporary-export-buffer nil)) + (org-export-to-buffer 'texinfo export-buffer + nil nil nil nil nil + #'texinfo-mode) + (with-current-buffer export-buffer + (goto-char (point-min)) + (re-search-forward "^@node \\[Foo) Bar baz$")))))) + +(ert-deftest test-ox-texinfo/alt-navigation/next () + "Test alternative navigation to Next nodes." + (should + (org-test-with-temp-text + (string-join + (list "* Title" + ":PROPERTIES:" + ":ALT_NEXT: Next" + ":END:") + "\n") + (let ((export-buffer "*Test Texinfo Export*") + (org-export-show-temporary-export-buffer nil)) + (org-export-to-buffer 'texinfo export-buffer + nil nil nil nil nil + #'texinfo-mode) + (with-current-buffer export-buffer + (goto-char (point-min)) + (re-search-forward "^@node Title, Next$")))))) + +(ert-deftest test-ox-texinfo/alt-navigation/next/sanitized () + "Test sanitized alternative navigation to Next nodes." + (should + (org-test-with-temp-text + (string-join + (list "* Title 1" + ":PROPERTIES:" + ":ALT_NEXT: (Foo:) Bar, baz." + ":END:") + "\n") + (let ((export-buffer "*Test Texinfo Export*") + (org-export-show-temporary-export-buffer nil)) + (org-export-to-buffer 'texinfo export-buffer + nil nil nil nil nil + #'texinfo-mode) + (with-current-buffer export-buffer + (goto-char (point-min)) + (re-search-forward "^@node Title 1, \\[Foo) Bar baz$")))))) + +(ert-deftest test-ox-texinfo/alt-navigation/next/with-previous () + "Test alternative navigation to Next and Previous nodes." + (should + (org-test-with-temp-text + (string-join + (list "* Title" + ":PROPERTIES:" + ":ALT_NEXT: Next" + ":ALT_PREVIOUS: Previous" + ":END:") + "\n") + (let ((export-buffer "*Test Texinfo Export*") + (org-export-show-temporary-export-buffer nil)) + (org-export-to-buffer 'texinfo export-buffer + nil nil nil nil nil + #'texinfo-mode) + (with-current-buffer export-buffer + (goto-char (point-min)) + (re-search-forward "^@node Title, Next, Previous$")))))) + +(ert-deftest test-ox-texinfo/alt-navigation/next/with-previous-and-up () + "Test alternative navigation to Next, Previous, and Up nodes." + (should + (org-test-with-temp-text + (string-join + (list "* Title" + ":PROPERTIES:" + ":ALT_NEXT: Next" + ":ALT_PREVIOUS: Previous" + ":ALT_UP: Up" + ":END:") + "\n") + (let ((export-buffer "*Test Texinfo Export*") + (org-export-show-temporary-export-buffer nil)) + (org-export-to-buffer 'texinfo export-buffer + nil nil nil nil nil + #'texinfo-mode) + (with-current-buffer export-buffer + (goto-char (point-min)) + (re-search-forward "^@node Title, Next, Previous, Up$")))))) + +(ert-deftest test-ox-texinfo/alt-navigation/previous () + "Test alternative navigation to Previous nodes." + (should + (org-test-with-temp-text + (string-join + (list "* Title" + ":PROPERTIES:" + ":ALT_PREVIOUS: Previous" + ":END:") + "\n") + (let ((export-buffer "*Test Texinfo Export*") + (org-export-show-temporary-export-buffer nil)) + (org-export-to-buffer 'texinfo export-buffer + nil nil nil nil nil + #'texinfo-mode) + (with-current-buffer export-buffer + (goto-char (point-min)) + (re-search-forward "^@node Title, , Previous$")))))) + +(ert-deftest test-ox-texinfo/alt-navigation/previous/sanitized () + "Test sanitized alternative navigation to Previous nodes." + (should + (org-test-with-temp-text + (string-join + (list "* Title 1" + ":PROPERTIES:" + ":ALT_PREVIOUS: (Foo:) Bar, baz." + ":END:") + "\n") + (let ((export-buffer "*Test Texinfo Export*") + (org-export-show-temporary-export-buffer nil)) + (org-export-to-buffer 'texinfo export-buffer + nil nil nil nil nil + #'texinfo-mode) + (with-current-buffer export-buffer + (goto-char (point-min)) + (re-search-forward "^@node Title 1, , \\[Foo) Bar baz$")))))) + +(ert-deftest test-ox-texinfo/alt-navigation/previous/with-up () + "Test alternative navigation to Previous and Up nodes." + (should + (org-test-with-temp-text + (string-join + (list "* Title" + ":PROPERTIES:" + ":ALT_PREVIOUS: Previous" + ":ALT_UP: Up" + ":END:") + "\n") + (let ((export-buffer "*Test Texinfo Export*") + (org-export-show-temporary-export-buffer nil)) + (org-export-to-buffer 'texinfo export-buffer + nil nil nil nil nil + #'texinfo-mode) + (with-current-buffer export-buffer + (goto-char (point-min)) + (re-search-forward "^@node Title, , Previous, Up$")))))) + +(ert-deftest test-ox-texinfo/alt-navigation/up () + "Test alternative navigation to Up nodes." + (should + (org-test-with-temp-text + (string-join + (list "* Title" + ":PROPERTIES:" + ":ALT_UP: Up" + ":END:") + "\n") + (let ((export-buffer "*Test Texinfo Export*") + (org-export-show-temporary-export-buffer nil)) + (org-export-to-buffer 'texinfo export-buffer + nil nil nil nil nil + #'texinfo-mode) + (with-current-buffer export-buffer + (goto-char (point-min)) + (re-search-forward "^@node Title, , , Up$")))))) + +(ert-deftest test-ox-texinfo/alt-navigation/up/sanitized () + "Test sanitized alternative navigation to Up nodes." + (should + (org-test-with-temp-text + (string-join + (list "* Title 1" + ":PROPERTIES:" + ":ALT_UP: (Foo:) Bar, baz." + ":END:") + "\n") + (let ((export-buffer "*Test Texinfo Export*") + (org-export-show-temporary-export-buffer nil)) + (org-export-to-buffer 'texinfo export-buffer + nil nil nil nil nil + #'texinfo-mode) + (with-current-buffer export-buffer + (goto-char (point-min)) + (re-search-forward "^@node Title 1, , , \\[Foo) Bar baz$")))))) + +(ert-deftest test-ox-texinfo/alt-navigation/no-pointers () + "Test alternative navigation with no pointers." + (should + (org-test-with-temp-text + (string-join + (list "* Title" + ":PROPERTIES:" + ":ALT_NEXT:" + ":END:") + "\n") + (let ((export-buffer "*Test Texinfo Export*") + (org-export-show-temporary-export-buffer nil)) + (org-export-to-buffer 'texinfo export-buffer + nil nil nil nil nil + #'texinfo-mode) + (with-current-buffer export-buffer + (goto-char (point-min)) + (re-search-forward "^@node Title,$")))))) + +(ert-deftest test-ox-texinfo/alt-navigation/top-node/not-set () + "Test alternative navigation for Top nodes, when not set." + (should + (org-test-with-temp-text "Hello world!" + (let ((export-buffer "*Test Texinfo Export*") + (org-export-show-temporary-export-buffer nil)) + (org-export-to-buffer 'texinfo export-buffer + nil nil nil nil nil + #'texinfo-mode) + (with-current-buffer export-buffer + (goto-char (point-min)) + (re-search-forward "^@node Top$")))))) + +(ert-deftest test-ox-texinfo/alt-navigation/top-node/set () + "Test alternative navigation for Top nodes, when set." + (should + (org-test-with-temp-text + (string-join + (list ":PROPERTIES:" + ":ALT_NEXT: Next" + ":ALT_PREVIOUS: Previous" + ":ALT_UP: Up" + ":END:" + "#+TITLE: Title" + "* Headline") + "\n") + (let ((export-buffer "*Test Texinfo Export*") + (org-export-show-temporary-export-buffer nil)) + (org-export-to-buffer 'texinfo export-buffer + nil nil nil nil nil + #'texinfo-mode) + (with-current-buffer export-buffer + (goto-char (point-min)) + (re-search-forward "^@node Top, Next, Previous, Up$")))))) + +(ert-deftest test-ox-texinfo/alt-navigation/with-alt-title () + "Test alternative navigation combined with alternative titles." + (should + (org-test-with-temp-text + (string-join + (list "* Title 1" + ":PROPERTIES:" + ":ALT_TITLE: Title 2" + ":ALT_UP: Title 3" + ":END:") + "\n") + (let ((export-buffer "*Test Texinfo Export*") + (org-export-show-temporary-export-buffer nil)) + (org-export-to-buffer 'texinfo export-buffer + nil nil nil nil nil + #'texinfo-mode) + (with-current-buffer export-buffer + (goto-char (point-min)) + (re-search-forward "^@node Title 2, , , Title 3$")))))) + (provide 'test-ox-texinfo) ;;; test-ox-texinfo.el end here -- 2.39.3 (Apple Git-146) --=-=-= Content-Type: text/x-patch Content-Disposition: attachment; filename=0002-ox-texinfo-Support-links-in-headings.patch >From 3b9c3753df9580805ec763c0deaacaac0cfc38e1 Mon Sep 17 00:00:00 2001 From: Rudolf Adamkovic Date: Sat, 24 Aug 2024 21:37:29 +0200 Subject: [PATCH 2/3] ox-texinfo: Support links in headings * etc/ORG-NEWS (Texinfo exporter now supports links in headings): Announce the new feature. * lisp/ox-texinfo.el: (org-texinfo--format-entries, org-texinfo--get-node, org-texinfo--sanitize-title-reference, org-texinfo--sanitize-title): A 2-step change: (1) Rename `--sanitize-title' to `--sanitize-title-reference' and (2) create a new `--sanitize-title' sanitation function. The new function is less strict in that does not remove links, which should be allowed in sectioning commands, such as `@unnumbered'. The old function remains more strict, which is useful for generating `@node' names, for example. * testing/lisp/test-ox-texinfo.el: (test-ox-texinfo/headings-with-links): Test the new functionality to avoid regressions in the future. --- etc/ORG-NEWS | 6 ++++++ lisp/ox-texinfo.el | 17 +++++++++++++++-- testing/lisp/test-ox-texinfo.el | 28 ++++++++++++++++++++++++++++ 3 files changed, 49 insertions(+), 2 deletions(-) diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS index 49dafcd5d..0ae1e4c81 100644 --- a/etc/ORG-NEWS +++ b/etc/ORG-NEWS @@ -231,6 +231,12 @@ This way, attachments will remain accessible when opening symlinked Org file. When no attach dir exists, Org mode will still prefer creating it in the "default" directory - where the symlink is located. +*** Texinfo exporter now supports links in headings + +The Texinfo exporter no longer removes links from headings. This +applies to all headings, below and above the =H= and =toc= export +=#+OPTIONS:=. + * Version 9.7 ** Important announcements and breaking changes diff --git a/lisp/ox-texinfo.el b/lisp/ox-texinfo.el index 808dc22f6..2e316d204 100644 --- a/lisp/ox-texinfo.el +++ b/lisp/ox-texinfo.el @@ -541,7 +541,7 @@ node or anchor name is unique." (org-texinfo--sanitize-node (pcase (org-element-type datum) (`headline - (org-texinfo--sanitize-title + (org-texinfo--sanitize-title-reference (org-export-get-alt-title datum info) info)) (`radio-target (org-export-data (org-element-contents datum) info)) @@ -586,6 +586,19 @@ periods, commas and colons." (defun org-texinfo--sanitize-title (title info) "Make TITLE suitable as a section name. TITLE is a string or a secondary string. INFO is the current +export state, as a plist." + (org-export-data-with-backend + title + (org-export-create-backend + :parent 'texinfo + :transcoders `((footnote-reference . ,#'ignore) + (radio-target . ,(lambda (_r c _) c)) + (target . ,#'ignore))) + info)) + +(defun org-texinfo--sanitize-title-reference (title info) + "Make TITLE suitable as a section reference. +TITLE is a string or a secondary string. INFO is the current export state, as a plist." (org-export-data-with-backend title (org-export-toc-entry-backend 'texinfo) info)) @@ -1493,7 +1506,7 @@ a plist containing contextual information." ;; name. Remove them. (replace-regexp-in-string "[ \t]*:+" "" - (org-texinfo--sanitize-title + (org-texinfo--sanitize-title-reference (org-export-get-alt-title h info) info))) (node (org-texinfo--get-node h info)) (entry (concat "* " title ":" diff --git a/testing/lisp/test-ox-texinfo.el b/testing/lisp/test-ox-texinfo.el index fb0269649..4a521b3ed 100644 --- a/testing/lisp/test-ox-texinfo.el +++ b/testing/lisp/test-ox-texinfo.el @@ -635,5 +635,33 @@ body (goto-char (point-min)) (re-search-forward "^@node Title 2, , , Title 3$")))))) + +;;; Headings with links + +(ert-deftest test-ox-texinfo/headings-with-links () + "Test node and chapter names." + (should + (org-test-with-temp-text + (string-join + (list "* Heading 1" + " ...." + "* Heading 2 ([[* Heading 1][Heading 1]])" + " ....") + "\n") + (let ((export-buffer "*Test Texinfo Export*") + (org-export-show-temporary-export-buffer nil)) + (org-export-to-buffer 'texinfo export-buffer + nil nil nil nil nil + #'texinfo-mode) + (with-current-buffer export-buffer + (goto-char (point-min)) + (and + (re-search-forward "^* Heading 1::$") + (re-search-forward "^* Heading 2 (Heading 1)::$") + (re-search-forward "^@node Heading 1$") + (re-search-forward "^@chapter Heading 1$") + (re-search-forward "^@node Heading 2 (Heading 1)$") + (re-search-forward "^@chapter Heading 2 (@ref{Heading 1})$"))))))) + (provide 'test-ox-texinfo) ;;; test-ox-texinfo.el end here -- 2.39.3 (Apple Git-146) --=-=-= Content-Type: text/x-patch Content-Disposition: attachment; filename=0003-ox-texinfo-Support-numeric-values-of-toc-in-OPTIONS.patch >From a45ed0eaa84144a5a34324d54aa326d5476ac5c2 Mon Sep 17 00:00:00 2001 From: Rudolf Adamkovic Date: Sat, 24 Aug 2024 15:26:18 +0200 Subject: [PATCH 3/3] ox-texinfo: Support numeric values of `toc' in `#+OPTIONS' * etc/ORG-NEWS (Texinfo exporter now supports numeric =toc= values in =#+OPTIONS:=): Announce the new feature. * lisp/ox.el (org-export-excluded-from-toc-p): Return nil for all headlines that are above the `toc' value in export `#+OPTIONS'. * testing/lisp/test-ox-texinfo.el (test-ox-texinfo/headings-and-table-of-contents): Add a test. --- etc/ORG-NEWS | 9 +++++ lisp/ox.el | 6 ++- testing/lisp/test-ox-texinfo.el | 66 +++++++++++++++++++++++++++++++++ 3 files changed, 80 insertions(+), 1 deletion(-) diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS index 0ae1e4c81..3c0bfc173 100644 --- a/etc/ORG-NEWS +++ b/etc/ORG-NEWS @@ -85,6 +85,15 @@ You can now alter the Texinfo navigation hierarchy by specifying the information, see "13.14.6 Headings and sectioning structure" section of the Org manual. +*** Texinfo exporter now supports numeric =toc= values in =#+OPTIONS:= + +For example, given =H:3= and =toc:2= in =#+OPTIONS:=, all headings at +the 1st and 2nd level appear in the table of contents and those at the +3rd level do not. The latter will be instead exported as if they had +the =UNNUMBERED= property set to =notoc=, that is using the Texinfo +command given in the =unnumbered-no-toc-3= list position of the +=org-texinfo-classes= variable, as documented. + ** New and changed options # Chanes deadling with changing default values of customizations, diff --git a/lisp/ox.el b/lisp/ox.el index 7a0ab4dc7..acc535f72 100644 --- a/lisp/ox.el +++ b/lisp/ox.el @@ -5625,7 +5625,11 @@ contents. However, it is useful if some additional processing is required on headlines excluded from table of contents." (or (org-element-property :footnote-section-p headline) (org-export-low-level-p headline info) - (equal "notoc" (org-export-get-node-property :UNNUMBERED headline t)))) + (equal "notoc" (org-export-get-node-property :UNNUMBERED headline t)) + (let ((toc-depth (plist-get info :with-toc))) + (and (wholenump toc-depth) + (> (org-element-property :level headline) + toc-depth))))) (defun org-export-toc-entry-backend (parent &rest transcoders) "Return an export backend appropriate for table of contents entries. diff --git a/testing/lisp/test-ox-texinfo.el b/testing/lisp/test-ox-texinfo.el index 4a521b3ed..e6dfaf876 100644 --- a/testing/lisp/test-ox-texinfo.el +++ b/testing/lisp/test-ox-texinfo.el @@ -663,5 +663,71 @@ body (re-search-forward "^@node Heading 2 (Heading 1)$") (re-search-forward "^@chapter Heading 2 (@ref{Heading 1})$"))))))) + +;;; Headings and table of contents + +(ert-deftest test-ox-texinfo/headings-and-table-of-contents () + "Test headings with regards to table of contents." + (should + (org-test-with-temp-text + (string-join + (list "#+OPTIONS: h:2 toc:1 num:nil" + "* Level 1" + "** Level 1-1" + "*** Level 1-1-1" + "*** Level 1-1-2" + "** Level 1-2" + "*** Level 1-2-1" + "*** Level 1-2-2" + "* Level 2" + "** Level 2-1" + "*** Level 2-1-1" + "*** Level 2-1-2" + "** Level 2-2" + "*** Level 2-2-1" + "*** Level 2-2-2") + "\n") + (let ((export-buffer "*Test Texinfo Export*") + (org-export-show-temporary-export-buffer nil)) + (org-export-to-buffer 'texinfo export-buffer + nil nil nil nil nil + #'texinfo-mode) + (with-current-buffer export-buffer + (goto-char (point-min)) + (and + (re-search-forward "^@menu$") + (re-search-forward "^* Level 1::$") + (re-search-forward "^* Level 2::$") + (re-search-forward "^@detailmenu$") + (re-search-forward "^Level 1$") + (re-search-forward "^* Level 1-1::$") + (re-search-forward "^* Level 1-2::$") + (re-search-forward "^Level 2$") + (re-search-forward "^* Level 2-1::$") + (re-search-forward "^* Level 2-2::$") + (re-search-forward "^@node Level 1$") + (re-search-forward "^@unnumbered Level 1$") + (re-search-forward "^@menu$") + (re-search-forward "^* Level 1-1::$") + (re-search-forward "^* Level 1-2::$") + (re-search-forward "^@heading Level 1-1$") + (re-search-forward "^@anchor{Level 1-1-1}Level 1-1-1$") + (re-search-forward "^@anchor{Level 1-1-2}Level 1-1-2$") + (re-search-forward "^@heading Level 1-2$") + (re-search-forward "^@anchor{Level 1-2-1}Level 1-2-1$") + (re-search-forward "^@anchor{Level 1-2-2}Level 1-2-2$") + (re-search-forward "^@node Level 2$") + (re-search-forward "^@unnumbered Level 2$") + (re-search-forward "^@menu$") + (re-search-forward "^* Level 2-1::$") + (re-search-forward "^* Level 2-2::$") + (re-search-forward "^@heading Level 2-1$") + (re-search-forward "^@anchor{Level 2-1-1}Level 2-1-1$") + (re-search-forward "^@anchor{Level 2-1-2}Level 2-1-2$") + (re-search-forward "^@anchor{Level 2-2}$") + (re-search-forward "^@heading Level 2-2$") + (re-search-forward "^@anchor{Level 2-2-1}Level 2-2-1$") + (re-search-forward "^@anchor{Level 2-2-2}Level 2-2-2$"))))))) + (provide 'test-ox-texinfo) ;;; test-ox-texinfo.el end here -- 2.39.3 (Apple Git-146) --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable --=20 "Thinking is a momentary dismissal of irrelevancies." --- Richard Buckminster Fuller, 1969 Rudolf Adamkovi=C4=8D [he/him] http://adamkovic.org --=-=-=--