From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp2 ([2001:41d0:2:bcc0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms0.migadu.com with LMTPS id 2NDnLXxXvmFVCgEAgWs5BA (envelope-from ) for ; Sat, 18 Dec 2021 22:49:48 +0100 Received: from aspmx1.migadu.com ([2001:41d0:2:bcc0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp2 with LMTPS id MJ2kKXxXvmF+VQAAB5/wlQ (envelope-from ) for ; Sat, 18 Dec 2021 21:49:48 +0000 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 0B67F28CA8 for ; Sat, 18 Dec 2021 22:49:48 +0100 (CET) Received: from localhost ([::1]:44522 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1myhaN-00078M-19 for larch@yhetil.org; Sat, 18 Dec 2021 16:49:47 -0500 Received: from eggs.gnu.org ([209.51.188.92]:57842) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1myhRf-0003bv-9V for emacs-orgmode@gnu.org; Sat, 18 Dec 2021 16:40:47 -0500 Received: from mail.hostpark.net ([212.243.197.30]:58140) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1myhRc-0004Mz-LG for emacs-orgmode@gnu.org; Sat, 18 Dec 2021 16:40:47 -0500 Received: from localhost (localhost [127.0.0.1]) by mail.hostpark.net (Postfix) with ESMTP id CA7DC164A8; Sat, 18 Dec 2021 22:40:40 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=bernoul.li; h= content-transfer-encoding:mime-version:references:in-reply-to :x-mailer:message-id:date:date:subject:subject:from:from :received:received; s=sel2011a; t=1639863638; bh=nMrYolTybFDt7zc tmvLyiM0k3fwYTeEsifcBa8HUj6s=; b=qaIKEYlzhu7PP5ViWpj0DygvJQWM9UV 6zu98ITXXJEkRBV4+cjwmzs3ZXcBlEGo15d/36lrhvS+LmpZAp/AR2iZ1SqB0Oze 429FyX7UEIjFiU0tK2AFbSZJk2bBDPUGawuIgA4gAriQMOBwVWwtjyTg4cylbSLW DG3gkVtdy3vE= X-Virus-Scanned: by Hostpark/NetZone Mailprotection at hostpark.net Received: from mail.hostpark.net ([127.0.0.1]) by localhost (mail1.hostpark.net [127.0.0.1]) (amavisd-new, port 10224) with ESMTP id HnjflWlOy0h1; Sat, 18 Dec 2021 22:40:38 +0100 (CET) Received: from customer (localhost [127.0.0.1]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mail.hostpark.net (Postfix) with ESMTPSA id 80612164B9; Sat, 18 Dec 2021 22:40:38 +0100 (CET) From: Jonas Bernoulli To: emacs-orgmode@gnu.org Subject: [PATCH 2/2] ox-texinfo: Define definition commands using description lists Date: Sat, 18 Dec 2021 22:40:38 +0100 Message-Id: <20211218214038.9459-3-jonas@bernoul.li> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20211218214038.9459-1-jonas@bernoul.li> References: <87pmqhmvg1.fsf@bernoul.li> <20211218214038.9459-1-jonas@bernoul.li> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Received-SPF: none client-ip=212.243.197.30; envelope-from=jonas@bernoul.li; helo=mail.hostpark.net 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_H3=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_NONE=0.001 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: , Cc: kyle@kyleam.com, mail@nicolasgoaziou.fr Errors-To: emacs-orgmode-bounces+larch=yhetil.org@gnu.org Sender: "Emacs-orgmode" X-Migadu-Flow: FLOW_IN X-Migadu-Country: US ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1639864188; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post:dkim-signature; bh=aVFzY4Nv0uaPMBMv5+RX5sXUdvauxtGhZ+SY1Ad8MV4=; b=EyNY3ZLg/5PjFAR0z980ch90vE2MuhL7BjDeyU8cj9qUrRCNNS/QcshdTuHaLnSZxnpBiZ LVG6CS86Z18/DQtwOm+27FKk4qkybzCEO7/bYR1YTKkJLzPXTrgm26dVLy/ZMTe9A//1Do KW2Y1+aD61eAv5JKkqA+M7wNKy2cDkxoOWmDTiEtItxsWdIyYG4g4mDeHPNaYuhqVJkWbh f7uwgz+gS86dBjxcG+gbF7JUsHhGBU7bykOD/Rh7FoHFgnZQexAiIKS+VDOoa+xPxr6N4B bR/ksRV3tGvXEq9HSYLVMKWg9Hgsf0ODjQRCijtYG/XEQmdaLcJJgYNe8fMZXA== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1639864188; a=rsa-sha256; cv=none; b=AyZKOD3s9qB8qfuR4fLaH429rfzCsLOy2aiImgoWjbZamKat71AskMwaF/TolejhjYevhv Z6TxoWN/OGw5FgPZPOLRac/Y9EhMwewlMK28r6RRdtZdKAfPzhsPNMICIhHmShnpdeNX+w nmG4dOUuhss+Odgra27tDCSO5MUAzpJ5awcmxVnhlqa0aspMVpfqMAQFgl4DdfOwu7EZlz P7QjfteDVtoMywSPX7ou58tnIPnjohCIm1WXvrG3q+0V4raKuSzW8eZJdl7zmjOTES9SOe 3i1FJDDQaqTTW6mJEYiX7bdCxjgDIfj7gQtawn5ltKmoET54b+9MglbKMEsDWQ== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=pass header.d=bernoul.li header.s=sel2011a header.b=qaIKEYlz; dmarc=none; 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" X-Migadu-Spam-Score: -7.21 Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=bernoul.li header.s=sel2011a header.b=qaIKEYlz; dmarc=none; 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" X-Migadu-Queue-Id: 0B67F28CA8 X-Spam-Score: -7.21 X-Migadu-Scanner: scn0.migadu.com X-TUID: 4o+rWrRUSoKl * doc/org-manual.org (Plain lists in Texinfo export): Document use of definition command prefixes in description lists. * lisp/ox-texinfo.el (org-texinfo--definition-command-alist) (org-texinfo--definition-command-regexp): New variables. * lisp/ox-texinfo.el (org-texinfo--filter-parse-tree): Call org-texinfo--separate-definitions. * lisp/ox-texinfo.el (org-texinfo--separate-definitions) (org-texinfo--match-definition, org-texinfo--split-definition) (org-texinfo--split-plain-list, org-texinfo--massage-key-item): New functions. --- doc/org-manual.org | 98 ++++++++++++++++++++++++++++++++- lisp/ox-texinfo.el | 132 ++++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 227 insertions(+), 3 deletions(-) diff --git a/doc/org-manual.org b/doc/org-manual.org index b8bb391c2..e8d777875 100644 --- a/doc/org-manual.org +++ b/doc/org-manual.org @@ -15303,7 +15303,99 @@ output can also be produced with: ,#+attr_texinfo: :table-type vtable :indic asis - foo :: + bar :: - This is the common text for foo and bar. + This is the common text for variables foo and bar. +#+end_example + +Likewise, the Texinfo export back-end supports two approaches to +writing Texinfo definition commands (see [[info:texinfo::Definition +Commands]]). One of them uses description lists and is describe below, +the other is described in [[*Special blocks in Texinfo export]]. + +Items in a description list in a Org file that begin with =Function:= +or certain other prefixes are converted using Texinfo definition +commands. This works even if other items in the same list do not have +such a prefix; if necessary a single description list is converted +using multiple tables (such as =@vtable=) and definition commands +(such as =@defun=). + +#+begin_example +- Function: org-texinfo-drawer drawer contents info :: + Transcode a DRAWER element from Org to Texinfo. +#+end_example + +#+texinfo: @noindent +becomes + +#+begin_example +@defun org-texinfo-drawer drawer contents info :: + Transcode a DRAWER element from Org to Texinfo. +@end defun +#+end_example + +The recognized prefixes are =Command:=, =Function:=, =Macro:=, +=Special Form:=, =Variable:= and =User Option:=. These are the same +prefixes that appear in the Info file for the respective definition +commands. For example a =Function:= item in the Org file is converted +to a =@defun= command in the Texinfo file, which in turn is converted +to a definition prefixed with =-- Function:= in the Info file. + +As a special case the prefix =Key:= is also recognized. No Texinfo +definition command exists for key bindings and the output in Info +files also lacks the =Key:= prefix. Even so this special case is +supported because it provides a convenient shorthand, as illustrated +here: + +#+begin_example +- Key: C-n (do-something) :: + This command does something. + +- User Option: do-something-somehow :: + This option controls how exactly ~do-something~ does its thing. +#+end_example + +#+texinfo: @noindent +becomes + +#+begin_example +@table @asis +@item @kbd{C-c C-c} (@code{do-something}) +@kindex C-c C-c +@findex do-something +This command does something. +@end table + +@defopt do-something-somehow +This option controls how exactly @code{do-something} does its thing. +@end defopt +#+end_example + +Key items don't have to specify the respective command in parenthesis +as done above; that part is optional. + +You can get the same result using the alternative approach (see +[[*Special blocks in Texinfo export]]), which is more verbose and less +similar to the final Info/HTML/PDF output (but more similar to the +intermediate Texinfo file): + +#+begin_example +- {{{kbd(C-c C-c)}}} (~do-something~) :: + + #+kindex: C-c C-c + #+findex: do-something + This command does something. + +,#+attr_texinfo: :options do-something-somehow +,#+begin_defopt + This option controls how exactly ~do-something~ does its thing. +,#+end_defopt +#+end_example + +Regardless of which approach you use, you must define the =kbd= macro +(see [[*Macro Replacement]]), which you can then use anywhere in the Org +file: + +#+begin_example +,#+macro: kbd (eval (let ((case-fold-search nil) (regexp (regexp-opt '("SPC" "RET" "LFD" "TAB" "BS" "ESC" "DELETE" "SHIFT" "Ctrl" "Meta" "Alt" "Cmd" "Super" "UP" "LEFT" "RIGHT" "DOWN") 'words))) (format "@@texinfo:@kbd{@@%s@@texinfo:}@@" (replace-regexp-in-string regexp "@@texinfo:@key{@@\\&@@texinfo:}@@" $1 t)))) #+end_example *** Tables in Texinfo export @@ -15373,6 +15465,10 @@ your king. :DESCRIPTION: Special block attributes. :END: +The Texinfo export back-end supports two approaches to writing Texinfo +definition commands. One of them is describe here, the other in +[[*Plain lists in Texinfo export]]. + #+cindex: @samp{ATTR_TEXINFO}, keyword The Texinfo export back-end converts special blocks to commands with diff --git a/lisp/ox-texinfo.el b/lisp/ox-texinfo.el index 35862357d..cc9fca918 100644 --- a/lisp/ox-texinfo.el +++ b/lisp/ox-texinfo.el @@ -83,7 +83,7 @@ (org-export-define-backend 'texinfo (verse-block . org-texinfo-verse-block)) :filters-alist '((:filter-headline . org-texinfo--filter-section-blank-lines) - (:filter-parse-tree . org-texinfo--normalize-headlines) + (:filter-parse-tree . org-texinfo--filter-parse-tree) (:filter-section . org-texinfo--filter-section-blank-lines) (:filter-final-output . org-texinfo--untabify)) :menu-entry @@ -407,6 +407,23 @@ (defconst org-texinfo-inline-image-rules (regexp-opt '("eps" "pdf" "png" "jpg" "jpeg" "gif" "svg")))) "Rules characterizing image files that can be inlined.") +(defconst org-texinfo--definition-command-alist + '(("deffn Command" . "Command") + ("defun" . "Function") + ("defmac" . "Macro") + ("defspec" . "Special Form") + ("defvar" . "Variable") + ("defopt" . "User Option") + (nil . "Key")) + "Alist mapping Texinfo definition commands to output in Info files.") + +(defconst org-texinfo--definition-command-regexp + (format "\\`%s: \\(.+\\)" + (regexp-opt + (delq nil (mapcar #'cdr org-texinfo--definition-command-alist)) + 1)) + "Regexp used to match definition commands in descriptive lists.") + ;;; Internal Functions @@ -421,7 +438,8 @@ (defun org-texinfo--filter-section-blank-lines (headline _backend _info) (defun org-texinfo--filter-parse-tree (tree backend info) "Normalize headlines and items." (org-texinfo--normalize-headlines tree backend info) - (org-texinfo--normalize-items tree info)) + (org-texinfo--normalize-items tree info) + (org-texinfo--separate-definitions tree backend info)) (defun org-texinfo--normalize-headlines (tree _backend info) "Normalize headlines in TREE. @@ -598,6 +616,116 @@ (defun org-texinfo--sectioning-structure (info) (`(,_ ,_ . ,sections) sections) (_ (user-error "Unknown Texinfo class: %S" class))))) +(defun org-texinfo--separate-definitions (tree _backend info) + "Split up descriptive lists that contain Texinfo definition commands." + (org-element-map tree 'plain-list + (lambda (plain-list) + (when (eq (org-element-property :type plain-list) 'descriptive) + (let ((contents (org-element-contents plain-list)) + item items) + (while (setq item (pop contents)) + (pcase-let ((`(,cmd . ,args) (org-texinfo--match-definition item))) + (cond + (cmd + (when items + (org-texinfo--split-plain-list plain-list (nreverse items)) + (setq items nil)) + (org-texinfo--split-definition plain-list item cmd args)) + (t + (when args + (org-texinfo--massage-key-item plain-list item args)) + (push item items))))) + (unless (org-element-contents plain-list) + (org-element-extract-element plain-list))))) + info) + tree) + +(defun org-texinfo--match-definition (item) + "Return a cons-cell if ITEM specifies a Texinfo definition command. +The car is the command and the cdr is its arguments." + (let ((tag (car-safe (org-element-property :tag item)))) + (and tag + (stringp tag) + (string-match org-texinfo--definition-command-regexp tag) + (pcase-let* + ((cmd (car (rassoc (match-string-no-properties 1 tag) + org-texinfo--definition-command-alist))) + (`(,cmd ,category) + (and cmd (save-match-data (split-string cmd " ")))) + (args (match-string-no-properties 2 tag))) + (cons cmd (if category (concat category " " args) args)))))) + +(defun org-texinfo--split-definition (plain-list item cmd args) + "Insert a definition command before list PLAIN-LIST. +Replace list item ITEM with a special-block that inherits the +contents of ITEM and whose type and Texinfo attributes are +specified by CMD and ARGS." + (let ((contents (org-element-contents item))) + (org-element-insert-before + (apply #'org-element-create 'special-block + (list :type cmd + :attr_texinfo (list (format ":options %s" args)) + :post-blank (if contents 1 0)) + (mapc #'org-element-extract-element contents)) + plain-list)) + (org-element-extract-element item)) + +(defun org-texinfo--split-plain-list (plain-list items) + "Insert a new plain list before the plain list PLAIN-LIST. +Remove ITEMS from PLAIN-LIST and use them as the contents of the +new plain list." + (org-element-insert-before + (apply #'org-element-create 'plain-list + (list :type 'descriptive :post-blank 1) + (mapc #'org-element-extract-element items)) + plain-list)) + +(defun org-texinfo--massage-key-item (plain-list item args) + "In PLAIN-LIST modify ITEM based on ARGS. +Reformat ITEM's tag property and add findex and kindex entries to +its content. If the bullet is \"+\" then use \"@itemx\" and deal with +data from preceeding siblings that use such a bullet." + (let (key cmd) + (if (string-match " +(\\([^()]+\\)) *\\'" args) + (setq key (substring args 0 (match-beginning 0)) + cmd (match-string 1 args)) + (setq key args)) + (org-element-put-property + item :tag + (nconc (if (assoc "kbd" org-macro-templates) + (let ((templates org-macro-templates)) + (with-temp-buffer + (insert (format "{{{kbd(%s)}}}" key)) + (org-macro-replace-all templates) + (let ((tags (car (org-element-map (org-element-parse-buffer) + 'paragraph #'org-element-contents t)))) + (dolist (tag tags) + (org-element-put-property tag :parent tags)) + tags))) + `((code (:value ,key :post-blank 0)))) + (and cmd `(" (" (code (:value ,cmd :post-blank 0)) ")")))) + (let ((findex (org-element-property :findex item)) + (kindex (org-element-property :kindex item)) + (next-item (cadr (memq item (org-element-contents plain-list)))) + (mx (string-prefix-p "M-x " key))) + (when (and (not cmd) mx) + (setq cmd (substring key 4))) + (when (and cmd (not (member cmd findex))) + (setq findex (nconc findex (list cmd)))) + (unless mx + (setq kindex (nconc kindex (list key)))) + (if (and next-item + (equal (org-element-property :bullet next-item) "+ ")) + (progn (org-element-put-property next-item :findex findex) + (org-element-put-property next-item :kindex kindex) + (org-element-put-property item :findex nil) + (org-element-put-property item :kindex nil)) + (org-element-set-contents + item (nconc + (mapcar (lambda (key) `(keyword (:key "KINDEX" :value ,key))) kindex) + (mapcar (lambda (cmd) `(keyword (:key "FINDEX" :value ,cmd))) findex) + (org-element-contents item))))))) + ;;; Template (defun org-texinfo-template (contents info) -- 2.34.1