From: Nicolas Goaziou <n.goaziou@gmail.com>
To: John Hendy <jw.hendy@gmail.com>
Cc: emacs-orgmode <emacs-orgmode@gnu.org>
Subject: Re: [PATCH] Change to org-src-preserve-indentation documentation
Date: Sun, 02 Feb 2014 22:35:17 +0100 [thread overview]
Message-ID: <87txch42qy.fsf@gmail.com> (raw)
In-Reply-To: <CA+M2ft_Yk99Joyq=9Ytc1cPw-5zTROf5iRz4XS_Z1+XeFvWqcw@mail.gmail.com> (John Hendy's message of "Sun, 2 Feb 2014 10:06:10 -0600")
Hello,
John Hendy <jw.hendy@gmail.com> 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
next prev parent reply other threads:[~2014-02-02 21:35 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-02-02 16:06 [PATCH] Change to org-src-preserve-indentation documentation John Hendy
2014-02-02 21:35 ` Nicolas Goaziou [this message]
2014-02-03 23:12 ` John Hendy
2014-02-04 8:26 ` Sebastien Vauban
2014-03-12 1:26 ` John Hendy
2014-03-12 8:01 ` Nicolas Goaziou
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87txch42qy.fsf@gmail.com \
--to=n.goaziou@gmail.com \
--cc=emacs-orgmode@gnu.org \
--cc=jw.hendy@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).