[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/denote 2e13b3451d 347/355: Update denote-link.el Commen
From: |
ELPA Syncer |
Subject: |
[elpa] externals/denote 2e13b3451d 347/355: Update denote-link.el Commentary section |
Date: |
Sun, 26 Jun 2022 23:58:38 -0400 (EDT) |
branch: externals/denote
commit 2e13b3451d8e1d814631635c2cdc2bd37e4c5896
Author: Protesilaos Stavrou <info@protesilaos.com>
Commit: Protesilaos Stavrou <info@protesilaos.com>
Update denote-link.el Commentary section
---
denote-link.el | 36 +++++++++++++++++++++++-------------
1 file changed, 23 insertions(+), 13 deletions(-)
diff --git a/denote-link.el b/denote-link.el
index 9eeb74f357..056f3c6b6b 100644
--- a/denote-link.el
+++ b/denote-link.el
@@ -35,11 +35,20 @@
;; it formats links like `[[denote:IDENTIFIER]]'. The user might prefer
;; its simplicity.
;;
+;; When the user option `denote-link-use-org-id' is set to non-nil (default
+;; is nil), inserted links in Org notes that target other Org notes will
+;; use the standard `id:' type so the format is `[[id:IDENTIFIER][TITLE]]'
+;; (the title is omitted is `denote-link' is called with a prefix argument,
+;; as explained above). When, however, an Org note links to a note in
+;; another file, the link with use our own `denote:' type as there is no
+;; standard for this case.
+;;
;; Inserted links are automatically buttonized and remain active for as
;; long as the buffer is available. In Org this is handled automatically
-;; as Denote creates its own custom hyperlink: the `denote:' type which
-;; works exactly like the `file:'. In Markdown and plain text, Denote
-;; handles the buttonization of those links.
+;; as Denote either uses the standard `id:' link type or creates its own
+;; custom hyperlink: the `denote:' type which works exactly like the
+;; `file:'. In Markdown and plain text, Denote handles the buttonization
+;; of those links.
;;
;; To buttonize links in existing files while visiting them, the user must
;; add this snippet to their setup:
@@ -52,8 +61,8 @@
;; The `denote-link-find-file' is such a command. It uses minibuffer
;; completion to visit a file that is linked to from the current note.
;; The candidates have the correct metadata, which is ideal for
-;; integration with other standards-compliant tools (see "Extending
-;; Denote" in the manual). For instance, a package such as `marginalia'
+;; integration with other standards-compliant tools (see the manual's
+;; "Extending Denote"). For instance, a package such as `marginalia'
;; will display accurate annotations, while the `embark' package will be
;; able to work its magic such as in exporting the list into a filtered
;; Dired buffer (i.e. a familiar Dired listing with only the files of
@@ -62,10 +71,8 @@
;; The command `denote-link-backlinks' produces a bespoke buffer which
;; displays the file name of all notes linking to the current one. Each
;; file name appears on its own line and is buttonized so that it performs
-;; the action of visiting the referenced file. [Development note:
-;; currently this depends on the `find' executable. Maybe we can make it
-;; work with Emacs' `xref' facility to work everywhere without losing the
-;; bespoke buffer?] The backlinks' buffer looks like this:
+;; the action of visiting the referenced file. The backlinks' buffer looks
+;; like this:
;;
;; Backlinks to "On being honest" (20220614T130812)
;; ------------------------------------------------
@@ -106,11 +113,14 @@
;; pointless).
;;
;; When called with a prefix argument (`C-u') `denote-link-add-links' will
-;; format all links as `[[denote:IDENTIFIER]]', hence a typographic list:
+;; format all links as `[[TYPE:IDENTIFIER]]', hence a typographic list:
+;;
+;; - [[TYPE:IDENTIFIER-1]]
+;; - [[TYPE:IDENTIFIER-2]]
+;; - [[TYPE:IDENTIFIER-3]]
;;
-;; - [[denote:IDENTIFIER-1]]
-;; - [[denote:IDENTIFIER-2]]
-;; - [[denote:IDENTIFIER-3]]
+;; The `TYPE' is either `denote:' or `id:', exactly as we explained above
+;; for the `denote-link' command.
;;
;; Same examples of a regular expression that can be used with this
;; command:
- [elpa] externals/denote 3d606cbe95 272/355: Simplify completion via 'org-insert-link', (continued)
- [elpa] externals/denote 3d606cbe95 272/355: Simplify completion via 'org-insert-link', ELPA Syncer, 2022/06/27
- [elpa] externals/denote f21a99775d 256/355: Improve rename prompt; only rename regular files, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 941258d8d4 263/355: Remove faulty MUSTMATCH from file prompt, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 8eb27246a5 267/355: Refine buffer-local 'denote-directory'; update doc, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 385c7e9689 287/355: Clarify use of uspecified face attribute, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 90875d5419 233/355: Sort backlinks from oldest to newest, ELPA Syncer, 2022/06/27
- [elpa] externals/denote efd9d537cd 278/355: Give appropriate name to backlink button object, ELPA Syncer, 2022/06/27
- [elpa] externals/denote a062d9a351 294/355: Update link-related docs (cover buttonization), ELPA Syncer, 2022/06/27
- [elpa] externals/denote 750f8bf95c 307/355: Add FAQ about handling "last modified" scenario, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 627250dc0b 306/355: Make minor rewordings or clarifications to FAW, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 2e13b3451d 347/355: Update denote-link.el Commentary section,
ELPA Syncer <=
- [elpa] externals/denote 2d3a6fd8f3 327/355: Reword comment about multi-line button recognition, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 80eb7528aa 335/355: doc: Update documentation, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 0fac78ada3 338/355: Refine how link format for target is done, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 1f5077181a 326/355: Remove completed to-do about Embark, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 8182604ff3 343/355: Increase max-mini height for rename prompt, ELPA Syncer, 2022/06/27
- [elpa] externals/denote b14b5e201e 339/355: Make denote-link-add-links use id: when necessary, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 4f85d0ece8 355/355: Rephrase description about zk.el alternative, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 84ff0fb674 352/355: Fix alignment in sample front matter, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 1be0255183 340/355: Reword some statements in the manual, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 5c13cf4c1c 354/355: Rename internal id front matter rx for consistency, ELPA Syncer, 2022/06/27