From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Bastien Newsgroups: gmane.emacs.devel Subject: Using Org as the source format to generate org.texi Date: Tue, 06 Mar 2018 19:04:43 +0100 Organization: GNU Message-ID: <878tb5axms.fsf@bzg.fr> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: blaine.gmane.org 1520359392 8556 195.159.176.226 (6 Mar 2018 18:03:12 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Tue, 6 Mar 2018 18:03:12 +0000 (UTC) User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.0.50 (gnu/linux) Cc: THOMAS DYE , Nicolas Goaziou , Carsten Dominik To: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Tue Mar 06 19:03:07 2018 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by blaine.gmane.org with esmtp (Exim 4.84_2) (envelope-from ) id 1etGvY-0001R1-Vn for ged-emacs-devel@m.gmane.org; Tue, 06 Mar 2018 19:03:05 +0100 Original-Received: from localhost ([::1]:57401 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1etGxb-0004Ag-QI for ged-emacs-devel@m.gmane.org; Tue, 06 Mar 2018 13:05:11 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:34394) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1etGxU-0004A3-Ka for emacs-devel@gnu.org; Tue, 06 Mar 2018 13:05:05 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1etGxS-000665-0y for emacs-devel@gnu.org; Tue, 06 Mar 2018 13:05:04 -0500 Original-Received: from [195.159.176.226] (port=57676 helo=blaine.gmane.org) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1etGxR-00065A-R8 for emacs-devel@gnu.org; Tue, 06 Mar 2018 13:05:01 -0500 Original-Received: from list by blaine.gmane.org with local (Exim 4.84_2) (envelope-from ) id 1etGvI-0007u5-3t for emacs-devel@gnu.org; Tue, 06 Mar 2018 19:02:48 +0100 X-Injected-Via-Gmane: http://gmane.org/ Original-Lines: 31 Original-X-Complaints-To: usenet@blaine.gmane.org Cancel-Lock: sha1:JaJZeLQE9OEoMCLDBnKQFV18NoE= X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 195.159.176.226 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.org gmane.emacs.devel:223354 Archived-At: 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