From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp1 ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms0.migadu.com with LMTPS id uH/TJgW5imFWWwEAgWs5BA (envelope-from ) for ; Tue, 09 Nov 2021 19:08:05 +0100 Received: from aspmx1.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp1 with LMTPS id QF5iIgW5imEQKgAAbx9fmQ (envelope-from ) for ; Tue, 09 Nov 2021 18:08:05 +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 D93527411 for ; Tue, 9 Nov 2021 19:08:04 +0100 (CET) Received: from localhost ([::1]:34540 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mkVXO-0006IN-89 for larch@yhetil.org; Tue, 09 Nov 2021 13:08:02 -0500 Received: from eggs.gnu.org ([209.51.188.92]:46524) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mkVR9-0002Sa-0v for emacs-orgmode@gnu.org; Tue, 09 Nov 2021 13:01:40 -0500 Received: from mail.hostpark.net ([212.243.197.30]:46116) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mkVR6-0002HT-3W for emacs-orgmode@gnu.org; Tue, 09 Nov 2021 13:01:34 -0500 Received: from localhost (localhost [127.0.0.1]) by mail.hostpark.net (Postfix) with ESMTP id 4479A16BC0 for ; Tue, 9 Nov 2021 19:01:26 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=bernoul.li; h= content-type:content-type:mime-version:message-id:date:date :subject:subject:from:from:received:received; s=sel2011a; t= 1636480884; bh=wPWlitWa+POq28hmvvLqp3vYg9hQpoRxUZINDZyfba0=; b=E gJyWSBgYpjQ/CvkYP1SEnoV/DVwcDGxH89chW9sfuEpbx7tjq/A+so6XIx80WkoR ppnY8LKoTcM/CkNrtIYF5i6aEgl4PR+c7ocizrDG/nEtar2J1wX4OQex8NkzEgjB xYsZy5LoNnKDsBjx/SF1FQxu2/2ooOeBljC/6HBu2k= X-Virus-Scanned: by Hostpark/NetZone Mailprotection at hostpark.net Received: from mail.hostpark.net ([127.0.0.1]) by localhost (mail0.hostpark.net [127.0.0.1]) (amavisd-new, port 10224) with ESMTP id OIVnbrfvGv_n for ; Tue, 9 Nov 2021 19:01:24 +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 ECDHE (P-256) server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mail.hostpark.net (Postfix) with ESMTPSA id 16C3E16BBC for ; Tue, 9 Nov 2021 19:01:24 +0100 (CET) From: Jonas Bernoulli To: emacs-orgmode@gnu.org Subject: Merging ox-texinfo+ into ox-texinfo Date: Tue, 09 Nov 2021 19:01:22 +0100 Message-ID: <87ilx19pjh.fsf@bernoul.li> MIME-Version: 1.0 Content-Type: text/plain 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: , Errors-To: emacs-orgmode-bounces+larch=yhetil.org@gnu.org Sender: "Emacs-orgmode" X-Migadu-Flow: FLOW_IN ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1636481285; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type:list-id:list-help:list-unsubscribe: list-subscribe:list-post:dkim-signature; bh=XU0pGpe9JevfSM+GZOVIwEwC4l1cANkinkgC5pAGOnI=; b=NHEKRdGVrq6ii4Q90uulPgxZbGkUfzVnOnyfFzvrWBuVE4E8CTs0p3s5oiaBKGOuL/bnXQ +rXETPTx9uZ3ThKbXtPd5CUCcs74TJeNbNYh+7QaeGPYVMb1EW3GwwOx4GXn+ia/2Ge2vu KtrYlphIujBPZ1p/EzAk7E7poDZqMC2z9Y9CLpQTJnGLQaXMnYA4rm8A91Yyg7D8LRdXZs 6205OEZHD4Sfk/tc8Ldw1cZ//KCHuiQKaGjJ2A8g5HwVa54qFZHuom2uXjDVWdLrZqfz66 FwFhF8iBcN6pcYNEyhXjNsKxZlqsZnnhpXU6zaI54tMDoMjA3kd+vZD22Ol1qw== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1636481285; a=rsa-sha256; cv=none; b=RscxMuTOQujJ3wp8eVpYdaeVDlxYSTZtpTRkDw0kkioQRzl4VDhW6FihSis5kYcHeKYZLC U/lEn1+a77r0B5FRtylD2cdsRL3w2suY9ytzfF7B5MnphJxNZ0wM11Rc1e1NHvwtGiVOmU maqwNVoTCVvNbQXI5dKqfrHARzy2Dzekhy8091UgqXMmJpcgH6FW/jpeLNg0/NgSfMGN8Q SSne9gctI00T2kg5ZIf135LaZYDwzzbHkVQsbhInuKhWQrhKv3/9Zb/rs1eT95Ft1am/us 7URWPzqnT7RJlx+nPtRhc330CW8Tykrd/V+DqcaJdotmjjeHwQumgppby4C1Ug== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=pass header.d=bernoul.li header.s=sel2011a header.b="E gJyWSB"; spf=pass (aspmx1.migadu.com: domain of emacs-orgmode-bounces@gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=emacs-orgmode-bounces@gnu.org X-Migadu-Spam-Score: -3.62 Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=bernoul.li header.s=sel2011a header.b="E gJyWSB"; dmarc=none; spf=pass (aspmx1.migadu.com: domain of emacs-orgmode-bounces@gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=emacs-orgmode-bounces@gnu.org X-Migadu-Queue-Id: D93527411 X-Spam-Score: -3.62 X-Migadu-Scanner: scn1.migadu.com X-TUID: JoFrWKew+5FJ Hello, In the olden days before Org's own manual was written using an org-mode file, I started doing just that for Magit. Because ox-texinfo.el wasn't quite there yet I wrote an extension, ox-texinfo+.el, to fill in the gaps. Since then I have written seven more manuals that use my extension. I recently talked to Bastien about this and he encouraged to bring up the possibility of merging ox-texinfo+.el into ox-texinfo.el. ox-texinfo+ (https://github.com/tarsius/ox-texinfo-plus) has several features but the one I would like to talk about now is the following. [If you want to look at the other features now, then please use the "next" branch as I am in the process of trimming some of them down or even removing them completely. The main feature is the same in the "master" and "next" branches.] Create `@deffn` and similar definition items by writing list items in Org that look similar to what they will look like in Info. To enable this, add: #+TEXINFO_DEFFN: t to your Org file. After doing that, you can create definition items like so: - Command: magit-section-show Show the body of the current section. - Function: magit-git-exit-code &rest args - Macro: magit-insert-section &rest args - Variable: magit-display-buffer-noselect - User Option: magit-display-buffer-function - Key: q, magit-mode-bury-buffer I propose that we add this as an optional feature to ox-texinfo.el itself. IMO the biggest advantage of this style is that it leads to a prettier org file, which is suitable for direct consumption by end-users. It is also easier to write in this style by package authors who might not want to fully familiarize themselves with all the peculiarities of writing an org file intended for export to texinfo. It is possible to mix the two styles; you can use the ox-texinfo+.el style for most or all definitions but use the additional flexibility of ox-texinfo.el, when that is needed. What do you think? Might this be something that could be merged? The reason I am bringing this up now after years of maintaining this as an extension is that I would like to finally stop checking in both the *.org and *.texi files into git. [Non]GNU Elpa already supports this and I plan to implement it for Melpa as well. It would be much nicer if the only additional requirement for an *elpa was to have a recent enough Org version installed, instead of that and also ox-texinfo+.el. Cheers, Jonas