From mboxrd@z Thu Jan 1 00:00:00 1970 From: John Hendy Subject: Re: [PATCH] Change to org-src-preserve-indentation documentation Date: Mon, 3 Feb 2014 17:12:43 -0600 Message-ID: References: <87txch42qy.fsf@gmail.com> Mime-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Return-path: Received: from eggs.gnu.org ([2001:4830:134:3::10]:32917) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1WASh4-0007UE-55 for emacs-orgmode@gnu.org; Mon, 03 Feb 2014 18:12:47 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1WASh3-0006sX-6I for emacs-orgmode@gnu.org; Mon, 03 Feb 2014 18:12:46 -0500 Received: from mail-ob0-x22a.google.com ([2607:f8b0:4003:c01::22a]:51315) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1WASh3-0006sO-1X for emacs-orgmode@gnu.org; Mon, 03 Feb 2014 18:12:45 -0500 Received: by mail-ob0-f170.google.com with SMTP id va2so8609869obc.15 for ; Mon, 03 Feb 2014 15:12:43 -0800 (PST) In-Reply-To: <87txch42qy.fsf@gmail.com> 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: Nicolas Goaziou Cc: emacs-orgmode On Sun, Feb 2, 2014 at 3:35 PM, Nicolas Goaziou wrote: > 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. No problem, and as a native speaker, I'd say yours is more formal/clearer. > > 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. > Thanks for the explanation. This was my attempt to describe what usually happens, but I wasn't sure. I know from reading some other documentation, it mentioned the variable org-src-edit-content-indentation, which seemed like it would "collapse" a bunch of whitespace down to a set value, but maybe that's only if one uses the C-c ' shortcut to edit? Anyway, I'll just remove that bit. >> +@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... > Good to know about two spaces! I had no idea. Out of curiosity is that file generated from a .org file? Or is that the main documentation everyone edits/writes in? Good to know regarding the value of =t= as well. Does a numeric value do anything, or is it simply a binary variable (non-nil vs. anything else). For my personal preference, I don't understand the idea of a variable that acts binary yet takes any number of values :) >> +blocks will be exported/tangled with whitespace preserved, exactly as they > > exported or tangled, maybe > Yup. >> +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. > Got it. I thought the same thing, but swear I just ran into that ("org" vs. "Org") recently and followed the convention. Grepping files in org.git and worg.git revealed only a handful of instances where lower case "org" is used, so I must have been imagining or recalling something from the mailing list vs. official docs. Thanks for the feedback, John > > Regards, > > -- > Nicolas Goaziou