From 8f6d47f12fbfa52bd6316ba393dec5a7f54d3808 Mon Sep 17 00:00:00 2001 From: jethrokuan Date: Sun, 16 Jan 2022 21:30:47 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20=20@=2069742?= =?UTF-8?q?c3d5145f2cfbf126d28437274e7ae9fb555=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- manual.html | 35 +++++++++++++++++++++++++++++++++++ org-roam.org | 29 +++++++++++++++++++++++++++++ org-roam.texi | 31 +++++++++++++++++++++++++++++++ 3 files changed, 95 insertions(+) diff --git a/manual.html b/manual.html index 09d8b58..5638157 100644 --- a/manual.html +++ b/manual.html @@ -966,6 +966,39 @@ all headlines with the ATTACH tag from the Org-roam database, one c (not (member "ATTACH" (org-get-tags))))) +

Org-roam relied on the obtained Org AST for the buffer to parse links. However, +links appearing in some places (e.g. within property drawers) are not considered +by the Org AST to be links. Therefore, Org-roam takes special care of +additionally trying to process these links. Use +org-roam-db-extra-links-elements to specify which additional Org AST element +types to consider. +

+
+ +
+

The list of Org element types to include for parsing by Org-roam. +

+

By default, when parsing Org’s AST, links within keywords and +property drawers are not parsed as links. Sometimes however, it +is desirable to parse and cache these links (e.g. hiding links in +a property drawer). +

+ +

Additionally, one may want to ignore certain keys from being excluded within +property drawers. For example, we would not want ROAM_REFS links to be +self-referential. Hence, to exclude specific keys, we use +org-roam-db-extra-links-exclude-keys. +

+
+ +
+

Keys to ignore when mapping over links. +

+

The car of the association list is the Org element type (e.g. keyword). The +cdr is a list of case-insensitive strings to exclude from being treated as +links. +

+

@@ -2887,6 +2920,8 @@ Previous: , org-roam-completion-everywhere: Completing anywhere org-roam-dailies-capture-templates: Configuration org-roam-dailies-directory: Configuration +org-roam-db-extra-links-elements: What to cache +org-roam-db-extra-links-exclude-keys: What to cache org-roam-db-update-on-save: When to cache org-roam-graph-edge-extra-config: Graph Options org-roam-graph-executable: Graphing diff --git a/org-roam.org b/org-roam.org index 500fdae..53db2e2 100644 --- a/org-roam.org +++ b/org-roam.org @@ -490,6 +490,35 @@ all headlines with the ~ATTACH~ tag from the Org-roam database, one can set: (not (member "ATTACH" (org-get-tags))))) #+end_src +Org-roam relied on the obtained Org AST for the buffer to parse links. However, +links appearing in some places (e.g. within property drawers) are not considered +by the Org AST to be links. Therefore, Org-roam takes special care of +additionally trying to process these links. Use +~org-roam-db-extra-links-elements~ to specify which additional Org AST element +types to consider. + +- Variable: org-roam-db-extra-links-elements + + The list of Org element types to include for parsing by Org-roam. + + By default, when parsing Org's AST, links within keywords and + property drawers are not parsed as links. Sometimes however, it + is desirable to parse and cache these links (e.g. hiding links in + a property drawer). + +Additionally, one may want to ignore certain keys from being excluded within +property drawers. For example, we would not want ~ROAM_REFS~ links to be +self-referential. Hence, to exclude specific keys, we use +~org-roam-db-extra-links-exclude-keys~. + +- Variable: org-roam-db-extra-links-exclude-keys + + Keys to ignore when mapping over links. + + The car of the association list is the Org element type (e.g. keyword). The + cdr is a list of case-insensitive strings to exclude from being treated as + links. + ** When to cache By default, Org-roam is eager in caching: each time an Org-roam file is modified diff --git a/org-roam.texi b/org-roam.texi index 03f58fd..43914b7 100644 --- a/org-roam.texi +++ b/org-roam.texi @@ -791,6 +791,37 @@ all headlines with the @code{ATTACH} tag from the Org-roam database, one can set (not (member "ATTACH" (org-get-tags))))) @end example +Org-roam relied on the obtained Org AST for the buffer to parse links. However, +links appearing in some places (e.g. within property drawers) are not considered +by the Org AST to be links. Therefore, Org-roam takes special care of +additionally trying to process these links. Use +@code{org-roam-db-extra-links-elements} to specify which additional Org AST element +types to consider. + +@defvar org-roam-db-extra-links-elements + +The list of Org element types to include for parsing by Org-roam. + +By default, when parsing Org's AST, links within keywords and +property drawers are not parsed as links. Sometimes however, it +is desirable to parse and cache these links (e.g. hiding links in +a property drawer). +@end defvar + +Additionally, one may want to ignore certain keys from being excluded within +property drawers. For example, we would not want @code{ROAM_REFS} links to be +self-referential. Hence, to exclude specific keys, we use +@code{org-roam-db-extra-links-exclude-keys}. + +@defvar org-roam-db-extra-links-exclude-keys + +Keys to ignore when mapping over links. + +The car of the association list is the Org element type (e.g. keyword). The +cdr is a list of case-insensitive strings to exclude from being treated as +links. +@end defvar + @node When to cache @section When to cache