From: Marco Wahl <marcowahlsoft@gmail.com>
To: emacs-orgmode@gnu.org
Subject: [RFC] org-style
Date: Fri, 10 May 2019 13:55:08 +0200 [thread overview]
Message-ID: <84k1eyv80z.fsf@gmail.com> (raw)
Hi all,
For some time now I enforce a simple "style" for my org-mode files on
save. Concretely the style is just assuring the number of blank lines
immediately before a heading and the number of blank lines after the
meta section, e.g. a property-drawer, in each subtree.
This unifies my org files and I don't change blank lines by hand very
often any more.
What do you think about this? Is this worth to merge into org mode?
Ciao, Marco
P.S.: I have the code below in my init.el.
#v+
(defcustom org-style-blanklines-num-before-heading 1
"Number of blank lines before each heading.")
(defcustom org-style-blanklines-num-after-meta 1
"Number of blank lines after the heading meta section.
If this happens to be a section before a heading the value of
`num-blanklines-before-heading' is taken.")
(defun org-style-blanklines-assure (num)
"Assure exactly NUM blanklines and set point to the end of those.
The buffer remains unchanged when the blanklines are already there."
(skip-chars-backward "\t \n")
(let ((numplusone-newlines (make-string (1+ num) ?\n)))
(if (looking-at (concat numplusone-newlines "[^\n]"))
(goto-char (1- (match-end 0)))
(delete-region (point) (progn (skip-chars-forward "\t \n") (point)))
(insert numplusone-newlines))))
(defun org-style-blanklines-at-headings ()
"Apply blank lines style.
This is the number of blank lines:
. before a heading`org-style-num-blanklines-before-heading' and
. after the org meta data `org-style-num-blanklines-after-meta'."
(goto-char (point-min))
(unless (org-at-heading-p)
(outline-next-heading))
(while (and (not (eobp)) (< (point) (point-max)))
(cl-assert (org-at-heading-p) "programming logic error. shoot a programmer, but not me")
(org-style-blanklines-assure org-style-blanklines-num-before-heading)
(org-style-blanklines-after-next-meta-data org-style-blanklines-num-after-meta)
(unless (org-at-heading-p)
(outline-next-heading))))
(defun org-style-blanklines-after-next-meta-data (num)
"Assure exactly NUM blanklines after next meta data.
When end of meta data is a headline, then leave point there and
do nothing else."
(org-end-of-meta-data t)
(unless (org-at-heading-p)
(org-style-blanklines-assure num)))
;; style the org-mode buffer before save.
(add-hook 'before-save-hook
(lambda () (when (equal 'org-mode major-mode)
(save-excursion
(org-style-blanklines-at-headings)))))
#v-
next reply other threads:[~2019-05-10 11:55 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-05-10 11:55 Marco Wahl [this message]
2019-05-10 14:25 ` [RFC] org-style J. David Boyd
2019-05-10 15:17 ` Gregor Zattler
2019-05-13 22:41 ` Marco Wahl
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=84k1eyv80z.fsf@gmail.com \
--to=marcowahlsoft@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).