Autocomplete

Description

The Autocomplete feature enables you to insert references to Zotero items while you're writing in Roam. It is powered by the tributejs library.

To enable Autocomplete, add a trigger in your user settings - the trigger is a sequence of one or more characters which, when typed in a Roam block, will cause the autocomplete menu to be shown. A common trigger is @.

Besides the trigger, you may customize the following:

• how items are displayed in the autocomplete menu

• how items' references are inserted into the Roam block

Display as

// Citekey
@someCitekey
@anotherCitekey
...

// Zettlr
Author et al. (2019) Some Paper Title
A.N. Author (2018) Some study : a paper
...

Insert as

// Citation
[Author et al. (2019)]([[@someCitekey]])

// Citekey
@someCitekey

// Citekey (raw)
someCitekey

// Page reference
[[@someCitekey]]

// Popover
{{=: Author et al. (2019) | {{embed: [[@someCitekey]]}} }}

// Tag
#[[@someCitekey]]

Custom templates

For both settings, you can choose to use a custom template for rendering items.

Here are the replacements available:

• {{authors}} will insert shortened authorship information - Author et al.

• {{citekey}} will insert the citekey - @someCitekey

• {{key}} will insert the raw citekey - someCitekey

• {{summary}} will insert shortened publication information - Author et al. (2019)

• {{summary_or_key}} will insert the same contents as {{summary}}, or default to the item's key if information is missing

• {{title}}

• {{year}}