Commit Graph

174 Commits

Author SHA1 Message Date
Jethro Kuan
dd7c3fab23 Merge branch 'master' into v2
* master:
  (doc): Add file-truename to set org-roam-directory (README and documentation) (#1487)
2021-04-28 13:45:23 +08:00
Noboru Ota
15c1a46e41 (doc): Add file-truename to set org-roam-directory (README and documentation) (#1487)
* (doc): Add file-truename to set org-roam-directory

Refer this debuging Slack exchange:
https://orgroam.slack.com/archives/CV160S8EL/p1619089118195300

Not using `file-truename` to set
`org-roam-directory` can lead to an issue that is
hard to identify.

It appears that cache database may updates with
files but `org-roam-buffer` fails to find the file
as symbolic links do not resolve. This is
confusing as the table query to the table seems to
return what appears to be correct entries, but the
backlink fails to insert context around the
link (as Org-roam fails to find the file).

There have been similiar issues -- by making sure
`file-truename` is added in the documentation and
README, it is hoped to eliminate such issues to
recur.

This is probably relevant for V2.

* undo changes to texi

Co-authored-by: Jethro Kuan <jethrokuan95@gmail.com>
2021-04-28 13:43:42 +08:00
Jethro Kuan
4e0b3fb564 update docs 2021-04-27 23:16:27 +08:00
Jethro Kuan
fd23360100 Add back ROAM_TAGS to top-level nodes 2021-04-27 13:04:24 +08:00
Jethro Kuan
c866275086 move things around 2021-04-23 18:00:41 +08:00
Jethro Kuan
3c6e1b5194 add interactive functions
Added org-roam-{alias,ref}-{add,remove}. Fixed org-roam-protocol. Added
some docs.
2021-04-21 02:09:50 +08:00
Jethro Kuan
6b98f4b836 add some docs 2021-04-17 22:02:35 +08:00
Jethro Kuan
3a2df140cb update conversion to accept template overrides
rename org-roam-capture--capture to org-roam-capture-
2021-04-11 15:05:22 +08:00
Jethro Kuan
de6477be17 Merge branch 'master' into v2 2021-04-11 14:56:34 +08:00
Jethro Kuan
997ddcbf4b (docs): update org-roam dir-locals
use absolute path instead of relative path to prevent errors
2021-04-11 14:50:11 +08:00
Jethro Kuan
e19c3d6273 update docs 2021-03-24 23:56:59 +08:00
Jethro Kuan
9b0a45f105 add some documentation 2021-03-19 11:20:19 +08:00
Jethro Kuan
fb76f81423 (docs) fix and add to link completion doc (ref #1413) 2021-03-19 11:20:19 +08:00
Jethro Kuan
121e969553 (docs) add details on executable-find (ref #1444) 2021-03-19 11:20:19 +08:00
Jethro Kuan
0c0d677631 fix typo (ref #1441) 2021-03-19 11:20:19 +08:00
Jethro Kuan
dc0357b12e fix grammar issue in documentation (ref #1432) 2021-03-19 11:20:18 +08:00
Jethro Kuan
cbeaa4d92e add link to anki-editor (ref #1419)
Co-authored-by: Arthur Leonard Andersen
2021-03-19 11:20:18 +08:00
Jethro Kuan
53dcf687ef org-roam v2 2021-03-19 11:20:18 +08:00
Paul Gowder
2a1c73c0a3 (docs): clarify behavior of capture functions (#1393) 2021-01-20 21:55:17 +08:00
Jethro Kuan
16c7a7bd93 (doc): update mac protocol instructions (#1390)
use native script editor, rather than Platypus.
2021-01-18 23:02:53 +08:00
Thomas Sojka
05deb64d85 (doc) Update brew install script (#1386)
The API for Homebrew Cask changed (https://brew.sh/)
2021-01-16 16:58:13 +08:00
Noboru Ota
ecf515f650 (doc): Add footnote for tab completion (#1348)
Follow on to #1345.

The discussion in the Slack thread further clarified what was exactly
confusing for a beginner reader of this Getting Started. When a user is using
the built-in completion (no ivy, no ido), then `org-roam-find-file` does not
immediately show any files -- instead, the user has to press TAB. This is not
explicitly mentioned.
2020-12-19 16:42:43 +08:00
Noboru Ota
4d63f99fe8 (doc): Add async update to Getting Started (#1345) 2020-12-16 20:58:13 +08:00
Win Treese
8aa793b021 (docs): org-roam-doctor: fix docs for prefix arg (#1337) 2020-12-12 14:34:04 +08:00
asymmetric
be95b42d32 (docs): fix link to org-capture (#1329)
Required capitalization.
2020-12-01 12:42:33 +08:00
Jethro Kuan
face683e00 (internal): remove org-roam--get-title-or-slug function (#1284)
Every file has a title when saved into the database, so this function is
redundant in most cases (e.g. in org-roam-buffer, where backlinks are
fetched from the database).
2020-11-15 19:44:36 +08:00
Jethro Kuan
baf0dd9d00 (doc): document tag completions (#1282) 2020-11-15 14:36:49 +08:00
Jethro Kuan
6502874576 (doc): document completion-at-point (#1279) 2020-11-15 04:43:57 +08:00
Jethro Kuan
8401784cd2 (doc): document org-roam-tag-sources (#1274) 2020-11-14 21:12:08 +08:00
Jethro Kuan
6dc316c450 (doc): fix menu-comment styling (#1273) 2020-11-14 14:17:08 +08:00
Jethro Kuan
48ef3fee11 (doc): document org-roam-title-sources (#1271) 2020-11-13 22:55:52 +08:00
Alan Schmitt
16c520068b (doc): Fix typo (#1272)
The `olp` option in the lab notes example was swapped.
2020-11-13 14:22:58 +01:00
Jethro Kuan
b1608bf869 (feat): capture: create OLP if does not exist (#1270)
Remove the requirement that the OLP already exists in the captured file.
Also, make OLP available beyond dailies functionality.
2020-11-13 16:29:00 +08:00
Jethro Kuan
cc01cf346e (release): v1.2.3 (#1269) 2020-11-13 14:22:18 +08:00
Jethro Kuan
eaf99cba03 (doc): minor changes (#1268) 2020-11-13 13:17:28 +08:00
Jethro Kuan
bc12d1cf04 (feat): add org-roam-db-update-method (#1264)
* (feat): add `org-roam-db-update-method`

Add `org-roam-db-update-method`, which can be one of two choices:

1. `immediate`: the cache is updated upon file changes
2. `idle-timer`: Marks the org-roam database as dirty. If Emacs idles
for some seconds, the Org-roam cache is updated. This is the default,
and current behaviour.

The idle method makes for a smoother editing experience, but some
inconsistencies can be faced.

* org-roam-update-db-idle-seconds -> org-roam-db-update-idle-seconds
2020-11-12 19:48:40 +08:00
Jethro Kuan
d4c875b53b (doc): doc stylistic changes (#1262)
- style tables properly
- reduce pre font-size
2020-11-12 15:40:27 +08:00
Leo Vivier
2159b6a846 (web): Remove mention to company-org-roam on index.html (#1261) 2020-11-12 08:27:22 +01:00
Jethro Kuan
1db4c22950 (doc): remove top-level TOC (#1260) 2020-11-12 15:13:59 +08:00
Jethro Kuan
9c0f030ffd (doc): add indexes (#1259)
Add keystroke, command, function and variable indexes
2020-11-12 14:56:48 +08:00
Leo Vivier
983d7a8798 (doc): Link org-journal to section on daily-notes (#1258) 2020-11-12 07:47:44 +01:00
Jethro Kuan
910b37268e (doc): make manual single-page (#1257)
This should make things easier to browse/search for. Also simplify styling.
2020-11-12 14:32:59 +08:00
Kisaragi Hiu
167553b8ee (doc): various improvements (#1253)
- options: explicitly enable smart quotes on export
- zettelkasten introduction: add sections for fleeting notes and
  permanent notes for easier access and reference
- anatomy: add a missing period
- encryption: clarify org-roam-encrypt-files is a user option
- roam protocol: remove extraneous heading
- roam protocol: small grammar fix
- doctor: explain what the doctor does by default
- org-roam-bibtex: explain part of what orb actually does
2020-11-11 18:04:09 +08:00
Kisaragi Hiu
76affe177a (doc): reflect that we now allow multiple refs (#1251) 2020-11-11 15:42:45 +08:00
Jethro Kuan
aef71f1623 (docs): use ox-texinfo+ (#1250)
This generates texi documents with understanding of variables and
functions.
2020-11-11 13:00:49 +08:00
Leo Vivier
4f6eb285bf (feat): Overhaul org-roam-dailies (#978)
Implement ideas from `org-journal` to `org-roam-dailies`.

Update the doc.
2020-11-10 14:31:38 +01:00
Jethro Kuan
4d423a916e (doc): add note on unlinked references and encrypted files (#1236) 2020-11-05 16:34:11 +08:00
Jethro Kuan
5d483f2d4d (fix): fall back to org-id search ID face computation (#1195)
* (fix): fall back to org-id search ID face computation

Fixes the scenario where the face is reported as invalid although it is
part of Org's ID files (e.g. in the agenda).

Fixes #1191.

This can however slow face computation a lot (when there are many org
id/agenda files). Here, we choose to focus on correctness.

* Document faces, default to only applying to Org-roam notes
2020-10-19 13:47:07 +08:00
Jethro Kuan
cbf1b585ac (doc): fix org-roam-buffer-window-parameters documentation (#1190)
Closes #1188
2020-10-16 00:23:47 +08:00
Jethro Kuan
02fda3adb1 (docs): document org-roam-buffer-window-parameters (#1180)
also remove documentation on deprecated variable ~org-roam-buffer-no-delete-other-windows~
2020-10-10 22:28:29 +08:00