emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
* Merging ox-texinfo+ into ox-texinfo
@ 2021-11-09 18:01 Jonas Bernoulli
  2021-11-19 12:46 ` Nicolas Goaziou
  0 siblings, 1 reply; 47+ messages in thread
From: Jonas Bernoulli @ 2021-11-09 18:01 UTC (permalink / raw)
  To: emacs-orgmode

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


^ permalink raw reply	[flat|nested] 47+ messages in thread

end of thread, other threads:[~2022-02-22 19:20 UTC | newest]

Thread overview: 47+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-11-09 18:01 Merging ox-texinfo+ into ox-texinfo Jonas Bernoulli
2021-11-19 12:46 ` Nicolas Goaziou
2021-11-20 21:06   ` Jonas Bernoulli
2021-11-21 12:41     ` Nicolas Goaziou
2021-11-30 16:58       ` Jonas Bernoulli
2021-12-18 21:40         ` [PATCH 0/2] ox-texinfo: Define definition commands using description lists Jonas Bernoulli
2021-12-18 21:40           ` [PATCH 1/2] ox-texinfo: Turn a description list item with "+" bullet into @itemx Jonas Bernoulli
2021-12-26 21:37             ` Nicolas Goaziou
2021-12-27 18:05               ` Jonas Bernoulli
2021-12-30  9:40                 ` Nicolas Goaziou
2022-01-05 13:12                   ` Jonas Bernoulli
2022-01-23 15:01                   ` Jonas Bernoulli
2021-12-18 21:40           ` [PATCH 2/2] ox-texinfo: Define definition commands using description lists Jonas Bernoulli
2021-12-26 21:46             ` Nicolas Goaziou
2021-12-27 18:05               ` Jonas Bernoulli
2021-12-30  0:57                 ` Nicolas Goaziou
2022-01-05 13:16                   ` Jonas Bernoulli
2022-01-05 13:30           ` [PATCH v2 0/3] " Jonas Bernoulli
2022-01-05 13:30             ` [PATCH v2 1/3] ox-texinfo: Add function for use by kbd macro Jonas Bernoulli
2022-01-05 13:30             ` [PATCH v2 2/3] ox-texinfo: Optionally use @itemx for certain description list items Jonas Bernoulli
2022-01-05 13:30             ` [PATCH v2 3/3] ox-texinfo: Define definition commands using description lists Jonas Bernoulli
2022-01-14 23:01             ` [PATCH v2 0/3] " Jonas Bernoulli
2022-01-18 15:11           ` [PATCH v3 " Jonas Bernoulli
2022-01-18 15:11             ` [PATCH v3 1/3] ox-texinfo: Add function for use by kbd macro Jonas Bernoulli
2022-01-22 15:19               ` Nicolas Goaziou
2022-01-18 15:11             ` [PATCH v3 2/3] ox-texinfo: Optionally use @itemx for certain description list items Jonas Bernoulli
2022-01-22 15:33               ` Nicolas Goaziou
2022-01-23  1:26                 ` Jonas Bernoulli
2022-01-23 20:43                 ` Jonas Bernoulli
2022-01-18 15:11             ` [PATCH v3 3/3] ox-texinfo: Define definition commands using description lists Jonas Bernoulli
2022-01-23  0:02               ` Nicolas Goaziou
2022-01-23  1:14                 ` Jonas Bernoulli
2022-01-23 14:45                 ` Jonas Bernoulli
2022-01-23 20:27           ` [PATCH v4 0/3] " Jonas Bernoulli
2022-01-23 20:27             ` [PATCH v4 1/3] ox-texinfo: Add function for use by kbd macro Jonas Bernoulli
2022-01-23 20:27             ` [PATCH v4 2/3] ox-texinfo: Optionally use @itemx for certain description list items Jonas Bernoulli
2022-01-23 21:17               ` Jonas Bernoulli
2022-01-23 20:27             ` [PATCH v4 3/3] ox-texinfo: Define definition commands using description lists Jonas Bernoulli
2022-01-31 23:45           ` [PATCH v5 0/4] " Jonas Bernoulli
2022-01-31 23:45             ` [PATCH v5 1/4] ox-texinfo: Add function for use by kbd macro Jonas Bernoulli
2022-01-31 23:45             ` [PATCH v5 2/4] ox-texinfo: Optionally use @itemx for certain description list items Jonas Bernoulli
2022-01-31 23:45             ` [PATCH v5 3/4] ox-texinfo: Define definition commands using description lists Jonas Bernoulli
2022-01-31 23:45             ` [PATCH v5 4/4] ox-texinfo: Allow enabling compact syntax for @itemx per file Jonas Bernoulli
2022-02-08 23:46             ` [PATCH v5 0/4] ox-texinfo: Define definition commands using description lists Nicolas Goaziou
2022-02-11 20:01               ` Jonas Bernoulli
2022-02-15 21:01               ` [PATCH] etc/ORG-NEWS: Add news items about new features in texinfo exporter Jonas Bernoulli
2022-02-22 19:14                 ` Nicolas Goaziou

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).