Skip to content

Commit dd954ac

Browse files
author
George Moutsopoulos
committed
readme
1 parent 3f8ad57 commit dd954ac

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

Readme.org

+3-3
Original file line numberDiff line numberDiff line change
@@ -83,13 +83,13 @@ To use, load
8383
#+begin_src
8484
(require 'org-annotate-word)
8585
#+end_src
86-
This creates a link like ~[[word:filename::position::word]]~ that searches for the word near a line number in a file. It will not register with any modes by default.
86+
This creates a link like ~[[word:filename::position::word]]~ that searches for the word near a line number in a file. It will not register with any modes by default.
8787

88-
This annotator will keep track of line numbers changes if the text is changed while ~org-annotate-live-mode~ is loaded. It will change the org-file accordingly each time
88+
As it stands, the links will quickly become stale as the file is editted. This annotator will keep track of word position changes if the text is changed while ~org-annotate-live-mode~ minor mode is loaded. It will change the org-file accordingly each time:
8989
- The file is saved
9090
- The user calls ~org-annotate-live-sync-register~
9191
- A new annotation is made
92-
However, if you use the live mode, currently, link ids will be renamed to stale if the file changed while ~org-annotate-live-mode~ was not loaded. The live mode is still experimental.
92+
However, if you use the live mode, link ids will be renamed to stale if the file changed while ~org-annotate-live-mode~ was not loaded. The live mode is still experimental. There is currently the option to use file hashes to invalidate links to stale or a strict search for the word at the link's position. Future word might feature using git.
9393

9494
You can also checkout [[https://github.com/bastibe/annotate.el][annotation-mode]], a maturer project, for live changing the line numbers as text is edited.
9595
** index

0 commit comments

Comments
 (0)