unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
* Using Org as the source format to generate org.texi
@ 2018-03-06 18:04 Bastien
  2018-03-06 20:20 ` Stefan Monnier
                   ` (2 more replies)
  0 siblings, 3 replies; 52+ messages in thread
From: Bastien @ 2018-03-06 18:04 UTC (permalink / raw)
  To: emacs-devel; +Cc: THOMAS DYE, Nicolas Goaziou, Carsten Dominik

Hi all,

thanks to Thomas' initiative and Nicolas' efforts, we now have Org's
documentation available as an .org file:

https://code.orgmode.org/bzg/org-mode/raw/master/contrib/manual.org

We plan to use manual.org (or org.org) as the source file for Org's
documentation: editing Org file is easier than to edit .texi files,
and Org's current Texinfo exporter does a very good job at producing
an org.texi file that is equivalent to the one we have right now.

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.

In the long term, it would be nice to have more cli exporters for Org,
although pandoc already does a good job at converting an .org file to
a .texi file.

In any case, editing such a big manual directly in Org is great and
maybe this proof of concept will inspire other Elisp contributors to
write their documentation directly in Org.

Glenn suggested we'd share this with the list and I think it's a good
idea -- in case you foresee problems that we may not have adressed.

Thanks!

-- 
 Bastien




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

end of thread, other threads:[~2018-04-19  9:22 UTC | newest]

Thread overview: 52+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2018-03-06 18:04 Using Org as the source format to generate org.texi Bastien
2018-03-06 20:20 ` Stefan Monnier
2018-03-06 20:24   ` Kaushal Modi
2018-03-06 21:54   ` Achim Gratz
2018-03-07  0:22   ` Bastien
2018-03-07 17:43     ` Eli Zaretskii
2018-03-07 17:52       ` Kaushal Modi
2018-03-08 10:04         ` Bastien Guerry
2018-03-08  7:28       ` Michael Albinus
2018-03-08 10:06         ` Bastien Guerry
2018-03-08 10:13       ` Bastien Guerry
2018-03-07 17:39   ` Glenn Morris
2018-03-07 22:57   ` Richard Stallman
2018-03-09 11:30     ` Bastien
2018-03-10 21:26     ` Nicolas Goaziou
2018-03-11  3:40       ` Eli Zaretskii
2018-03-11 14:59       ` Michael Albinus
2018-03-11 18:13         ` Nicolas Goaziou
2018-03-11 23:26       ` Richard Stallman
2018-03-12 14:07         ` Nicolas Goaziou
2018-03-12 15:51           ` Eli Zaretskii
2018-03-12 16:42             ` Nicolas Goaziou
2018-03-12 17:32               ` Eli Zaretskii
2018-03-12 17:57                 ` Nicolas Goaziou
2018-03-12 20:16                   ` Eli Zaretskii
2018-03-12 21:37                     ` Nicolas Goaziou
2018-03-13 15:55                       ` Eli Zaretskii
2018-03-13 17:24                         ` Nicolas Goaziou
2018-03-13 17:43                           ` Eli Zaretskii
2018-03-13 21:37                             ` Nicolas Goaziou
2018-04-14 17:10                         ` @key{...} mis-use (was: Using Org as the source format to generate org.texi) Nicolas Goaziou
2018-04-19  9:22                           ` Eli Zaretskii
2018-03-06 21:30 ` Using Org as the source format to generate org.texi Paul Eggert
2018-03-07  0:19   ` Bastien
2018-03-07  1:08     ` Paul Eggert
2018-03-07  7:33       ` Achim Gratz
2018-03-09 17:52         ` Achim Gratz
2018-03-09 18:02           ` Paul Eggert
2018-03-09 18:23             ` Achim Gratz
2018-03-07 17:41       ` Glenn Morris
2018-03-09 11:19         ` Phillip Lord
2018-03-12 17:12           ` Glenn Morris
2018-03-09 17:39         ` Achim Gratz
2018-03-10 20:07           ` Phillip Lord
2018-03-11  3:00             ` Paul Eggert
2018-03-11  3:55               ` Stefan Monnier
2018-03-11 21:46                 ` Phillip Lord
2018-03-12 21:04             ` Radon Rosborough
2018-03-13  9:10               ` Phillip Lord
2018-03-13 12:29                 ` Stefan Monnier
2018-03-13 16:47                   ` Phillip Lord
2018-04-14 19:15 ` Joshua Branson

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

	https://git.savannah.gnu.org/cgit/emacs.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).