- Notifications
You must be signed in to change notification settings - Fork12
Emacs package that helps org-mode users (re)discover similar documents
License
brunoarine/org-similarity
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
org-similarity is a package to help Emacsorg-mode users (re)discover similar documents in relation to the current buffer or to an input query using lexical similarity calculation algorithms like TF-IDF and BM25.
A good note-taking system should help you connect your ideas. But what if you have many years worth of notes in your computer, and you can’t remember the older ones?
That’s why I’ve writtenorg-similarity. As an avidorg-roam user with more than a thousand notes, I can’t count on my brain to recall them all.
org-similarity makes it easier to retrieve those long forgotten files that are possibly buried in everyone’s piles of notes. It’s different from a simple keyword search. This package is levered byhttps://github.com/brunoarine/findlike, which looks at the words and phrases used in your reference document or a specific question you have, and then finds other files that use similar language. It’s a bit like doing a Google search across your own files.
- Emacs 27.1+
- Python 3.6+
- Git 2.23+ (for manual installation)
You can installorg-similarity usingstraing.el, its Doom Emacs wrapper, or manually cloning the repository. In either case, you can choose to use themain branch for a stable version of the repository,develop for the latest additions, or{RELEASE_VERSION} for a specific release version (e.g.v1.0.0). Just replace thebranch property accordingly in the instructions below.
Using straight.el
Add the following to yourinit.el:
(straight-use-package '(org-similarity:type git:host github:repo"brunoarine/org-similarity":branch"main"))
Doom Emacs
Add the following topackages.el:
(package! org-similarity:recipe (:host github:repo"brunoarine/org-similarity":branch"main"))
Manual installation
Clone the repository:
git clone -b main https://github.com/brunoarine/org-similarity
Then add the package to yourload-path in yourinit.el:
(add-to-list'load-path"/path/to/org-similarity")
Load the package using therequire function in yourinit.el:
(require'org-similarity)
Or usinguse-package:
(use-package org-similarity:load-path"path/to/org-similarity")
Upon running the commands below for the first time,org-similarity will ask you to install the necessary Python dependencies (if they are not found in the configured environment—seeConfiguration for more info). By pressingy to continue, it will create a virtual environment under the hood and download the requirements automatically. Once finished, you can close the installation log buffer, and run the command again.
| Command | Description |
|---|---|
M-x org-similarity-insert-list | Inserts a list of files that are similar to the current buffer at the end of it. |
M-x org-similarity-sidebuffer | Shows a list of files that are similar to the current buffer in a side buffer. |
M-x org-similarity-query | Lets the user input a query and shows a list of related documents in the side buffer. |
There are a few variables that can be set to customize howorg-similarity operates and generates the list of similar documents:
;; Directory to scan for possibly similar documents.;; org-roam users might want to change it to`org-roam-directory'.(setq org-similarity-directory org-directory);; Filename extension to scan for similar text. By default, it will;; only scan Org-mode files, but you can change it to scan other;; kind of files as well.(setq org-similarity-file-extension-pattern"*.org");; Changing this value will impact stopwords filtering and word stemmer.;; The following languages are supported: Arabic, Danish, Dutch, English, Finnish,;; French, German, Hungarian, Italian, Norwegian, Portuguese, Romanian, Russian,;; Spanish and Swedish.(setq org-similarity-language"english");; Algorithm to use when generating the scores list. The possible choices are;;`tfidf' or`bm25'. Default is`tfidf' and it generally works better in;; most cases. However,`bm25' may be a bit more robust in rare cases, depending;; on the size of your notes.(setq org-similarity-algorithm"tfidf");; How many similar entries to list at the end of the buffer.(setq org-similarity-number-of-documents10);; Minimum document size (in number of characters) to be included in the corpus.;; It includes every character, including the file properties drawer.;; Default is 0 (include all documents, even empty ones).(setq org-similarity-min-chars0);; Whether to prepend the list entries with similarity scores.(setq org-similarity-show-scoresnil);; Similarity score threshold. All results with a similarity score below this;; value will be omitted from the final list.;; Default is 0.05.(setq org-similarity-threshold0.05);; Whether the resulting list of similar documents will point to ID property or;; filename. Default is nil.;; However, I recommend setting it to`t' if you use`org-roam' v2.(setq org-similarity-use-id-linksnil);; Scan for files inside`org-similarity-directory' recursively.(setq org-similarity-recursive-searchnil);; Filepath to a custom Python interpreter (e.g. '/path/to/venv/bin/python';; If the package's requirements aren't met,`org-similarity' will try to;; install or upgrade them automatically. If`nil', the package will create;; and use a virtual environment in the same directory where`org-similarity';; is located (usually`~/.emacs.d/.local' if you installed via a package;; manager, or in the path where you cloned this repo and loaded the package;; manually).(setq org-similarity-custom-python-interpreternil);; Remove first result from the scores list. Useful if the current buffer is;; saved in the searched directory, and you don't want to see it included;; in the list. Default is nil."(setq org-similarity-remove-firstnil);; Text to show in the list heading. You can set it to "" if you;; wish to hide the heading altogether.(setq org-similarity-heading"** Related notes");; String to prepend the list items. You can set it to "* " to turn each;; item into org headings, or "- " to turn them into an unordered org list.;; Set the variable to "" to hide prefixes.(setq org-similarity-prefix"-");; Ignore org front-matter when calculating similarity scores. This option can;; be useful if you think the results are inappropriately biased due to the;; presence of some values in the the Org files' Properties drawer, like;; filetags or categories.(setq org-similarity-ignore-frontmatternil)
About
Emacs package that helps org-mode users (re)discover similar documents
Topics
Resources
License
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Packages0
Contributors3
Uh oh!
There was an error while loading.Please reload this page.