[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Using Org as the source format to generate org.texi
From: |
Bastien |
Subject: |
Using Org as the source format to generate org.texi |
Date: |
Tue, 06 Mar 2018 19:04:43 +0100 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/27.0.50 (gnu/linux) |
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
- Using Org as the source format to generate org.texi,
Bastien <=
- Re: Using Org as the source format to generate org.texi, Stefan Monnier, 2018/03/06
- Re: Using Org as the source format to generate org.texi, Kaushal Modi, 2018/03/06
- Re: Using Org as the source format to generate org.texi, Achim Gratz, 2018/03/06
- Re: Using Org as the source format to generate org.texi, Bastien, 2018/03/06
- Re: Using Org as the source format to generate org.texi, Michael Albinus, 2018/03/08
- Re: Using Org as the source format to generate org.texi, Bastien Guerry, 2018/03/08
- Re: Using Org as the source format to generate org.texi, Bastien Guerry, 2018/03/08