From: Ihor Radchenko <yantar92@gmail.com>
To: Alain.Cochard@unistra.fr
Cc: emacs-orgmode@gnu.org
Subject: Re: Confused about what the COMMENT keyword means
Date: Tue, 27 Sep 2022 15:40:57 +0800 [thread overview]
Message-ID: <87o7v1nu2e.fsf@localhost> (raw)
In-Reply-To: <25394.40867.872373.589874@gargle.gargle.HOWL>
Alain.Cochard@unistra.fr writes:
> > In-buffer settings may appear anywhere in the file, either directly
> > or indirectly through a file included using ‘#+SETUPFILE: filename or
> > URL’ syntax.
> >
> > Because export settings are global, they have higher priority over the
> > COMMENTed heading.
>
> OK, I can understand that but if, as I now see in 13.2, both TITLE and
> EXPORT_FILE_NAME are export settings, why does it behaves as I expect
> for TITLE (the title I get is indeed 'bart') but not for
> EXPORT_FILE_NAME?
This is a valid observation.
I checked the code more closely, and I have to admit that I was wrong.
Commented subtrees are, in fact, obeyed. Obeyed for all the keywords
_but_ the EXPORT_FILE_NAME!
Basically, including files, removing commented subtrees, and other
excluded elements is done in `org-export-as' function. It is done before
setting export options.
However, `org-export-as' is generally called inside `org-export-to-file'
and `org-export-to-file' needs to know which file to export to in
advance; before the buffer is stripped of commented trees. That's why
there is the observed inconsistency between EXPORT_FILE_NAME and TITLE
settings.
> > > By contrast, with this file
> > >
> > > # * foo
> > > # #+EXPORT_FILE_NAME: foo.pdf
> > > # #+TITLE: foot
> > > # fofoo
> > > * bar
> > > #+EXPORT_FILE_NAME: bar.pdf
> > > #+TITLE: bart
> > > babar
> >
> > This file contains no export settings.
>
> I don't understand that: what about the line '#+EXPORT_FILE_NAME:
> bar.pdf'??
Sorry, I was referring to the commented part only.
Let me clarify what I was referring to.
If you have a keyword like
#+KEYWORD: value
Org parses it like (keyword) syntax.
and if you comment the keyword as
# #+KEYWORD: value
Org will _not_ parse something like (comment (keyword))
It will stop by seeing a (comment) and will not look further.
Such keyword will be ignored all the times and no special arrangement is
required during the export process.
* COMMENT headings
are different.
If you have something like
* COMMENT heading
#+KEYWORD: value
Org does look inside:
(heading (:commentedp t) (keyword))
Then, such keyword can contribute to calculation of buffer settings.
It is only `org-export-as' that makes special arrangement and physically
removes COMMENTed subtrees before exporting the buffer.
Hope it is now more clear.
--
Ihor Radchenko,
Org mode contributor,
Learn more about Org mode at https://orgmode.org/.
Support Org development at https://liberapay.com/org-mode,
or support my work at https://liberapay.com/yantar92
next prev parent reply other threads:[~2022-09-27 8:30 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-09-26 18:28 Confused about what the COMMENT keyword means Alain.Cochard
2022-09-27 1:55 ` Ihor Radchenko
2022-09-27 7:00 ` Alain.Cochard
2022-09-27 7:40 ` Ihor Radchenko [this message]
2022-09-30 8:57 ` Alain.Cochard
2022-10-02 4:48 ` [BUG] EXPORT_FILE_NAME keyword is used by `org-export-output-file-name' before macro expansion/INCLUDEs/removing COMMENTed trees (was: Confused about what the COMMENT keyword means) Ihor Radchenko
2022-10-11 14:42 ` Alain.Cochard
2022-10-18 8:53 ` Alain.Cochard
2022-11-10 1:56 ` Ihor Radchenko
2022-11-10 2:03 ` [FR] Allow TITLE to be used as default export file name (was: [BUG] EXPORT_FILE_NAME keyword is used by `org-export-output-file-name' before macro expansion/INCLUDEs/removing COMMENTed trees (was: Confused about what the COMMENT keyword means)) Ihor Radchenko
2022-11-10 7:53 ` Alain.Cochard
2022-11-10 8:04 ` Ihor Radchenko
2022-11-10 1:51 ` [BUG] EXPORT_FILE_NAME keyword is used by `org-export-output-file-name' before macro expansion/INCLUDEs/removing COMMENTed trees (was: Confused about what the COMMENT keyword means) Ihor Radchenko
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=87o7v1nu2e.fsf@localhost \
--to=yantar92@gmail.com \
--cc=Alain.Cochard@unistra.fr \
--cc=emacs-orgmode@gnu.org \
/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).