From: Timothy <tecosaur@gmail.com>
To: org-mode-email <emacs-orgmode@gnu.org>
Subject: [PATCH] Improve documentation of #+startup keyword
Date: Fri, 19 Mar 2021 20:03:09 +0800 [thread overview]
Message-ID: <874kh72vrl.fsf@gmail.com> (raw)
[-- Attachment #1: Type: text/plain, Size: 478 bytes --]
Hello all,
I was talking to someone who was finding the behaviour of `#+startup'
confusing, and they managed to work out a table summarising the
behaviour.
I think that this would be a good addition to the manual, and help
clarify the behaviour --- so I've prepared a little patch to the manual.
I notice that there are some `#+cindex' lines lying around but I'm not
quite sure what they do. Please let me know if I should add anything
like that etc.
All the best,
*Timothy*
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-doc-org-manual.org-clarify-startup-behaviour.patch --]
[-- Type: text/x-patch, Size: 1720 bytes --]
From 8ff32dfbf2e14419eb542d58ee39c1545f34354b Mon Sep 17 00:00:00 2001
From: TEC <tec@tecosaur.com>
Date: Fri, 19 Mar 2021 20:01:03 +0800
Subject: [PATCH] doc/org-manual.org: clarify #+startup behaviour
* doc/org-manual.org: clarify the behaviour that each #+startup option
implies.
---
doc/org-manual.org | 13 +++++++++++++
1 file changed, 13 insertions(+)
diff --git a/doc/org-manual.org b/doc/org-manual.org
index e8763ff17..a005cce52 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -598,6 +598,19 @@ *** Initial visibility
is requested by startup options and =VISIBILITY= properties in
individual entries.
+A summary of each keyword's behaviour may be seen in the table below.
+| #+startup: | org-startup-folded | VISIBILITY | shows headings | shows body |
+|---------------------+--------------------+------------+----------------+------------|
+| overview (or fold) | t | x | lvl1 | |
+| content | 'content | x | all | |
+| show2levels | 'show2levels | x | lvl1-2 | |
+| ... | 'showNlevels | x | lvl1-N | |
+| show5levels | 'show5levels | x | lvl1-5 | |
+| showall (or nofold) | nil | x | all | x |
+| showeverything | 'showeverything | | all | x |
+| <DEFAULT> | 'showeverything | | all | x |
+
+
*** Catching invisible edits
:PROPERTIES:
:DESCRIPTION: Preventing mistakes when editing invisible parts.
--
2.30.1
next reply other threads:[~2021-03-19 12:07 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-03-19 12:03 Timothy [this message]
2021-04-26 7:45 ` [PATCH] Improve documentation of #+startup keyword Bastien
2021-04-26 8:04 ` Detlef Steuer
2021-04-26 8:21 ` Bastien
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=874kh72vrl.fsf@gmail.com \
--to=tecosaur@gmail.com \
--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).