[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/denote bc93a8ecda 137/355: Update the manual on the mat
From: |
ELPA Syncer |
Subject: |
[elpa] externals/denote bc93a8ecda 137/355: Update the manual on the matter of backlinks |
Date: |
Sun, 26 Jun 2022 23:58:14 -0400 (EDT) |
branch: externals/denote
commit bc93a8ecda8186395c5f5dce8440961a9869a990
Author: Protesilaos Stavrou <info@protesilaos.com>
Commit: Protesilaos Stavrou <info@protesilaos.com>
Update the manual on the matter of backlinks
---
README.org | 25 +++++++++++++------------
1 file changed, 13 insertions(+), 12 deletions(-)
diff --git a/README.org b/README.org
index c0ba460c00..6007a5e22f 100644
--- a/README.org
+++ b/README.org
@@ -494,22 +494,23 @@ point over the =TARGET=, =M-x find-file= followed by
=M-n= will fill the
path to that file (this also works with point over just the identifier
of a note).
-Backlinks are recorded at the end of a note under the heading with the
-title =Denote backlinks=. Users should not edit the note below this
-part manually: it is controlled by Denote, such as to delete duplicate
-links (in the future it might also handle stuff like alphabetic
-sorting).
+#+vindex: denote-link-insert-functions
+#+findex: denote-link-backlink
+Backlinks are optionally recorded at the end of a note under the heading
+with the title =Denote backlinks=. This is an opt-in feature that has
+to be set up by adding ~denote-link-backlinks~ to the special hook
+~denote-link-insert-functions~.
+
+The reason backlinks are off by default is because we might still make
+breaking changes on how they are implemented. For the time being,
+Denote expects that users do not edit the section with the backlinks: it
+is controlled by Denote, such as to delete duplicate links (in the
+future it might also handle stuff like alphabetic sorting). Suggestions
+to improve backlinking are most welcome!
The section with the backlinks is formatted according to the note's file
type.
-#+vindex: denote-link-insert-functions
-#+findex: denote-link-backlink
-The special hook ~denote-link-insert-functions~ is called after a link
-is created. It accepts two arguments for the target file and the
-formatted backlink to the original file. The function
-~denote-link-backlink~ provides an example for advanced users.
-
#+findex: denote-link-clear-stale-backlinks
Backlinks that no longer point to available notes can be removed from
the current buffer with the command ~denote-link-clear-stale-backlinks~.
- [elpa] externals/denote 86e437da43 150/355: Document .dir-locals.el for multi-type notes, (continued)
- [elpa] externals/denote 86e437da43 150/355: Document .dir-locals.el for multi-type notes, ELPA Syncer, 2022/06/27
- [elpa] externals/denote e92137a548 148/355: Use file attribute for mod time while renaming, ELPA Syncer, 2022/06/27
- [elpa] externals/denote c9926a528e 133/355: perf: Stop searching for the title or identifier after the 1st match, ELPA Syncer, 2022/06/27
- [elpa] externals/denote f55dee06b1 143/355: Add documentation about our minibuffer histories, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 97e8c30bcf 153/355: Rewrite the package Overview, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 171b873cb5 142/355: Require denote-retrieve (0e83bee) in denote-link, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 6a286c97f8 154/355: Rephrase statement for clarity, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 0e83bee5b7 141/355: Add denote-retrieve for internal purposes, ELPA Syncer, 2022/06/27
- [elpa] externals/denote b42f68c8e8 156/355: Add denote-type command, ELPA Syncer, 2022/06/27
- [elpa] externals/denote e841a51ca7 155/355: Fix typo, ELPA Syncer, 2022/06/27
- [elpa] externals/denote bc93a8ecda 137/355: Update the manual on the matter of backlinks,
ELPA Syncer <=
- [elpa] externals/denote 45bea4166a 158/355: Update Acknowledgements, ELPA Syncer, 2022/06/27
- [elpa] externals/denote d4cbb974a5 157/355: Rewrite node on multi file types (due to b42f68c), ELPA Syncer, 2022/06/27
- [elpa] externals/denote 479899d973 162/355: Clarify wording about journal/diary extras, ELPA Syncer, 2022/06/27
- [elpa] externals/denote e9bc790675 167/355: Clarify that auto-backlinks may be removed, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 4bc7aa4dfd 166/355: Remove outdated doc string from private function, ELPA Syncer, 2022/06/27
- [elpa] externals/denote d9f439e47f 173/355: Add helper function to prepare completion table, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 91090d42c6 180/355: Fix regexp match for backlinks, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 768372281f 177/355: Fix formatting typo, ELPA Syncer, 2022/06/27
- [elpa] externals/denote a47f32ec71 184/355: Implement new backlink facility, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 7674c6f854 170/355: Retrieve identifier from filename alone, ELPA Syncer, 2022/06/27