mirror of
https://github.com/org-roam/org-roam
synced 2025-08-23 14:03:32 -05:00
Deploying to gh-pages from @ b47b76aa41
🚀
This commit is contained in:
34
org-roam.org
34
org-roam.org
@@ -174,17 +174,43 @@ Org-mode. However, to support additional functionality, Org-roam adds
|
|||||||
several Org-roam-specific keywords. These functionality are not crucial
|
several Org-roam-specific keywords. These functionality are not crucial
|
||||||
to effective use of Org-roam.
|
to effective use of Org-roam.
|
||||||
|
|
||||||
** File Aliases
|
** File Titles
|
||||||
|
|
||||||
Suppose you want a note to be referred to by different names (e.g.
|
To easily find a note, a title needs to be prescribed to a note. A note can have
|
||||||
"World War 2", "WWII"). You may specify such aliases using the
|
many titles: this allows a note to be referred to by different names, which is
|
||||||
=#+ROAM_ALIAS= attribute:
|
especially useful for topics or concepts with acronyms. For example, for a note
|
||||||
|
like "World War 2", it may be desirable to also refer to it using the acronym
|
||||||
|
"WWII".
|
||||||
|
|
||||||
|
Org-roam calls =org-roam--extract-titles= to extract titles. It uses the
|
||||||
|
variable =org-roam-title-sources=, to control how the titles are extracted. The
|
||||||
|
title extraction methods supported are:
|
||||||
|
|
||||||
|
1. ='title=: This extracts the title using the file =#+TITLE= property
|
||||||
|
2. ='headline=: This extracts the title from the first headline in the Org file
|
||||||
|
3. ='alias=: This extracts a list of titles using the =#ROAM_ALIAS= property.
|
||||||
|
The aliases are space-delimited, and can be multi-worded using quotes
|
||||||
|
|
||||||
|
Take for example the following org file:
|
||||||
|
|
||||||
#+BEGIN_SRC org
|
#+BEGIN_SRC org
|
||||||
#+TITLE: World War 2
|
#+TITLE: World War 2
|
||||||
#+ROAM_ALIAS: "WWII" "World War II"
|
#+ROAM_ALIAS: "WWII" "World War II"
|
||||||
|
|
||||||
|
* Headline
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
|
| Method | Titles |
|
||||||
|
|-------------+--------------------------|
|
||||||
|
| ='title= | '("World War 2") |
|
||||||
|
| ='headline= | '("Headline") |
|
||||||
|
| ='alias= | '("WWII" "World War II") |
|
||||||
|
|
||||||
|
One can freely control which extraction methods to use by customizing
|
||||||
|
=org-roam-title-sources=: see the doc-string for the variable for more
|
||||||
|
information. If all methods of title extraction return no results, the file-name
|
||||||
|
is used in place of the titles for completions.
|
||||||
|
|
||||||
** File Refs
|
** File Refs
|
||||||
|
|
||||||
Refs are unique identifiers for files. Each note can only have 1 ref.
|
Refs are unique identifiers for files. Each note can only have 1 ref.
|
||||||
|
Reference in New Issue
Block a user