emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Greg Minshall <minshall@umich.edu>
To: Robert Pluim <rpluim@gmail.com>
Cc: Org-mode <emacs-orgmode@gnu.org>
Subject: Re: patch to change org-adapt-indentation customization documentation
Date: Tue, 17 Nov 2020 17:20:45 +0300	[thread overview]
Message-ID: <839402.1605622845@apollo2.minshall.org> (raw)
In-Reply-To: Your message of "Tue, 17 Nov 2020 15:08:58 +0100." <87y2j0cbyd.fsf@gmail.com>

Robert,

> The whole point of customize is that you shouldn't have to worry about
> what the actual lisp value is. The actual lisp value only matters if
> you directly set the value without using customize.

thanks for the response.  i've included the documentation for
org-adapt-indentation below.  since the documentation talks about values
and associated behaviors, it might be helpful to mention the values in
the customization dialog.  an alternative maybe would be to re-do the
documentation to highlight the three customization phrases:
----
"Adapt indentation for all lines"
"Adapt indentation for headline data lines"
"Do not adapt indentation at all"
----
and not change the customization dialog?

i, anyway, was very uncertain, even after several rounds, as to which
customization option would give me the behavior i had read about in the
documentation.

cheers, Greg

====

org-adapt-indentation is a variable defined in ‘org.el’.
Its value is 'headline-data
Original value was t

  This variable is safe as a file local variable if its value
  satisfies the predicate ‘booleanp’.
  You can customize this variable.

Documentation:
Non-nil means adapt indentation to outline node level.

When this variable is set to t, Org assumes that you write
outlines by indenting text in each node to align with the
headline (after the stars).

When this variable is set to ’headline-data, only adapt the
indentation of the data lines right below the headline, such as
planning/clock lines and property/logbook drawers.

The following issues are influenced by this variable:

- The indentation is increased by one space in a demotion
  command, and decreased by one in a promotion command.  However,
  in the latter case, if shifting some line in the entry body
  would alter document structure (e.g., insert a new headline),
  indentation is not changed at all.

- Property drawers and planning information is inserted indented
  when this variable is set.  When nil, they will not be indented.

- TAB indents a line relative to current level.  The lines below
  a headline will be indented when this variable is set to t.

Note that this is all about true indentation, by adding and
removing space characters.  See also "org-indent.el" which does
level-dependent indentation in a virtual way, i.e. at display
time in Emacs.

[back]


  reply	other threads:[~2020-11-17 14:23 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-11-17 13:22 patch to change org-adapt-indentation customization documentation Greg Minshall
2020-11-17 14:08 ` Robert Pluim
2020-11-17 14:20   ` Greg Minshall [this message]
2020-11-18  9:49     ` Robert Pluim
2020-11-18 12:13       ` Greg Minshall
2020-11-19  4:05         ` Kyle Meyer

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=839402.1605622845@apollo2.minshall.org \
    --to=minshall@umich.edu \
    --cc=emacs-orgmode@gnu.org \
    --cc=rpluim@gmail.com \
    /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).