Included org-mode files not exported properly

Included org-mode files not exported properly

[Bob Kline]

According to the docs [1] for Include files, if you omit the optional
second and third parameters, "the text will be assumed to be in Org mode
format and will be processed normally."  However, it does not appear
that the structure of the included content is recognized by org mode,
which dumps the headers for the sections of the included file into a
single paragraph, with some random commas injected.

Here's a repro case:

$ cat repro.org
* Intro
Blah blah
* Data Structures
#+INCLUDE: "common.org"
* Algorithms
More blah
$ cat common.org
** Tables
foo bar
** Views
blech
** Stored Procedures
 - one
 - two

Here's a link to the resulting HTML:
http://www.rksystems.com/org-include-repro.html

Here's what the interesting segment of the HTML source looks like (the
results of org-export-as-html):

<p>,** Tables
foo bar
,** Views
blech
,** Stored Procedures
</p><ul>
<li>
one
</li>
<li>
two

</li>
</ul>

Is this a known bug?  I can reproduce this behavior on a number of
versions of org-mode, including the latest released version (6.29c).


[1] http://orgmode.org/manual/Include-files.html


-- 
Bob Kline <bkline@rksystems.com>

Re: Included org-mode files not exported properly

[Carsten Dominik]

Hi

this bug was fixed on July 24:

http://repo.or.cz/w/org-mode.git?a=commitdiff;h=68b65e8f480c17cfe1024001c236eb4065893f4d

so you probably need to upgrade.

- Carsten

On Aug 7, 2009, at 3:41 AM, Bob Kline wrote:

> According to the docs [1] for Include files, if you omit the optional
> second and third parameters, "the text will be assumed to be in Org  
> mode
> format and will be processed normally."  However, it does not appear
> that the structure of the included content is recognized by org mode,
> which dumps the headers for the sections of the included file into a
> single paragraph, with some random commas injected.
>
> Here's a repro case:
>
> $ cat repro.org
> * Intro
> Blah blah
> * Data Structures
> #+INCLUDE: "common.org"
> * Algorithms
> More blah
> $ cat common.org
> ** Tables
> foo bar
> ** Views
> blech
> ** Stored Procedures
> - one
> - two
>
> Here's a link to the resulting HTML:
> http://www.rksystems.com/org-include-repro.html
>
> Here's what the interesting segment of the HTML source looks like (the
> results of org-export-as-html):
>
> <p>,** Tables
> foo bar
> ,** Views
> blech
> ,** Stored Procedures
> </p><ul>
> <li>
> one
> </li>
> <li>
> two
>
> </li>
> </ul>
>
> Is this a known bug?  I can reproduce this behavior on a number of
> versions of org-mode, including the latest released version (6.29c).
>
>
> [1] http://orgmode.org/manual/Include-files.html
>
>
> -- 
> Bob Kline <bkline@rksystems.com>
>
>
>
> _______________________________________________
> 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

Re: Included org-mode files not exported properly

[Bob Kline]

At Fri, 7 Aug 2009 16:32:15 +0200,
Carsten Dominik wrote:

> this bug was fixed on July 24:
> 
> http://repo.or.cz/w/org-mode.git?a=commitdiff;h=68b65e8f480c17cfe1024001c236eb4065893f4d
> 
> so you probably need to upgrade.

Hmm.  I pulled down the latest code directly from the git repo, and I'm
still seeing the buggy behavior.  Did you have a different meaning in
mind for "upgrade"?

Thanks,
Bob

Re: Included org-mode files not exported properly

[Nick Dokos]

Bob Kline <bkline@rksystems.com> wrote:

> At Fri, 7 Aug 2009 16:32:15 +0200,
> Carsten Dominik wrote:
> 
> > this bug was fixed on July 24:
> > 
> > http://repo.or.cz/w/org-mode.git?a=commitdiff;h=68b65e8f480c17cfe1024001c236eb4065893f4d
> > 
> > so you probably need to upgrade.
> 
> Hmm.  I pulled down the latest code directly from the git repo, and I'm
> still seeing the buggy behavior.  Did you have a different meaning in
> mind for "upgrade"?
> 

