emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
* Re: Warning about section named "Footnotes"
@ 2014-11-29 18:48 Arni Magnusson
  2014-12-02 11:23 ` Nicolas Goaziou
  0 siblings, 1 reply; 9+ messages in thread
From: Arni Magnusson @ 2014-11-29 18:48 UTC (permalink / raw)
  To: Nicolas Goaziou; +Cc: emacs-orgmode

The location of the second patch (in orgguide.texi) is line 348:

348c348,351

Arni



---------- Forwarded message ----------

Sure.

I suggest inserting a short paragraph into section 2.2, both in the manual 
and the compact guide. Working from today's snapshot of the repository, 
the two patches are as follows.


$ diff org-before.texi org-after.texi

1212c1212,1217
< @noindent Some people find the many stars too noisy and would prefer an
---
> @ vindex org-footnote-section
> @ noindent Note that the headline @samp{Footnotes} is a @emph{reserved}
> name. A subtree with this headline will be silently ignored by exporting
> functions, unless the value of @code{org-footnote-section} is modified.
>
> Some people find the many stars too noisy and would prefer an


$ diff orgguide-before.texi orgguide-after.texi

< @noindent
---
> @ noindent Note that the headline @samp{Footnotes} is a @emph{reserved}
> name. A subtree with this headline will be silently ignored by exporting
> functions, unless the value of @code{org-footnote-section} is modified.
>


Best regards,

Arni



On Sat, 29 Nov 2014, Nicolas Goaziou wrote:

>> I think it would help Org users if:
>>
>> 1. Org export (to LaTeX, HTML, etc.) emits an error or a prominent
>>    warning when it ignores an entire section like this.
>
> It shouldn't. This is the expected behaviour.
>
>> 2. The manual would warn the user about this behavior with a prominent
>>    warning.
>
> Would you mind suggesting a change to the manual?
>
>
> Regards,
>
> --
> Nicolas Goaziou
>

^ permalink raw reply	[flat|nested] 9+ messages in thread
* Warning about section named "Footnotes"
@ 2014-11-28 19:04 Arni Magnusson
  2014-11-29 13:31 ` Nicolas Goaziou
  0 siblings, 1 reply; 9+ messages in thread
From: Arni Magnusson @ 2014-11-28 19:04 UTC (permalink / raw)
  To: emacs-orgmode

Dear Org maintainers,

I was using Org to write a software manual with a structure along the 
lines of:


* Equations

How to write equations in software FOO.

* Footnotes

How to write footnotes in software FOO.

* Images

How to insert images in software FOO.


When I exported the document (to LaTeX and HTML), I was puzzled to find 
that one of the sections was not exported at all...

After investigating the problem for a while, I realized that if a section 
is named "Footnotes" the default behavior of Org is to ignore it silently.

My solution was to set `org-footnote-section' to nil.


I think it would help Org users if:

1. Org export (to LaTeX, HTML, etc.) emits an error or a prominent warning
    when it ignores an entire section like this.

2. The manual would warn the user about this behavior with a prominent
    warning.


Thanks for maintaining Org-mode. I'm finding it quite convenient for a 
variety of tasks.

Arni

^ permalink raw reply	[flat|nested] 9+ messages in thread

end of thread, other threads:[~2015-02-21 17:32 UTC | newest]

Thread overview: 9+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2014-11-29 18:48 Warning about section named "Footnotes" Arni Magnusson
2014-12-02 11:23 ` Nicolas Goaziou
2014-12-08  1:37   ` Arni Magnusson
2014-12-09  8:56     ` Nicolas Goaziou
2015-02-21 16:36       ` Arni Magnusson
2015-02-21 17:33         ` Nicolas Goaziou
  -- strict thread matches above, loose matches on Subject: below --
2014-11-28 19:04 Arni Magnusson
2014-11-29 13:31 ` Nicolas Goaziou
2014-11-29 18:40   ` Arni Magnusson

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).