[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/denote 5977a9bc7b 164/355: Add warning about likely cha
From: |
ELPA Syncer |
Subject: |
[elpa] externals/denote 5977a9bc7b 164/355: Add warning about likely changes to denote-link.el |
Date: |
Sun, 26 Jun 2022 23:58:18 -0400 (EDT) |
branch: externals/denote
commit 5977a9bc7bbe02d726447075f7c4d3e415917666
Author: Protesilaos Stavrou <info@protesilaos.com>
Commit: Protesilaos Stavrou <info@protesilaos.com>
Add warning about likely changes to denote-link.el
---
README.org | 5 +++++
denote-link.el | 43 +++----------------------------------------
2 files changed, 8 insertions(+), 40 deletions(-)
diff --git a/README.org b/README.org
index 4507a8a290..bca06ae3d7 100644
--- a/README.org
+++ b/README.org
@@ -540,6 +540,11 @@ participate in the development of Denote.
:CUSTOM_ID: h:fc913d54-26c8-4c41-be86-999839e8ad31
:END:
+The linking facility is subject to review and there will likely be
+breaking changes. This is the only area that needs to be fixed before
+we release the first stable version of the package. WHAT FOLLOWS IS NOT
+DEFINITIVE.
+
#+findex: denote-link
Denote has a basic linking facility to quickly establish connections
between notes. The command ~denote-link~ prompts for a file name in the
diff --git a/denote-link.el b/denote-link.el
index f5c4014bfd..ed0c6d7b29 100644
--- a/denote-link.el
+++ b/denote-link.el
@@ -24,46 +24,9 @@
;;; Commentary:
;;
-;; Denote has a basic linking facility to quickly establish connections
-;; between notes. The command `denote-link' prompts for a file name in the
-;; `denote-directory' (only regular files are considered, not directories).
-;; It then retrieves the path of the given note, inserts it at point using
-;; the appropriate link notation, and creates a backlink entry in the
-;; target file (again using the appropriate notation).
-;;
-;; What constitutes "appropriate link notation" depends on the file type
-;; of the given entry per `denote-file-type' (see "The file naming
-;; scheme" in the manual). For example when linking from an Org file to
-;; a Markdown file, the link in the former will follow Org syntax while
-;; the backlink in the latter will use that of Markdown. Org links use
-;; `[[file:TARGET][DESCRIPTION]]', those of Markdown are
-;; `[DESCRIPTION](file:TARGET)', while for plain text we implement our
-;; own scheme of `<TYPE: TARGET> [DESCRIPTION]', where `TYPE' is either
-;; `LINK' or `BACKLINK' (capitalization in the latter two is literal,
-;; because plain text lacks other means of emphasis).
-;;
-;; Plain text links can benefit from Emacs' notion of "future history",
-;; else its ability to read the thing at point for relevant commands. With
-;; 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).
-;;
-;; The section with the backlinks is formatted according to the note's file
-;; type.
-;;
-;; 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.
-;;
-;; Backlinks that no longer point to available notes can be removed from
-;; the current buffer with the command `denote-link-clear-stale-backlinks'.
+;; The linking facility is subject to review and there will likely be
+;; breaking changes. This is the only area that needs to be fixed
+;; before we release the first stable version of the package.
;;; Code:
- [elpa] externals/denote 308322afab 108/355: Fix markdown-toml identifier value, (continued)
- [elpa] externals/denote 308322afab 108/355: Fix markdown-toml identifier value, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 11be1d6b40 123/355: Change "tml" to "toml" in denote-toml-front-matter, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 6000313eec 118/355: Enforce sluggification of keywords; document it, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 82eeb381dc 110/355: Make all front matter abstractions consistent, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 73dc07ac00 113/355: Make front matter variables "public", ELPA Syncer, 2022/06/27
- [elpa] externals/denote 21e415e2e7 111/355: Remove obsolete symbol of command, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 60d64ca07c 117/355: Document ways to change the front matter, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 28518416f3 131/355: Name the faces in the manual, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 0bda79ef19 139/355: Move heading further up in the manual, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 890a335092 149/355: Add denote-dired-rename-expert user option, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 5977a9bc7b 164/355: Add warning about likely changes to denote-link.el,
ELPA Syncer <=
- [elpa] externals/denote 3f768cc438 168/355: Remove commented-out 'require', ELPA Syncer, 2022/06/27
- [elpa] externals/denote d6285c8c5a 182/355: Omit current file from backlinks, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 02507c6f0d 171/355: Rename private variable, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 340f9103fd 175/355: Fix typo in manual, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 5c400d80d9 191/355: Document regexp example for file extension, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 8a33364dc6 188/355: Add helper fn to filter files matching regexp, ELPA Syncer, 2022/06/27
- [elpa] externals/denote f2cfcd26ea 205/355: Refine denote-retrieve regular expressions, ELPA Syncer, 2022/06/27
- [elpa] externals/denote d46c8fec55 239/355: Add "Contributing" section to the manual, ELPA Syncer, 2022/06/27
- [elpa] externals/denote bcbd52a784 200/355: Use format specifiers for denote-link-add-links, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 443c687f05 248/355: Update denote-dired--edit-front-matter-p docstring, ELPA Syncer, 2022/06/27