mirror of
https://github.com/org-roam/org-roam
synced 2025-08-29 14:33:29 -05:00
Deploying to gh-pages from @ 48ef3fee11 🚀
This commit is contained in:
jethrokuan
77
manual.html
77
manual.html
@@ -171,6 +171,12 @@ Anatomy of an Org-roam File
|
||||
</td></tr>
|
||||
<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
|
||||
|
||||
Titles
|
||||
|
||||
</pre></th></tr><tr><td align="left" valign="top">• <a href="#Customizing-Title-Extraction">Customizing Title Extraction</a>:</td><td> </td><td align="left" valign="top">
|
||||
</td></tr>
|
||||
<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
|
||||
|
||||
The Templating System
|
||||
|
||||
</pre></th></tr><tr><td align="left" valign="top">• <a href="#Template-Walkthrough">Template Walkthrough</a>:</td><td> </td><td align="left" valign="top">
|
||||
@@ -815,15 +821,69 @@ The aliases are space-delimited, and can be multi-worded using quotes.
|
||||
<tr><td><code>'alias</code></td><td>’(“WWII” “World War II”)</td></tr>
|
||||
</table>
|
||||
|
||||
<p>One can freely control which extraction methods to use by customizing
|
||||
<code>org-roam-title-sources</code>: 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.
|
||||
<table class="menu" border="0" cellspacing="0">
|
||||
<tr><td align="left" valign="top">• <a href="#Customizing-Title-Extraction" accesskey="1">Customizing Title Extraction</a>:</td><td> </td><td align="left" valign="top">
|
||||
</td></tr>
|
||||
</table>
|
||||
|
||||
<hr>
|
||||
<a name="Customizing-Title-Extraction"></a>
|
||||
<div class="header">
|
||||
<p>
|
||||
Up: <a href="#Titles" accesskey="u" rel="up">Titles</a> [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
|
||||
</div>
|
||||
<a name="Customizing-Title-Extraction-1"></a>
|
||||
<h4 class="subsection">6.1.1 Customizing Title Extraction</h4>
|
||||
|
||||
<p>To control how Org-roam extracts titles, customize <code>org-roam-title-sources</code>. If
|
||||
all methods of title extraction return no results, the file-name is used as the
|
||||
note’s title.
|
||||
</p>
|
||||
<p>If you wish to add your own title extraction method, you may push a symbol
|
||||
<code>'foo</code> into <code>org-roam-title-sources</code>, and define a
|
||||
<code>org-roam--extract-titles-foo</code> which accepts no arguments. See
|
||||
<code>org-roam--extract-titles-title</code> for an example.
|
||||
<dl>
|
||||
<dt><a name="index-org_002droam_002dtitle_002dsources"></a>User Option: <strong>org-roam-title-sources</strong></dt>
|
||||
<dd>
|
||||
<p>The list of sources from which to retrieve a note title.
|
||||
Each element in the list is either:
|
||||
</p></dd></dl>
|
||||
|
||||
<ul>
|
||||
<li> a symbol – this symbol corresponds to a title retrieval function, which
|
||||
returns the list of titles for the current buffer
|
||||
<ul>
|
||||
<li> a list of symbols – symbols in the list are treated as with (1). The
|
||||
return value of this list is the first symbol in the list returning a
|
||||
non-nil value.
|
||||
</li></ul>
|
||||
|
||||
<p>The return results of the root list are concatenated.
|
||||
</p>
|
||||
<p>For example the setting: ’((title headline) alias) means the following:
|
||||
</p>
|
||||
<ul>
|
||||
<li> Return the ’title + ’alias, if the title of current buffer is non-empty;
|
||||
|
||||
</li><li> Or return ’headline + ’alias otherwise.
|
||||
</li></ul>
|
||||
|
||||
<p>The currently supported symbols are:
|
||||
</p>
|
||||
<p>‘title’
|
||||
The \“#+title\” property of org file.
|
||||
</p>
|
||||
<p>‘alias’
|
||||
The \“#+roam<em>_alias</em>\” property of the org file, using
|
||||
space-delimited strings.
|
||||
</p>
|
||||
<p>‘headline’
|
||||
The first headline in the org file.
|
||||
</p></li></ul>
|
||||
|
||||
<p>Adding your own title extraction method requires two steps. First, define a
|
||||
method <code>(defun org-roam--extract-titles-foo () ...)</code>, where <code>foo</code> a
|
||||
self-prescribed name for the title extraction method. This method takes no
|
||||
arguments, and returns a list of strings (titles). Finally, push the symbol
|
||||
<code>foo</code> into <code>org-roam-title-sources</code>. You may need to rebuild the cache from
|
||||
scratch to re-process all files to pick up the new titles.
|
||||
</p>
|
||||
<hr>
|
||||
<a name="Tags"></a>
|
||||
@@ -2557,6 +2617,7 @@ Previous: <a href="#Function-Index" accesskey="p" rel="prev">Function Index</a>,
|
||||
<tr><td></td><td valign="top"><a href="#index-org_002droam_002dlink_002dauto_002dreplace"><code>org-roam-link-auto-replace</code></a>:</td><td> </td><td valign="top"><a href="#Inserting-Links">Inserting Links</a></td></tr>
|
||||
<tr><td></td><td valign="top"><a href="#index-org_002droam_002dlink_002dtitle_002dformat"><code>org-roam-link-title-format</code></a>:</td><td> </td><td valign="top"><a href="#Inserting-Links">Inserting Links</a></td></tr>
|
||||
<tr><td></td><td valign="top"><a href="#index-org_002droam_002dlink_002duse_002dcustom_002dfaces"><code>org-roam-link-use-custom-faces</code></a>:</td><td> </td><td valign="top"><a href="#Org_002droam-Faces">Org-roam Faces</a></td></tr>
|
||||
<tr><td></td><td valign="top"><a href="#index-org_002droam_002dtitle_002dsources"><code>org-roam-title-sources</code></a>:</td><td> </td><td valign="top"><a href="#Customizing-Title-Extraction">Customizing Title Extraction</a></td></tr>
|
||||
<tr><td colspan="4"> <hr></td></tr>
|
||||
</table>
|
||||
<table><tr><th valign="top">Jump to: </th><td><a class="summary-letter" href="#Variable-Index_vr_letter-O"><b>O</b></a>
|
||||
|
||||
49
org-roam.org
49
org-roam.org
@@ -417,15 +417,48 @@ Take for example the following org file:
|
||||
| ~'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.
|
||||
*** Customizing Title Extraction
|
||||
|
||||
If you wish to add your own title extraction method, you may push a symbol
|
||||
~'foo~ into ~org-roam-title-sources~, and define a
|
||||
~org-roam--extract-titles-foo~ which accepts no arguments. See
|
||||
~org-roam--extract-titles-title~ for an example.
|
||||
To control how Org-roam extracts titles, customize ~org-roam-title-sources~. If
|
||||
all methods of title extraction return no results, the file-name is used as the
|
||||
note's title.
|
||||
|
||||
- User Option: org-roam-title-sources
|
||||
|
||||
The list of sources from which to retrieve a note title.
|
||||
Each element in the list is either:
|
||||
|
||||
1. a symbol -- this symbol corresponds to a title retrieval function, which
|
||||
returns the list of titles for the current buffer
|
||||
2. a list of symbols -- symbols in the list are treated as with (1). The
|
||||
return value of this list is the first symbol in the list returning a
|
||||
non-nil value.
|
||||
|
||||
The return results of the root list are concatenated.
|
||||
|
||||
For example the setting: '((title headline) alias) means the following:
|
||||
|
||||
1. Return the 'title + 'alias, if the title of current buffer is non-empty;
|
||||
2. Or return 'headline + 'alias otherwise.
|
||||
|
||||
The currently supported symbols are:
|
||||
|
||||
`title'
|
||||
The \"#+title\" property of org file.
|
||||
|
||||
`alias'
|
||||
The \"#+roam_alias\" property of the org file, using
|
||||
space-delimited strings.
|
||||
|
||||
`headline'
|
||||
The first headline in the org file.
|
||||
|
||||
Adding your own title extraction method requires two steps. First, define a
|
||||
method ~(defun org-roam--extract-titles-foo () ...)~, where ~foo~ a
|
||||
self-prescribed name for the title extraction method. This method takes no
|
||||
arguments, and returns a list of strings (titles). Finally, push the symbol
|
||||
~foo~ into ~org-roam-title-sources~. You may need to rebuild the cache from
|
||||
scratch to re-process all files to pick up the new titles.
|
||||
|
||||
** Tags
|
||||
|
||||
|
||||
@@ -108,6 +108,10 @@ Anatomy of an Org-roam File
|
||||
* Tags::
|
||||
* File Refs::
|
||||
|
||||
Titles
|
||||
|
||||
* Customizing Title Extraction::
|
||||
|
||||
The Templating System
|
||||
|
||||
* Template Walkthrough::
|
||||
@@ -645,15 +649,65 @@ Take for example the following org file:
|
||||
@tab '(``WWII'' ``World War II'')
|
||||
@end multitable
|
||||
|
||||
One can freely control which extraction methods to use by customizing
|
||||
@code{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.
|
||||
@menu
|
||||
* Customizing Title Extraction::
|
||||
@end menu
|
||||
|
||||
If you wish to add your own title extraction method, you may push a symbol
|
||||
@code{'foo} into @code{org-roam-title-sources}, and define a
|
||||
@code{org-roam--extract-titles-foo} which accepts no arguments. See
|
||||
@code{org-roam--extract-titles-title} for an example.
|
||||
@node Customizing Title Extraction
|
||||
@subsection Customizing Title Extraction
|
||||
|
||||
To control how Org-roam extracts titles, customize @code{org-roam-title-sources}. If
|
||||
all methods of title extraction return no results, the file-name is used as the
|
||||
note's title.
|
||||
|
||||
@defopt org-roam-title-sources
|
||||
|
||||
The list of sources from which to retrieve a note title.
|
||||
Each element in the list is either:
|
||||
@end defopt
|
||||
|
||||
@itemize
|
||||
@item
|
||||
a symbol -- this symbol corresponds to a title retrieval function, which
|
||||
returns the list of titles for the current buffer
|
||||
@itemize
|
||||
@item
|
||||
a list of symbols -- symbols in the list are treated as with (1). The
|
||||
return value of this list is the first symbol in the list returning a
|
||||
non-nil value.
|
||||
@end itemize
|
||||
|
||||
The return results of the root list are concatenated.
|
||||
|
||||
For example the setting: '((title headline) alias) means the following:
|
||||
|
||||
@itemize
|
||||
@item
|
||||
Return the 'title + 'alias, if the title of current buffer is non-empty;
|
||||
|
||||
@item
|
||||
Or return 'headline + 'alias otherwise.
|
||||
@end itemize
|
||||
|
||||
The currently supported symbols are:
|
||||
|
||||
`title'
|
||||
The \``#+title\'' property of org file.
|
||||
|
||||
`alias'
|
||||
The \``#+roam@math{_alias}\'' property of the org file, using
|
||||
space-delimited strings.
|
||||
|
||||
`headline'
|
||||
The first headline in the org file.
|
||||
@end itemize
|
||||
|
||||
Adding your own title extraction method requires two steps. First, define a
|
||||
method @code{(defun org-roam--extract-titles-foo () ...)}, where @code{foo} a
|
||||
self-prescribed name for the title extraction method. This method takes no
|
||||
arguments, and returns a list of strings (titles). Finally, push the symbol
|
||||
@code{foo} into @code{org-roam-title-sources}. You may need to rebuild the cache from
|
||||
scratch to re-process all files to pick up the new titles.
|
||||
|
||||
@node Tags
|
||||
@section Tags
|
||||
|
||||
Reference in New Issue
Block a user