awesome-emacs/org-roam
1
0
Fork 0
mirror of https://github.com/org-roam/org-roam synced 2025-08-03 12:27:23 -05:00
Code Issues Packages Projects Releases Wiki Activity

(chore): update org-roam-graph variable names (#383)

Browse Source 
See: https://github.com/jethrokuan/org-roam/issues/382
This commit is contained in:
N V
2020-03-31 04:56:15 -04:00
committed by GitHub
parent 04acbda916
commit b06e296e88
2 changed files with 12 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
doc/configuration.md
View File

@ -98,14 +98,14 @@ Org-roam tries its best to locate the Graphviz executable from your
`PATH`, but if it fails to do so, you may set it manually: `PATH`, but if it fails to do so, you may set it manually:
``` ```
(setq org-roam-graphviz-executable "/path/to/dot") (setq org-roam-graph-executable "/path/to/dot")
``` ```
You may also choose to use `neato` in place of `dot`, which generates a more compact graph layout. You may also choose to use `neato` in place of `dot`, which generates a more compact graph layout.
``` ```
(setq org-roam-graphviz-executable "/path/to/neato") (setq org-roam-graph-executable "/path/to/neato")
(setq org-roam-graphviz-extra-options '(("overlap" . "false"))) (setq org-roam-graph-extra-config '(("overlap" . "false")))
``` ```
Org-roam also attempts to use Firefox (located on `PATH`) to view the Org-roam also attempts to use Firefox (located on `PATH`) to view the

14
org-roam-graph.el
View File

@ -47,12 +47,16 @@
:group 'org-roam) :group 'org-roam)
(defcustom org-roam-graph-executable (executable-find "dot") (defcustom org-roam-graph-executable (executable-find "dot")
"Path to grapher executable." "Path to graphing executable."
:type 'string :type 'string
:group 'org-roam) :group 'org-roam)
(defcustom org-roam-grapher-extra-options nil (defvaralias 'org-roam-graphviz-extra-options 'org-roam-graph-extra-config)
"Extra options when constructing the grapher graph. (defvaralias 'org-roam-grapher-extra-options 'org-roam-graph-extra-config)
(make-obsolete-variable 'org-roam-graphviz-extra-options 'org-roam-graph-extra-config "2020/03/31")
(make-obsolete-variable 'org-roam-grapher-extra-options 'org-roam-graph-extra-config "2020/03/31")
(defcustom org-roam-graph-extra-config nil
"Extra options passed to the graphing executable.
Example: Example:
'((\"rankdir\" . \"LR\"))" '((\"rankdir\" . \"LR\"))"
:type '(alist) :type '(alist)
@ -111,7 +115,7 @@ set WHERE to true if WHERE query already exists."
(nreverse res))) (nreverse res)))
(defun org-roam-graph--build () (defun org-roam-graph--build ()
"Build the grapher string. "Build the graph output string.
The Org-roam database titles table is read, to obtain the list of titles. The Org-roam database titles table is read, to obtain the list of titles.
The file-links table is then read to obtain all directed links, and formatted The file-links table is then read to obtain all directed links, and formatted
into a digraph." into a digraph."
@ -127,7 +131,7 @@ into a digraph."
,@(org-roam-graph--expand-matcher 'file-from t t)]) ,@(org-roam-graph--expand-matcher 'file-from t t)])
(edges (org-roam-db-query edges-query))) (edges (org-roam-db-query edges-query)))
(insert "digraph \"org-roam\" {\n") (insert "digraph \"org-roam\" {\n")
(dolist (option org-roam-grapher-extra-options) (dolist (option org-roam-graph-extra-config)
(insert (concat (car option) (insert (concat (car option)
"=" "="
(cdr option) (cdr option)