I suggested a workaround to Bob (unfortunately, I forgot to copy the list
so it's in a different thread): use

#+INCLUDE: "foo" markup

but I think Bob is right that there is a problem (possibly more than one).

o First, this does not agree with the documentation. In fact, Michael
Zeller had proposed a change in the documentation (see
http://thread.gmane.org/gmane.emacs.orgmode/15924) to make it conform to
the current working of the code. Carsten, could you take a look and if
you agree, apply that patch? (but see below first).

o Second, the markup argument can be anything. If it is present, then
the included file is processed as an org mode file for export (unless
markup is "src" or "SRC", in which case the lang argument comes into the
picture). In the thread above, Michael Zeller suggests "org" as the value
of the markup and his documentation fix is phrased accordingly, but as
far as the code goes that's purely conventional.

o Third, if the markup argument is not present, then org-get-file-contents
returns the contents of the file as a strings with commas preceding
the headlines, as Bob mentioned. What's this all about?

Thanks,
Nick

Re: Included org-mode files not exported properly

[Carsten Dominik]

Hi Nick,

you are completely right, thanks for diffing.

The documentation describes how things *should* work, i.e.

    #+include file.org

without any markup argument should include and process the file
contents normally, while

   #+include file.org src org

Should include the file as an source code example.  In this case,
lines that look like headlines and commends should be "quoted" by
preceding them with a comma, so make sure they are not mistaken
for headlines or meta lines.

I believe this now works correctly again, please verify.

- Carsten

On Aug 8, 2009, at 1:03 AM, Nick Dokos wrote:

> Bob Kline <bkline@rksystems.com> wrote:
>
>> At Fri, 7 Aug 2009 16:32:15 +0200,
>> Carsten Dominik wrote:
>>
>>> this bug was fixed on July 24:
>>>
>>> http://repo.or.cz/w/org-mode.git?a=commitdiff;h=68b65e8f480c17cfe1024001c236eb4065893f4d
>>>
>>> so you probably need to upgrade.
>>
>> Hmm.  I pulled down the latest code directly from the git repo, and  
>> I'm
>> still seeing the buggy behavior.  Did you have a different meaning in
>> mind for "upgrade"?
>>
>
> I suggested a workaround to Bob (unfortunately, I forgot to copy the  
> list
> so it's in a different thread): use
>
> #+INCLUDE: "foo" markup
>
> but I think Bob is right that there is a problem (possibly more than  
> one).
>
> o First, this does not agree with the documentation. In fact, Michael
> Zeller had proposed a change in the documentation (see
> http://thread.gmane.org/gmane.emacs.orgmode/15924) to make it  
> conform to
> the current working of the code. Carsten, could you take a look and if
> you agree, apply that patch? (but see below first).
>
> o Second, the markup argument can be anything. If it is present, then
> the included file is processed as an org mode file for export (unless
> markup is "src" or "SRC", in which case the lang argument comes into  
> the
> picture). In the thread above, Michael Zeller suggests "org" as the  
> value
> of the markup and his documentation fix is phrased accordingly, but as
> far as the code goes that's purely conventional.
>
> o Third, if the markup argument is not present, then org-get-file- 
> contents
> returns the contents of the file as a strings with commas preceding
> the headlines, as Bob mentioned. What's this all about?
>
> Thanks,
> Nick
>

Re: Included org-mode files not exported properly

[Bob Kline]

At Sat, 8 Aug 2009 06:15:27 +0200,
Carsten Dominik wrote:

> I believe this now works correctly again, please verify.

It appears to be fixed, thanks.

-- 
Bob Kline
http://www.rksystems.com
mailto:bkline@rksystems.com