From 5ad372591777cf1c7356fdf692b223a4818ce455 Mon Sep 17 00:00:00 2001 From: Andreas Gerler Date: Wed, 26 Apr 2017 13:20:15 +0200 Subject: [PATCH] added org-sticky-header-mode Signed-off-by: Andreas Gerler --- bba.org | 11 + .../org-sticky-header-autoloads.el | 24 ++ .../org-sticky-header-pkg.el | 2 + .../org-sticky-header.el | 208 ++++++++++++++++++ elpa/org-sticky-header-readme.txt | 18 ++ 5 files changed, 263 insertions(+) create mode 100644 elpa/org-sticky-header-20170422.2135/org-sticky-header-autoloads.el create mode 100644 elpa/org-sticky-header-20170422.2135/org-sticky-header-pkg.el create mode 100644 elpa/org-sticky-header-20170422.2135/org-sticky-header.el create mode 100644 elpa/org-sticky-header-readme.txt diff --git a/bba.org b/bba.org index 785f9cba..fb50c29b 100644 --- a/bba.org +++ b/bba.org @@ -1015,6 +1015,7 @@ Open current buffers directory in gnu screen in iterm. #+END_SRC + ** Find next and previous =#+BEGIN_SRC sh= block. Very useful for repetitive literate devops jobs. then and so on. @@ -1701,6 +1702,16 @@ file. (message "Custom header file %s doesnt exist"))))) #+END_SRC +** org-sticky-header +[2017-04-26 Wed 13:09] + +#+BEGIN_SRC emacs-lisp :tangle yes + (add-to-list 'load-path "~/.emacs.d/elpa/org-sticky-header-20170422.2135" t) + (add-hook 'org-mode-hook + (lambda ()(org-sticky-header-mode 1)) + ) +#+END_SRC + ** additional org settings [2016-11-03 Thu 09:36] Thanks to [[https://github.com/dakrone/eos/blob/master/eos-org.org][eos-org]]. diff --git a/elpa/org-sticky-header-20170422.2135/org-sticky-header-autoloads.el b/elpa/org-sticky-header-20170422.2135/org-sticky-header-autoloads.el new file mode 100644 index 00000000..9f8600bc --- /dev/null +++ b/elpa/org-sticky-header-20170422.2135/org-sticky-header-autoloads.el @@ -0,0 +1,24 @@ +;;; org-sticky-header-autoloads.el --- automatically extracted autoloads +;; +;;; Code: +(add-to-list 'load-path (directory-file-name (or (file-name-directory #$) (car load-path)))) + +;;;### (autoloads nil "org-sticky-header" "org-sticky-header.el" +;;;;;; (22783 12160 0 0)) +;;; Generated autoloads from org-sticky-header.el + +(autoload 'org-sticky-header-mode "org-sticky-header" "\ +Minor mode to show the current Org heading in the header line. +With prefix argument ARG, turn on if positive, otherwise off. +Return non-nil if the minor mode is enabled. + +\(fn &optional ARG)" t nil) + +;;;*** + +;; Local Variables: +;; version-control: never +;; no-byte-compile: t +;; no-update-autoloads: t +;; End: +;;; org-sticky-header-autoloads.el ends here diff --git a/elpa/org-sticky-header-20170422.2135/org-sticky-header-pkg.el b/elpa/org-sticky-header-20170422.2135/org-sticky-header-pkg.el new file mode 100644 index 00000000..1391f702 --- /dev/null +++ b/elpa/org-sticky-header-20170422.2135/org-sticky-header-pkg.el @@ -0,0 +1,2 @@ +;;; -*- no-byte-compile: t -*- +(define-package "org-sticky-header" "20170422.2135" "Show off-screen Org heading at top of window" '((emacs "24.4") (org "8.3.5")) :url "http://github.com/alphapapa/org-sticky-header" :keywords '("hypermedia" "outlines" "org")) diff --git a/elpa/org-sticky-header-20170422.2135/org-sticky-header.el b/elpa/org-sticky-header-20170422.2135/org-sticky-header.el new file mode 100644 index 00000000..fc839e4a --- /dev/null +++ b/elpa/org-sticky-header-20170422.2135/org-sticky-header.el @@ -0,0 +1,208 @@ +;;; org-sticky-header.el --- Show off-screen Org heading at top of window -*- lexical-binding: t -*- + +;; Author: Adam Porter +;; Url: http://github.com/alphapapa/org-sticky-header +;; Package-Version: 20170422.2135 +;; Version: 0.1.0-pre +;; Package-Requires: ((emacs "24.4") (org "8.3.5")) +;; Keywords: hypermedia, outlines, Org + +;;; Commentary: + +;; This package displays in the header-line the Org heading for the +;; node that's at the top of the window. This way, if the heading for +;; the text at the top of the window is beyond the top of the window, +;; you don't forget which heading the text belongs to. + +;; The code is very simple and is based on `semantic-stickyfunc-mode'. + +;;; Installation: + +;; Install from MELPA and run `org-sticky-header-mode'. + +;; To install manually, put this file in your `load-path', require +;; `org-sticky-header' in your init file, and run the same command. + +;; You probably want to add `org-sticky-header-mode' to your `org-mode-hook'. + +;; By default, the line will be indented like a real headline. To +;; change this, configure `org-sticky-header-prefix'. + +;;; License: + +;; This program is free software; you can redistribute it and/or modify +;; it under the terms of the GNU General Public License as published by +;; the Free Software Foundation, either version 3 of the License, or +;; (at your option) any later version. + +;; This program is distributed in the hope that it will be useful, +;; but WITHOUT ANY WARRANTY; without even the implied warranty of +;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +;; GNU General Public License for more details. + +;; You should have received a copy of the GNU General Public License +;; along with this program. If not, see . + +;;; Code: + +;;;; Requirements + +(require 'cl-lib) +(require 'org) + +;;;; Variables + +(defvar org-sticky-header-old-hlf nil + "Value of the header line when entering org-sticky-header mode.") + +(defvar-local org-sticky-header-stickyline nil + "Value of header line") +(put 'org-sticky-header-stickyline 'risky-local-variable t) + +(defconst org-sticky-header-header-line-format + '(:eval (progn + (setq org-sticky-header-stickyline (org-sticky-header--fetch-stickyline)) + (list + (propertize " " 'display '((space :align-to 0))) + 'org-sticky-header-stickyline))) + "The header line format used by stickyfunc mode.") + +(defgroup org-sticky-header nil + "Options for `org-sticky-header-mode'." + :group 'org) + +(defcustom org-sticky-header-full-path nil + "Show the full outline path." + :type '(radio (const :tag "Show only current heading" nil) + (const :tag "Show full outline path to current heading" full) + (const :tag "Show full outline path, but reversed so current heading is first" reversed))) + +(defcustom org-sticky-header-always-show-header t + "Show the header even when the top line of the buffer is a heading. +When this is on, and the top line of the buffer is a heading, +you'll see the heading shown twice: once in the header and once +in the buffer. But since the header can look different than the +heading (i.e. it can show the full path), it shouldn't +necessarily disappear. If you use full-path display, you probably +want this on, but if you only display the current heading, you +might prefer to turn it off. " + :type 'boolean) + +(defcustom org-sticky-header-prefix 'org-sticky-header--indent-prefix + "Prefix to display before heading in header line. +`org-indent-mode' users should use the default function. Custom +functions will be run with point on a heading." + :type '(choice (function-item :tag "Like real headline" org-sticky-header--indent-prefix) + (string :tag "Custom string" :value " ") + (function :tag "Custom function which returns a string") + (const :tag "None" nil))) + +(defcustom org-sticky-header-outline-path-separator "/" + "String displayed between elements of outline paths." + :type 'string) + +(defcustom org-sticky-header-outline-path-reversed-separator "\\" + "String displayed between elements of reversed outline paths." + :type 'string) + +(defcustom org-sticky-header-heading-star "*" + "String to show before heading. +By default, show an asterisk, like in an Org buffer. Changing +this to something else may help distinguish the header line from +headings in the buffer when `org-sticky-header-always-show-header' +is enabled." + :type 'string) + +;;;; Functions + +(defun org-sticky-header--fetch-stickyline () + "Return string of Org heading or outline path for display in header line." + (save-excursion + (goto-char (window-start)) + (unless (org-before-first-heading-p) + ;; No non-header lines above top displayed header + (when (or org-sticky-header-always-show-header + (not (org-at-heading-p))) + ;; Header should be shown + (when (fboundp 'org-inlinetask-in-task-p) + ;; Skip inline tasks + (while (and (org-back-to-heading) + (org-inlinetask-in-task-p)) + (forward-line -1))) + (cond + ;; FIXME: Convert cond back to pcase, but one compatible with Emacs 24 + ((null org-sticky-header-full-path) + (concat (org-sticky-header--get-prefix) + (org-get-heading t t))) + ((eq org-sticky-header-full-path 'full) + (concat (org-sticky-header--get-prefix) + (org-format-outline-path (org-get-outline-path t) + (window-width) + nil org-sticky-header-outline-path-separator))) + ((eq org-sticky-header-full-path 'reversed) + (let ((s (concat (org-sticky-header--get-prefix) + (mapconcat 'identity + (nreverse (org-split-string (org-format-outline-path (org-get-outline-path t) + 1000 nil "") + "")) + org-sticky-header-outline-path-reversed-separator)))) + (if (> (length s) (window-width)) + (concat (substring s 0 (- (window-width) 2)) + "..") + s))) + (t nil)))))) + +(defun org-sticky-header--get-prefix () + "Return prefix string depending on value of `org-sticky-header-prefix'." + (cl-typecase org-sticky-header-prefix + (function (funcall org-sticky-header-prefix)) + (string org-sticky-header-prefix) + (nil nil))) + +(defun org-sticky-header--indent-prefix () + "Return indentation prefix for heading at point. +This will do the right thing both with and without `org-indent-mode'." + ;; Modelled after `org-indent-set-line-properties' + (let* ((level (org-current-level)) + (indent-mode (bound-and-true-p org-indent-mode)) + (npre (if (<= level 1) 0 + (+ (if indent-mode + (* (1- org-indent-indentation-per-level) + (1- level)) + 0) + level -1))) + (prefix (concat (make-string npre (if indent-mode ?\ ?*)) org-sticky-header-heading-star " "))) + (org-add-props prefix nil 'face + (if org-cycle-level-faces + (setq org-f (nth (% (1- level) org-n-level-faces) org-level-faces)) + (setq org-f (nth (1- (min level org-n-level-faces)) org-level-faces)))))) + +;;;; Minor mode + +;;;###autoload +(define-minor-mode org-sticky-header-mode + "Minor mode to show the current Org heading in the header line. +With prefix argument ARG, turn on if positive, otherwise off. +Return non-nil if the minor mode is enabled." + :group 'org + (if org-sticky-header-mode + (progn + (when (and (local-variable-p 'header-line-format (current-buffer)) + (not (eq header-line-format org-sticky-header-header-line-format))) + ;; Save previous buffer local value of header line format. + (set (make-local-variable 'org-sticky-header-old-hlf) + header-line-format)) + ;; Enable the mode + (setq header-line-format org-sticky-header-header-line-format)) + ;; Disable mode + (when (eq header-line-format org-sticky-header-header-line-format) + ;; Restore previous buffer local value of header line format if + ;; the current one is the sticky func one. + (kill-local-variable 'header-line-format) + (when (local-variable-p 'org-sticky-header-old-hlf (current-buffer)) + (setq header-line-format org-sticky-header-old-hlf) + (kill-local-variable 'org-sticky-header-old-hlf))))) + +(provide 'org-sticky-header) + +;;; org-sticky-header.el ends here diff --git a/elpa/org-sticky-header-readme.txt b/elpa/org-sticky-header-readme.txt new file mode 100644 index 00000000..294e434d --- /dev/null +++ b/elpa/org-sticky-header-readme.txt @@ -0,0 +1,18 @@ +This package displays in the header-line the Org heading for the +node that's at the top of the window. This way, if the heading for +the text at the top of the window is beyond the top of the window, +you don't forget which heading the text belongs to. + +The code is very simple and is based on `semantic-stickyfunc-mode'. + +Installation: + +Install from MELPA and run `org-sticky-header-mode'. + +To install manually, put this file in your `load-path', require +`org-sticky-header' in your init file, and run the same command. + +You probably want to add `org-sticky-header-mode' to your `org-mode-hook'. + +By default, the line will be indented like a real headline. To +change this, configure `org-sticky-header-prefix'. -- 2.47.3