Re: Exporting blocks without removing indentation

From: Samuel Wales <samologist@gmail.com>
To: Carsten Dominik <carsten.dominik@gmail.com>
Cc: Dan Davison <davison@stats.ox.ac.uk>,
	emacs org-mode mailing list <emacs-orgmode@gnu.org>
Subject: Re: Exporting blocks without removing indentation
Date: Wed, 28 Oct 2009 11:14:48 -0700	[thread overview]
Message-ID: <20524da70910281114v114e8443k90cf5bd32ca9dfe5@mail.gmail.com> (raw)
In-Reply-To: <064DBD81-9D10-46D6-911B-67E83EE10A11@gmail.com>

It's probably too late to suggest this, but it might be that long
options are more easy to remember for users than short options?  Also,
they might be easier to look up in the manual if you use a non-Emacs
browser.

On 2009-10-28, Carsten Dominik <carsten.dominik@gmail.com> wrote:
> Hi Dan,
>
> maybe the easiest way to implement this would be a -i (or whatever)
> switch a the src block.
>
> Switches are being processed already, so it will be simple to add one,
> I think.
>
> - Carsten
>
> On Oct 28, 2009, at 2:29 PM, Dan Davison wrote:
>
>> Fairly late in the export process, org-exp removes the common
>> indentation from lines inside blocks (line 2288 of org-exp.el):
>>
>> (setq rtn (org-remove-indentation code))
>>
>> However, what do we do if
>>
>> 1. A user has a block that she wishes to export with the indentation
>> intact?
>>
>> 2. An org-exp-blocks plugin has a block that it wishes to export with
>>   the indentation intact?
>>
>> I propose that we make (1) and (2) possible. An example where (1)
>> arises
>> is if, when documenting a moderately complex program, different
>> parts of
>> a class or function are contained in separate blocks.
>>
>> Q1. Is that aim approved of?
>>
>> (2) is a bit trickier than (1). To solve (1), we could introduce a fix
>> in org-exp.el like
>>
>> -      (setq rtn (org-remove-indentation code))
>> +      (setq rtn (if org-src-preserve-indentation code
>> +                 (org-remove-indentation code)))
>>
>> However in solving (2) the plugin cannot assume that the variable
>> org-src-preserve-indentation is in effect (in fact it very likely
>> isn't). So we need to come up with a way in which the block resulting
>> from an org-exp-blocks plugin can have its indentation survive through
>> to the export product, even if org-src-preserve-indentation is
>> globally
>> nil. Two possibilities are
>>
>> 1. We adopt a convention whereby if all lines start with some
>> character
>>   (say ,) then that character is removed (but the remaining
>> indentation
>>   is left intact.)
>>
>> 2. We transplant the indentation-removing work from org-exp.el into
>>   org-exp-blocks.el, and arrange that it is only performed if the
>> block
>>   is *not* handled by an org-exp-blocks plugin.
>>
>> Q2. Has this made sense? What solution do you suggest?
>>
>> Q3. Should we use org-src-preserve-indentation in this way to affect
>> export? (It currently has effect when switching between the org buffer
>> and the code edit buffer.)
>>
>> Dan
>>
>>
>> _______________________________________________
>> Emacs-orgmode mailing list
>> Remember: use `Reply All' to send replies to the list.
>> Emacs-orgmode@gnu.org
>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>
> - Carsten
>
>
>
>
>
> _______________________________________________
> Emacs-orgmode mailing list
> Remember: use `Reply All' to send replies to the list.
> Emacs-orgmode@gnu.org
> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>

-- 
Q: How many CDC "scientists" does it take to change a lightbulb?
A: "You only think it's dark." [CDC has denied ME/"CFS" for 25 years]
=====================================================================
Retrovirus: http://www.wpinstitute.org/xmrv/xmrv_qa.html