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: Org Mode Documentation Patch Date: Fri, 22 Jun 2018 21:14:16 +0300 Message-ID: <83zhzmpu2v.fsf@gnu.org> References: <34982f421aec69d062d32c0c36bbcddf@disroot.org> Reply-To: Eli Zaretskii NNTP-Posting-Host: blaine.gmane.org X-Trace: blaine.gmane.org 1529691132 32243 195.159.176.226 (22 Jun 2018 18:12:12 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Fri, 22 Jun 2018 18:12:12 +0000 (UTC) Cc: emacs-devel@gnu.org To: "Ben Phipathananunth" Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Fri Jun 22 20:12:08 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 1fWQXW-0008H5-E9 for ged-emacs-devel@m.gmane.org; Fri, 22 Jun 2018 20:12:06 +0200 Original-Received: from localhost ([::1]:35553 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fWQZd-0002mE-Qk for ged-emacs-devel@m.gmane.org; Fri, 22 Jun 2018 14:14:17 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:60800) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fWQZX-0002m0-0d for emacs-devel@gnu.org; Fri, 22 Jun 2018 14:14:12 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1fWQZT-0001nm-1Q for emacs-devel@gnu.org; Fri, 22 Jun 2018 14:14:10 -0400 Original-Received: from fencepost.gnu.org ([2001:4830:134:3::e]:54768) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fWQZS-0001ni-Tv; Fri, 22 Jun 2018 14:14:06 -0400 Original-Received: from [176.228.60.248] (port=4114 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1fWQZS-0006ar-DX; Fri, 22 Jun 2018 14:14:06 -0400 In-reply-to: <34982f421aec69d062d32c0c36bbcddf@disroot.org> (siraben@disroot.org) 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:226593 Archived-At: > Date: Fri, 22 Jun 2018 16:08:35 +0000 > From: "Ben Phipathananunth" > > I've begun reading the Org Mode manual, and noticed that the wording > in some places could be improved (so far I've read up to Section 4.8). > I've attached my patch. Some of the more drastic changes: > > - Changed all occurrences of "the cursor" to "point", I thought the > inconsistency was confusing, especially since the Emacs manual > maintains usage of "point" throughout, so too should the Org Mode > manual. > > I have a couple of questions regarding the Org Mode manual and > submitting patches: > > Section 4.6 "Link abbreviations" in the Org Mode manual link to > websites that have and/or promote non-free software. The URLs are > used to illustrate link abbreviations in Org Mode, but I suppose this > was purely coincidental because long URLs to websites such as > gnu.org/some/long/path could be used instead. Would it be appropriate > to change the examples in a later patch? > > When the PDF version of the Org Mode manual is generated with "make > docs", the footnotes (3 and 4) around Section 4.3 are incorrectly > indented, can anyone reproduce this? What is causing it? > > Should I submit my patches as smaller ones as I read sections of the > manual or bulk them together into a larger patch, or is it just a > matter of preference? Please submit this to Org developers first, as the manual's master copy is maintained there. (I think they are moving towards using Org format for the manual source anyway, so submitting patches in Texinfo will not be useful.) Thanks.