summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorYann Herklotz <git@yannherklotz.com>2022-12-24 13:41:27 +0000
committerYann Herklotz <git@yannherklotz.com>2022-12-24 13:41:27 +0000
commitfe0e50daa95510597ebd85f54c5289ed1e913942 (patch)
tree0aaa8686e98a16b957e4194a68a3822d9fe7312a
parent4d821a5200db11806efc62b2e9e562199c34f013 (diff)
downloadorg-zettelkasten-fe0e50daa95510597ebd85f54c5289ed1e913942.tar.gz
org-zettelkasten-fe0e50daa95510597ebd85f54c5289ed1e913942.zip
Update comments and base documentation for org-zettelkasten
-rw-r--r--org-zettelkasten-consult.el21
-rw-r--r--org-zettelkasten-counsel.el21
-rw-r--r--org-zettelkasten.el13
3 files changed, 32 insertions, 23 deletions
diff --git a/org-zettelkasten-consult.el b/org-zettelkasten-consult.el
index 85ec6d1..47dff6d 100644
--- a/org-zettelkasten-consult.el
+++ b/org-zettelkasten-consult.el
@@ -1,11 +1,14 @@
-;;; org-zettelkasten-consult.el --- Helper functions to use Zettelkasten in org-mode -*- lexical-binding: t; -*-
+;;; org-zettelkasten-consult.el --- Consult integration for org-zettelkasten -*- lexical-binding: t; -*-
+;; Copyright (C) 2022-2023 Yann Herklotz
+;;
;; Author: Yann Herklotz <yann@ymhg.org>
-;; Created: 2022
-;; Version: 0.3.0
-;; Package-Requires: ((emacs "24.3") (consult "0.20"))
+;; Maintainer: Yann Herklotz <yann@ymhg.org>
;; Keywords: files, hypermedia, Org, notes
-;; Homepage: https://github.com/ymherklotz/emacs-zettelkasten
+;; Homepage: https://git.sr.ht/~ymherklotz/org-zettelkasten
+;; Package-Requires: ((emacs "24.3") (org "9.0") (consult "0.20"))
+
+;; Version: 0.1.0
;; 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
@@ -22,13 +25,13 @@
;;; Commentary:
-;; These functions allow for the use of the zettelkasten method in org-mode.
-;;
-;; It uses the CUSTOM_ID property to store a permanent ID to the note,
-;; which are organised in the same fashion as the notes by Luhmann.
+;; An extension to org-zettelkasten for consult. This is mainly useful
+;; for a nicer interface to searching for back-references to the current
+;; identifier.
;;; Code:
+(require 'org)
(require 'consult)
(defun org-zettelkasten-consult-search-current-id ()
diff --git a/org-zettelkasten-counsel.el b/org-zettelkasten-counsel.el
index 5c48074..7f4a78a 100644
--- a/org-zettelkasten-counsel.el
+++ b/org-zettelkasten-counsel.el
@@ -1,11 +1,14 @@
-;;; org-zettelkasten-counsel.el --- Helper functions to use Zettelkasten in org-mode -*- lexical-binding: t; -*-
+;;; org-zettelkasten-counsel.el --- Counsel integration for org-zettelkasten -*- lexical-binding: t; -*-
+;; Copyright (C) 2022-2023 Yann Herklotz
+;;
;; Author: Yann Herklotz <yann@ymhg.org>
-;; Created: 2022
-;; Version: 0.3.0
-;; Package-Requires: ((emacs "24.3") (consult "0.20"))
+;; Maintainer: Yann Herklotz <yann@ymhg.org>
;; Keywords: files, hypermedia, Org, notes
-;; Homepage: https://github.com/ymherklotz/emacs-zettelkasten
+;; Homepage: https://git.sr.ht/~ymherklotz/org-zettelkasten
+;; Package-Requires: ((emacs "24.3") (org "9.0") (counsel "0.13"))
+
+;; Version: 0.1.0
;; 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
@@ -22,13 +25,13 @@
;;; Commentary:
-;; These functions allow for the use of the zettelkasten method in org-mode.
-;;
-;; It uses the CUSTOM_ID property to store a permanent ID to the note,
-;; which are organised in the same fashion as the notes by Luhmann.
+;; An extension to org-zettelkasten for counsel. This is mainly useful
+;; for a nicer interface to searching for back-references to the current
+;; identifier.
;;; Code:
+(require 'org)
(require 'counsel)
(defun org-zettelkasten-counsel-search-current-id ()
diff --git a/org-zettelkasten.el b/org-zettelkasten.el
index c1e69f5..5bdc756 100644
--- a/org-zettelkasten.el
+++ b/org-zettelkasten.el
@@ -1,11 +1,14 @@
-;;; org-zettelkasten.el --- Helper functions to use Zettelkasten in org-mode -*- lexical-binding: t; -*-
+;;; org-zettelkasten.el --- A Zettelkasten mode leveraging Org -*- lexical-binding: t; -*-
+;; Copyright (C) 2021-2023 Yann Herklotz
+;;
;; Author: Yann Herklotz <yann@ymhg.org>
-;; Created: 2021
-;; Version: 0.3.0
-;; Package-Requires: ((emacs "24.3") (org "9.0"))
+;; Maintainer: Yann Herklotz <yann@ymhg.org>
;; Keywords: files, hypermedia, Org, notes
-;; Homepage: https://github.com/ymherklotz/emacs-zettelkasten
+;; Homepage: https://git.sr.ht/~ymherklotz/org-zettelkasten
+;; Package-Requires: ((emacs "24.3") (org "9.0"))
+
+;; Version: 0.4.0
;; 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