From mboxrd@z Thu Jan 1 00:00:00 1970 From: Nicolas Goaziou Subject: Re: [PATCH] Change to org-src-preserve-indentation documentation Date: Sun, 02 Feb 2014 22:35:17 +0100 Message-ID: <87txch42qy.fsf@gmail.com> References: Mime-Version: 1.0 Content-Type: text/plain Return-path: Received: from eggs.gnu.org ([2001:4830:134:3::10]:50008) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1WA4gz-0003My-14 for emacs-orgmode@gnu.org; Sun, 02 Feb 2014 16:35:13 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1WA4gq-0003ni-Kk for emacs-orgmode@gnu.org; Sun, 02 Feb 2014 16:35:04 -0500 Received: from mail-we0-x232.google.com ([2a00:1450:400c:c03::232]:37281) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1WA4gq-0003ne-Dv for emacs-orgmode@gnu.org; Sun, 02 Feb 2014 16:34:56 -0500 Received: by mail-we0-f178.google.com with SMTP id q59so1496355wes.9 for ; Sun, 02 Feb 2014 13:34:55 -0800 (PST) In-Reply-To: (John Hendy's message of "Sun, 2 Feb 2014 10:06:10 -0600") List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org Sender: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org To: John Hendy Cc: emacs-orgmode Hello, John Hendy writes: > Per some other discussions on the mentioned variable, I added a bit > more information to org.texi to help other users find it's > documentation in the manual. Thank you for the patch. It is certainly better than what we have actually. Some comments follow. > -This variable is especially useful for tangling languages such as > +By default, the value is @code{nil}, which means that whitespace characters will be > +collapsed upon exporting/tangling, according to the value of I think "exporting or tangling" is better than "exporting/tangling", but I'm no native speaker. Also, I'm not sure if "collapsed" is very clear. During export, when the source block is evaluated, it is removed from the buffer and, maybe, inserted back. At this point, if `org-src-preserve-indentation' is nil, every line is indented back to the same column as it was before. Tabs can appear in the process. If `org-src-preserve-indentation' is nil, global indentation is lost, but the local one is preserved. Since no indentation happens, tabs cannot appear in the process. > +@code{org-edit-src-content-indentation}. If set to @code{t}, code In Texinfo, sentences have to end with two spaces. Also, the variable doesn't need to be set to the symbol t, as any value but nil will achieve the same result. So the sentence could start with something like : When non-nil, code blocks... > +blocks will be exported/tangled with whitespace preserved, exactly as they exported or tangled, maybe > +appear in the org buffer. This variable is especially useful for > tangling languages such as It should be Org, not org. And two spaces are required. Regards, -- Nicolas Goaziou