13 KiB
Changelog
1.1.2 (TBD)
Breaking Changes
- #701 Use
emacsql-sqlite3instead ofemacsql-sqlitefor better Windows compatibility. This requires the presence of the standardsqlite3binary on your machine.
1.1.1 (18-05-2020)
In this release, we added two new features:
org-roam-doctor: a linting system that helps you discover possible problems with your Org-roam files. This is in the spirit of keeping notes in top quality.- A tagging system: one can now use sub-directories, and the
#+ROAM_TAGkey add additional meta data to notes. For more information, see here.
As usual, this release comes with a multitude of bug-fixes and refactorings.
Breaking Changes
- #523 remove
org-roam-completion-fuzzy-matchin favor of using completion mechanism's configuration options directly - #547 Deprecate
org-roam-db--maybe-update, in favour oforg-roam-db--update-maybe - #604 Deprecate
org-roam-title-include-subdirs,org-roam-title-subdir-formatorg-roam-title-subdir-separator, for a more general tagging system built on subdirectories
Bugfixes
- #509 fix backup files being tracked in database
- #509 fix external org files being tracked in database
- #537 quote graphviz node and edge configuration options to allow multi-word configurations
- #545 fix
org-roam--extract-linksto ensure that multiple citations (cite:key1,key2) are split correctly - #547 Fix unlinked citations
- #660 fix rename-file advice not working for renaming to directories
- #660 fix links breaking within file on file movement
Features
- #538 Optionally use text in first headline as title
- #553 Add prefix argument to
org-roam-db-build-cachefor forcing rebuilds - #560 Apply 'error face to distinguish broken links
- #570 Add
org-roam-doctorto diagnose org-roam files - #625 Add
org-roam-title-sourcesto control how titles are retrieved within notes - #604 Add a tagging system.
org-roam-tag-sourcescontrols how tags are retrieved from notes
Internal Changes
- #547 Added
typecolumn to therefstable - #606 Added
org-roam-dev.elfor developer coding standards - #622 Online documentation now points to the Org-based documentation
1.1.0 (21-04-2020)
To the average user, this release is mainly a bugfix release with additional options to customize. However, the changes made to the source is significant. Most notably, in this release:
- The codebase has been modularized into separate files, to ease future maintenance and adding of new features (mainly by @progfolio). Because of these changes, we had to rename many functions and variables: the old names are kept for backwards compatibility, but you are encouraged to use the new function names. You'll receive a warning when you're calling the function with its obsolete name.
- @kljohann did some fantastic work on graph generation: allowing building images for connected components within the graph up to a specified distance
- We also started supporting
org-refnatively: cite links now show up in both the graph and the org-roam buffer.
In the coming months, you can expect work on bigger projects (e.g. revamping the org-roam buffer).
Breaking Changes
- #385 Deprecate
org-roam-graph-node-shapein favour oforg-roam-graph-node-extra-config. - #473 Deprecate
org-roam-date-filename-formatandorg-roam-date-title-format, in favour oforg-roam-dailies-capture-templates.
New Features
- #350 Add
org-roam-db-locationto customize location of org-roam database. - #359 Add
org-roam-verboseto allow or silence printing of information. - #374 Add support for
org-refcite:links - #380 Allow
org-roam-buffer-positionto also betoporbottom - #385 Add
org-roam-graph-node-extra-configto configure Graphviz nodes - #398, #418 Add graph building for connected components
- #435 Add
org-roam-graph-edge-extra-configto configure Graphviz edges - #439 Add support for
org-refcitations to display as edges in graph. Addorg-roam-graph-edge-cites-extra-configto configure these edges - #465 Add
org-roam-file-extensionsto allow detection of org files with different file extensions - #488 Allow a function for
org-roam-graph-viewer - #491 Use TITLE as description when linking before first heading
Bugfixes
- #470 Add workaround for undocumented
file-truenamebehaviour inorg-roam--org-roam-file-p.
Internal Changes
1.0.0 (23-03-2020)
Org-roam is now on MELPA! We have squashed most of the bugs, and Org-roam has been stable for the most part.
New Features
- #269 Add
org-roam-graphviz-extra-options - #257 Add a company-backend
company-org-roam - #284, #289 Configurable
org-roam-completion-systemwith options'default,'ido,'ivyand'helm - #289 Add customizable
org-roam-fuzzy-matchto allow fuzzy-matching of candidates - #290 Add
org-roam-date-title-formatandorg-roam-date-filename-formatfor customizing Org-roam's date files - #296 Allow multiple exclusion matchers in
org-roam-graph-exclude-matcher
Bugfixes
- #293 Fix capture templates not working as expected for
org-roam-find-file - #275 Fix database rebuild when
org-roam-directoryis set locally
1.0.0-rc1 (06-03-2020)
This is a pre-release before the push to MELPA. It contains large
internal changes, with little user-facing changes. Most notably, the
backing storage has been changed to a SQLite database, and a
templating system using org-capture is introduced.
Breaking Changes
- #200 Move Org-roam cache into a SQLite database.
- #203 Roam protocol is deprecated, in favour of extending org-roam-protocol.
New Features
- #182 Support file name aliases via
#+ROAM_ALIAS. - #216 Adds templating functionality by extending org-capture.
- #232 Adds a prefix key to
org-roam-show-graph, to generate graph without opening it. - #233 Adds
org-roam-graph-exclude-matcher, which allows exclusion of nodes from graph. - #247 Add
org-roam-backlinkface, which allows customizing backlinks appearance - #259 Add optional initial-prompt to
org-roam-find-file
Bugfixes
- #207, #221 small bugfixes to Org-roam graph generation
- #230 remove nonspacing marks from filenames, to prevent cross-platform errors
New Contributors
0.1.2 (2020-02-21)
Breaking Changes
- #143
org-roam-modeis now a global mode. The installation instructions have changed accordingly. - #103 Change
org-roam-file-formatto a function:org-roam-file-name-functionto allow more flexible file name customizaton. Also changesorg-roam-use-timestamp-as-filenametoorg-roam-filename-noconfirmto better describe what it does.
New Features
- #145
org-roam-show-graph: Fallback to Emacs SVG viewer - #141 add variable
org-roam-new-file-directoryfor new Org-roam files - #138 add
org-roam-switch-to-buffer - #124, #141 Maintain cache consistency on file rename and delete
- #87, #90 Support encrypted Org files
- #110 Add prefix to
org-roam-insert, for inserting titles down-cased - #99 Add keybinding so that
<return>ormouse-1in the backlinks buffer visits the source file of the backlink at point
Changes
- #108 Locally overwrite the link following behaviour in the org-roam-buffer to open files in the same window
org-roamwas called from
Bugfixes
- #86 Fix
org-roam--parse-contentincorrect:tocomputation for nested files - #98 Fix
org-roam--find-filepicking up temporary files - #136 Misc bugfixes
Internal
New Contributors
0.1.1 (2020-02-15)
Mostly a documentation/cleanup release.
New Features
- #62 Add the options
org-roam-use-timestamps-as-filenameandorg-roam-file-format, more in documentation.
Breaking Changes
- #62 The ID (file-name) workflow is no longer first-class, but a fallback when titles don't exist.
Changes
- #66, #68: Improved the quality of the package in preparation of submission to MELPA
- #73: Added CI to the project via Github Issues (Thanks @alphapapa for scripts and setup)
- #69, #72, #75: Major cleanup and de-duplication of code