From: Maxim Nikulin <manikulin@gmail.com>
To: emacs-orgmode@gnu.org
Subject: [PATCH] org-faq.org: Expand "What is the best setup for indenting?"
Date: Thu, 20 May 2021 00:08:06 +0700 [thread overview]
Message-ID: <s83glm$pnc$2@ciao.gmane.io> (raw)
In-Reply-To: <87zgwvg1qg.fsf@gnu.org>
---
org-faq.org | 61 ++++++++++++++++++++++++++++++++++++++---------------
1 file changed, 44 insertions(+), 17 deletions(-)
diff --git a/org-faq.org b/org-faq.org
index 9cc193c4..0f8934af 100644
--- a/org-faq.org
+++ b/org-faq.org
@@ -1029,21 +1029,33 @@ something like this:
:CUSTOM_ID: indentation
:END:
-Indentation is a matter of personal preferences. General indentation
-preferences are controlled in Emacs via ~electric-indent-mode~. Org
-indentation behavior changes depending on ~org-adapt-indentation~, which
-accepts three values: =nil= (no special indentation), =t= (always indent
-relatively the the element above) and =headline-data= (only indent the
-~PROPERTIES/LOGBOOK~ drawers relatively to the current level). On top
-of these two configuration areas, there the difference between =RET= and
-=C-j=.
-
-Here are two tables summarizing the behavior depending on whether
-~electric-indent-mode~ is enable (the default) or not:
-
-With `electric-indent-mode' enabled:
-
-| org-adapt-indentation => | nil | t | headline-data |
+Indentation, both appearance and behavior, is a matter of personal
+preferences. You may try if the following adjustments suits better
+for you than the defaults. Set ~org-adapt-indentation~ to have
+content aligned to headline titles. Disable ~electric-indent-mode~ to
+avoid automatic indentation in response to =RET= key.
+
+In more details, ~org-adapt-indentation~ controls indentation with
+regards to previous element. Apparent effect is increased indentation
+for content of deeper nested headings. The variable accepts three
+values: =nil= (no special indentation), =t= (always indent relatively
+the the element above) and =headline-data= (only indent the
+~PROPERTIES/LOGBOOK~ drawers relatively to the current level). Value
+=t= is suitable for short entries especially if you plan to share your
+documents with someone who does not use Emacs. If you just want to
+make heading level more prominent then consider adding visual left
+margin using =#+STARTUP: indent= as described in the [[https://orgmode.org/manual/Clean-View.html#Clean-View][Clean View]]
+section of the manual. The option works without adding extra spaces
+to the document text.
+
+Configured indentation may be applied in response to =RET= or to
+=C-j= depending on the state of ~electric-indent-mode~. The following
+tables summarizes the difference. Version number is added to column
+header if it describes default settings.
+
+With ~electric-indent-mode~ enabled:
+
+| org-adapt-indentation => | nil (Org >= 9.5) | t (Org 9.4) | headline-data |
|---------------------------+------------------------+----------------------------+----------------------------|
| RET after a headline | Do not indent | Indent | Do not indent |
| C-j after a headline | Do not indent | Do not indent | Do not indent |
@@ -1051,9 +1063,9 @@ With `electric-indent-mode' enabled:
| C-j anywhere | Do not indent wrt prev | Do not indent wrt previous | Do not indent wrt previous |
| Insert PROPERTIES/LOGBOOK | Do not indent | Indent wrt headline | Indent wrt headline |
-With `electric-indent-mode' disabled:
+With ~electric-indent-mode~ disabled:
-| org-adapt-indentation => | nil | t | headline-data |
+| org-adapt-indentation => | nil | t | headline-data (Org < 9.4) |
|---------------------------+---------------------+----------------------------+----------------------------|
| RET after a headline | Do not indent | Do not indent | Do not indent |
| C-j after a headline | Do not indent | Indent | Do not indent |
@@ -1061,6 +1073,21 @@ With `electric-indent-mode' disabled:
| C-j | Indent wrt previous | Indent wrt previous | Indent wrt previous |
| Insert PROPERTIES/LOGBOOK | Do not indent | Indent wrt headline | Indent wrt headline |
+Do not try to avoid or to ignore indentation of heading body or
+properties drawer determined by current state of
+~org-adapt-indentation~ and ~electric-indent-mode~ by pressing =C-j=
+instead of =RET= (or vice versa). The result is transient and you will
+lost formatting when you refile heading or change its level (promote
+or demote it).
+
+You may have noticed recommendation to disable ~electric-indent-mode~
+to restore behavior prior to Org 9.4. In Org 9.5
+~org-adapt-indentation~ default value changed to =nil= and, that is
+more important, a number of bugs related to indentation were fixed.
+Using =RET= with enabled ~electric-indent-mode~ should be convenient
+now. Just customize ~org-adapt-indentation~ variable accordingly to
+you preferences.
+
** Can I migrate from Planner?
Yes. This [[http://www.c0t0d0s0.de/plan2org/plan2org.pl][perl script]] or [[http://gitorious.org/bkuhn-small-hacks/org-mode/blobs/master/planner2org.plx
--
2.25.1
next prev parent reply other threads:[~2021-05-19 17:09 UTC|newest]
Thread overview: 46+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-05-02 6:09 [POLL] Setting `org-adapt-indentation' to nil by default? Bastien
2021-05-02 7:13 ` Tim Cross
2021-05-02 8:06 ` Jean Louis
2021-05-02 8:47 ` Tim Cross
2021-05-02 20:18 ` Jean Louis
2021-05-02 22:25 ` Tim Cross
2021-05-03 7:41 ` Kévin Le Gouguec
2021-05-03 10:15 ` Jean Louis
2021-05-02 8:56 ` Bastien
2021-05-02 8:59 ` Bastien
2021-05-02 20:24 ` Jean Louis
2021-05-02 20:21 ` Jean Louis
2021-05-02 20:22 ` Jean Louis
2021-05-02 10:07 ` Eric S Fraga
2021-05-02 15:01 ` Detlef Steuer
2021-05-02 15:44 ` Colin Baxter
2021-05-02 15:46 ` Amin Bandali
2021-05-02 18:11 ` Tom Gillespie
2021-05-02 18:19 ` Nicolas Goaziou
2021-05-02 18:48 ` Tom Gillespie
2021-05-02 19:20 ` Nicolas Goaziou
2021-05-03 10:11 ` Dr. Arne Babenhauserheide
2021-05-02 18:31 ` Jim Porter
2021-05-02 20:44 ` Kévin Le Gouguec
2021-05-03 7:33 ` Kévin Le Gouguec
2021-05-03 8:06 ` Bastien
2021-05-03 12:53 ` Kévin Le Gouguec
2021-05-03 13:40 ` Bastien
2021-05-03 14:57 ` Kévin Le Gouguec
2021-05-06 14:50 ` Maxim Nikulin
2021-05-15 20:51 ` Bastien
2021-05-19 17:02 ` [PATCH] etc/ORG-NEWS: Suggest against disabling `electric-indent-mode' Maxim Nikulin
2021-05-20 12:25 ` Bastien
2021-05-19 17:08 ` Maxim Nikulin [this message]
2021-05-19 18:06 ` [PATCH] org-faq.org: Expand "What is the best setup for indenting?" Greg Minshall
2021-05-20 15:57 ` Maxim Nikulin
2021-05-21 2:45 ` Greg Minshall
2021-05-27 16:11 ` Maxim Nikulin
2021-05-21 9:38 ` Bastien
2021-05-20 12:28 ` Bastien
2021-05-19 17:08 ` [POLL] Setting `org-adapt-indentation' to nil by default? Maxim Nikulin
2021-05-02 21:07 ` Jack Kamm
2021-05-05 7:54 ` Bastien
2021-05-06 14:13 ` Bastien
2021-05-09 16:42 ` Kévin Le Gouguec
2021-05-15 12:46 ` 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='s83glm$pnc$2@ciao.gmane.io' \
--to=manikulin@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).