Skip to content

Commit

Permalink
Add org-noter package
Browse files Browse the repository at this point in the history
This package allows the creation of notes on a document (pdf, EPub,
etc.) which will be kept in sync with the document. Providing context
sensitive annotations that are managed in plaintext.
  • Loading branch information
Brian McGillion committed Apr 17, 2020
1 parent 65dacd1 commit 2dd84b8
Show file tree
Hide file tree
Showing 6 changed files with 36 additions and 1 deletion.
4 changes: 3 additions & 1 deletion modules/config/default/+emacs-bindings.el
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,9 @@
:desc "Bibliographic entries" "b"
(cond ((featurep! :completion ivy) #'ivy-bibtex)
((featurep! :completion helm) #'helm-bibtex)))

(:when (featurep! :lang org +noter)
:desc "Org noter" "e" #'org-noter)

:desc "Find file in notes" "f" #'+default/find-in-notes
:desc "Browse notes" "F" #'+default/browse-notes
:desc "Org store link" "l" #'org-store-link
Expand Down
3 changes: 3 additions & 0 deletions modules/config/default/+evil-bindings.el
Original file line number Diff line number Diff line change
Expand Up @@ -464,6 +464,9 @@
:desc "Toggle org-clock" "c" #'+org/toggle-clock
:desc "Cancel org-clock" "C" #'org-clock-cancel
:desc "Open deft" "d" #'deft
(:when (featurep! :lang org +noter)
:desc "Org noter" "e" #'org-noter)

:desc "Find file in notes" "f" #'+default/find-in-notes
:desc "Browse notes" "F" #'+default/browse-notes
:desc "Org store link" "l" #'org-store-link
Expand Down
13 changes: 13 additions & 0 deletions modules/lang/org/README.org
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
- [[#built-in-custom-link-types][Built-in custom link types]]
- [[#configuration][Configuration]]
- [[#changing-org-directory][Changing ~org-directory~]]
- [[#changing-org-noter-notes-search-path][Changing ~org-noter-notes-search-path~]]

* Description
This module adds org-mode support to Doom Emacs, along with a number of
Expand Down Expand Up @@ -68,6 +69,8 @@ https://www.mfoot.com/blog/2015/11/22/literate-emacs-configuration-with-org-mode
+ =+present= Enables integration with reveal.js, beamer and org-tree-slide, so
Emacs can be used for presentations.
+ =+roam= Enables org-roam integration.
+ =+noter= Enables org-noter integration. Keeps notes in sync with a document.
Requires [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Document-View.html][pdf-tools]] (=:tools pdf=) or [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Document-View.html][DocView]] or [[https://github.com/wasamasa/nov.el][nov.el]] to be enabled.

** Plugins
+ [[https://github.com/hniksic/emacs-htmlize][htmlize]]
Expand Down Expand Up @@ -121,6 +124,9 @@ https://www.mfoot.com/blog/2015/11/22/literate-emacs-configuration-with-org-mode
+ =+roam=
+ [[https://github.com/jethrokuan/org-roam][org-roam]]
+ [[https://github.com/jethrokuan/company-org-roam][company-org-roam]]
+ =+noter=
+ [[https://github.com/weirdNox/org-noter][org-noter]]


** Hacks
+ The window is recentered when following links.
Expand Down Expand Up @@ -223,3 +229,10 @@ To modify ~org-directory~ it must be set /before/ =org= has loaded:
;; ~/.doom.d/config.el
(setq org-directory "~/new/org/location/")
#+END_SRC
** Changing ~org-noter-notes-search-path~
To modify ~org-noter-notes-search-path~ set:

#+BEGIN_SRC emacs-lisp
;; ~/.doom.d/config.el
(setq org-noter-notes-search-path '("~/notes/path/"))
#+END_SRC
1 change: 1 addition & 0 deletions modules/lang/org/config.el
Original file line number Diff line number Diff line change
Expand Up @@ -965,6 +965,7 @@ compelling reason, so..."
(if (featurep! +pomodoro) (load! "contrib/pomodoro"))
(if (featurep! +present) (load! "contrib/present"))
(if (featurep! +roam) (load! "contrib/roam"))
(if (featurep! +noter) (load! "contrib/noter"))

;; Add our general hooks after the submodules, so that any hooks the
;; submodules add run after them, and can overwrite any defaults if necessary.
Expand Down
14 changes: 14 additions & 0 deletions modules/lang/org/contrib/noter.el
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
;;; lang/org/contrib/noter.el -*- lexical-binding: t; -*-
;;;###if (featurep! +noter)

(use-package! org-noter
:defer t
:preface
;; Allow the user to preempt this and set the document search path
;; If not set then use `org-directory'
(defvar org-noter-notes-search-path nil)
:config
(setq org-noter-auto-save-last-location t
org-noter-separate-notes-from-heading t)
(unless org-noter-notes-search-path
(setq org-noter-notes-search-path org-directory)))
2 changes: 2 additions & 0 deletions modules/lang/org/packages.el
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,8 @@
(package! org-roam :pin "e33c144298")
(when (featurep! :completion company)
(package! company-org-roam :pin "0913d86f16")))
(when (featurep! +noter)
(package! org-noter :pin "9ead81d42d"))

;;; Babel
(package! ob-async :pin "80a30b96a0")
Expand Down

0 comments on commit 2dd84b8

Please sign in to comment.