From: Ihor Radchenko <yantar92@posteo.net>
To: Loris Bennett <loris.bennett@fu-berlin.de>
Cc: emacs-orgmode@gnu.org
Subject: Re: the opposite of the noexport tag
Date: Tue, 24 Oct 2023 11:06:44 +0000 [thread overview]
Message-ID: <87bkco6zzv.fsf@localhost> (raw)
In-Reply-To: <87y1fsicjb.fsf@zedat.fu-berlin.de>
[-- Attachment #1: Type: text/plain, Size: 2261 bytes --]
"Loris Bennett" <loris.bennett@fu-berlin.de> writes:
>> + List of tags that will *only* be selected for export. The default
>
> I find the emphasised 'only' confusing here, since it implies to me
> there the tags might have some other function. I would find, in analogy
> to the corresponding text regarding exclude tags, the following text
> better:
>
> List of tags that will be included in the export.
> I assume that 'only' was meant to imply that the list of tags is
> exclusive in the sense that no other tags will be exported. However,
> talking about an 'exclusive list' the context of what will be included
> in the export is probably not going to be helpful.
What about
List of tags that will, if present, be selected for export. The
default value is ~org-export-select-tags~ =("export")=. When a tree
is tagged with =export=, Org selects that tree and its subtrees for
export, ignoring all the other sections that do not possess the
=export= tag.
When selectively exporting files with =export= tags set, Org does
not export any text that appears before the first headline.
Note that a file without the =export= tags will export all its
sections.
> Note that the keywords SELECT_TAGS and EXCLUDE_TAGS are not proper
> antonyms, which might be a possible source of confusion. I don't know
> how feasible it would be to replace (at least in the sense of an alias),
> these terms with, say,
>
> EXPORT_INCLUDE_TAGS
> EXPORT_EXCLUDE_TAGS
They are not exactly antonyms, because there is also the default
behavior with neither export nor noexport tags. With "export" tags,
everything but what is tagged "export" is dropped, including subtrees
without "export" tag.
With "noexport" tags, only the subtrees explicitly tagged "noexport" are
dropped. The subtrees with no "noexport"/"export" tags will still be
exported.
As for EXPORT_... prefix, we do not use it, except in heading
properties. It is by convention.
In any case, I do not see a big problem with the current terminology. It
is to late too change it, unless there is a stronger reason.
>> + List o tags that will be excluded from export. The default value is
>
> There is an 'f' missing in
>
> List o tags
Fixed
New version of the patch attached.
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: v3-0001-doc-org-manual.org-Improve-documentation-for-SELE.patch --]
[-- Type: text/x-patch, Size: 2948 bytes --]
From 5c6d1741519e02a3b9d2774faf511b0b90a4c788 Mon Sep 17 00:00:00 2001
Message-ID: <5c6d1741519e02a3b9d2774faf511b0b90a4c788.1698145210.git.yantar92@posteo.net>
From: Ihor Radchenko <yantar92@posteo.net>
Date: Mon, 23 Oct 2023 15:30:42 +0300
Subject: [PATCH v3] * doc/org-manual.org: Improve documentation for
#+SELECT_TAGS and #+EXCLUDE_TAGS
(Export Settings): Clarify how to define multiple tags per-document. Reword.
Link: https://orgmode.org/list/87y1ftilf3.fsf@mat.ucm.es
---
doc/org-manual.org | 38 +++++++++++++++++++++++++++-----------
1 file changed, 27 insertions(+), 11 deletions(-)
diff --git a/doc/org-manual.org b/doc/org-manual.org
index c0e9c8d7e..85568e7ab 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -12053,22 +12053,38 @@ ** Export Settings
#+cindex: @samp{SELECT_TAGS}, keyword
#+vindex: org-export-select-tags
- The default value is =("export")=. When a tree is tagged with
- =export= (~org-export-select-tags~), Org selects that tree and its
- subtrees for export. Org excludes trees with =noexport= tags, see
- below. When selectively exporting files with =export= tags set, Org
- does not export any text that appears before the first headline.
+ List of tags that will, if present, be selected for export. The
+ default value is ~org-export-select-tags~ =("export")=. When a tree
+ is tagged with =export=, Org selects that tree and its subtrees for
+ export, ignoring all the other sections that do not possess the
+ =export= tag.
+
+ When selectively exporting files with =export= tags set, Org does
+ not export any text that appears before the first headline.
+
+ Note that a file without the =export= tags will export all its
+ sections.
+
+ To select non-default tags for export, customize
+ ~org-export-select-tags~ (globally) or add =#+SELECT_TAGS: tag1
+ tag2= to the document.
- =EXCLUDE_TAGS= ::
#+cindex: @samp{EXCLUDE_TAGS}, keyword
#+vindex: org-export-exclude-tags
- The default value is =("noexport")=. When a tree is tagged with
- =noexport= (~org-export-exclude-tags~), Org excludes that tree and
- its subtrees from export. Entries tagged with =noexport= are
- unconditionally excluded from the export, even if they have an
- =export= tag. Even if a subtree is not exported, Org executes any
- code blocks contained there.
+ List of tags that will be excluded from export. The default value is
+ ~org-export-exclude-tags~ =("noexport")=. When a tree is tagged
+ with =noexport=, Org excludes that tree and its subtrees from
+ export.
+
+ Entries tagged with =noexport= are unconditionally excluded from the
+ export, even if they have an =export= tag. Even if a subtree is not
+ exported, Org executes any code blocks contained there.
+
+ To select non-default tags for the exclusion, customize
+ ~org-export-exclude-tags~ (globally) or add =#+EXCLUDE_TAGS: tag1
+ tag2= to the document.
- =TITLE= ::
--
2.42.0
[-- Attachment #3: Type: text/plain, Size: 225 bytes --]
--
Ihor Radchenko // yantar92,
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:[~2023-10-24 11:06 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-10-22 15:23 the opposite of the noexport tag Uwe Brauer
2023-10-22 16:18 ` Bruno Barbier
2023-10-22 16:33 ` Uwe Brauer
2023-10-22 16:42 ` Ihor Radchenko
2023-10-22 17:03 ` Uwe Brauer
2023-10-22 17:22 ` Ihor Radchenko
2023-10-22 19:38 ` Uwe Brauer
2023-10-23 8:19 ` Ihor Radchenko
2023-10-23 12:16 ` Uwe Brauer
2023-10-23 12:32 ` Ihor Radchenko
2023-10-23 12:34 ` Uwe Brauer
2023-10-23 12:59 ` Uwe Brauer
2023-10-23 13:23 ` Loris Bennett
2023-10-24 9:01 ` Ihor Radchenko
2023-10-24 9:40 ` Loris Bennett
2023-10-24 11:06 ` Ihor Radchenko [this message]
2023-10-25 8:27 ` Ihor Radchenko
2023-10-24 12:22 ` Uwe Brauer
2023-10-22 16:58 ` Bruno Barbier
2023-10-22 17:06 ` Uwe Brauer
2023-10-22 17:19 ` Bruno Barbier
2023-10-22 19:35 ` Uwe Brauer
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=87bkco6zzv.fsf@localhost \
--to=yantar92@posteo.net \
--cc=emacs-orgmode@gnu.org \
--cc=loris.bennett@fu-berlin.de \
/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).