[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Using Org as the source format to generate org.texi

From: Eli Zaretskii
Subject: Re: Using Org as the source format to generate org.texi
Date: Wed, 07 Mar 2018 19:43:07 +0200

> From: Bastien <address@hidden>
> Date: Wed, 07 Mar 2018 01:22:47 +0100
> Cc: address@hidden
> Stefan Monnier <address@hidden> writes:
> > Bastien <address@hidden> writes:
> >> One drawback is that we will have to backport manual changes made in
> >> Emacs' repo to org.texi into Org's manual.org file, but such changes
> >> are rare enough that we think we can handle this.
> >
> > Why wouldn't we use Org's manual.org in Emacs?
> I thought the rule was for Emacs manuals to be written in Texinfo.
> But if we can sync org-manual.org in Emacs branch, it will make our
> lives easier, for sure!

I had a look at manual.org in the Org repository.  If we are going to
maintain the Org manual in that form, would it be possible to come up
with a "cheat sheet" for die-hard Texinfo users, that would give them
enough tips for writing manuals-to-be-converted-to-Texinfo?  (Or maybe
such a document already exists, and I just overlooked it?)  The
mechanics of writing a manual in Org is sufficiently different that
would leave me challenged enough without such a cookbook.  For
example, how does one insert all those {{{kbd(foo bar)}}} -- I presume
you don't type that literally, but I couldn't find a command similar
to address@hidden  (If there's no such command, I think it
should be added, as well as commands to insert other kinds of markup
that is more than one or two characters long.  For example, the
code-block delimiters "#+begin_src emacs-lisp", cross-references,
@noindent, etc.  The equivalent commands in texinfo-mode are
significant time-savers.)

Also, I see some omissions in converting the Texinfo manual to
manual.org: all the uses of @key disappeared (expect Michael Albinus
to be very unhappy ;-), and likewise with @command -- is that

And what is the difference between cross-references that begin with an
asterisk and those that don't?  I couldn't find that in the manual.


reply via email to

[Prev in Thread] Current Thread [Next in Thread]