From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.devel Subject: Re: Using Org as the source format to generate org.texi Date: Wed, 07 Mar 2018 19:43:07 +0200 Message-ID: <837eqnrdck.fsf@gnu.org> References: <878tb5axms.fsf@bzg.fr> <87ina84tuw.fsf@gnu.org> Reply-To: Eli Zaretskii NNTP-Posting-Host: blaine.gmane.org X-Trace: blaine.gmane.org 1520444496 15719 195.159.176.226 (7 Mar 2018 17:41:36 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Wed, 7 Mar 2018 17:41:36 +0000 (UTC) Cc: monnier@iro.umontreal.ca, emacs-devel@gnu.org To: Bastien Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Wed Mar 07 18:41:32 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 1etd44-00026p-F8 for ged-emacs-devel@m.gmane.org; Wed, 07 Mar 2018 18:41:20 +0100 Original-Received: from localhost ([::1]:34740 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1etd67-0002iH-7k for ged-emacs-devel@m.gmane.org; Wed, 07 Mar 2018 12:43:27 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:36857) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1etd5y-0002gh-Me for emacs-devel@gnu.org; Wed, 07 Mar 2018 12:43:19 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1etd5u-0005ei-PD for emacs-devel@gnu.org; Wed, 07 Mar 2018 12:43:18 -0500 Original-Received: from fencepost.gnu.org ([2001:4830:134:3::e]:43175) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1etd5u-0005eW-Kx; Wed, 07 Mar 2018 12:43:14 -0500 Original-Received: from [176.228.60.248] (port=2872 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1etd5t-000142-UP; Wed, 07 Mar 2018 12:43:14 -0500 In-reply-to: <87ina84tuw.fsf@gnu.org> (message from Bastien on Wed, 07 Mar 2018 01:22:47 +0100) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 2001:4830:134:3::e 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:223415 Archived-At: > From: Bastien > Date: Wed, 07 Mar 2018 01:22:47 +0100 > Cc: emacs-devel@gnu.org > > Stefan Monnier writes: > > > Bastien 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 texinfo-insert-@kbd. (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 intentional? 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. Thanks.