The trigger ( / ) menu

Roam command menuThe list below does not yet contain the delta function.

On the right-hand side, you see the so-called trigger menu in Roam. You open this menu by typing  / in any block in Roam, after which it will show commonly used functions.

Most people starting with Roam will use this menu as their primary tool, as it contains the most important functions in Roam. However, over time, you may want to know the shortcodes to do more complex things, or because you want to add them to a text expander extension. Regardless, it’s good to know the behavior of each function.

You can select functions from the menu by selecting them with your mouse, keyboard (arrow keys), or by typing the first part of the function’s name and hitting Return/Enter. In the table below, you’ll find the typed-out shortcode for each function (if there’s one, otherwise it only shows the value you need to enter for it to highlight in the menu).

 

 

Shortcode Description
{{[[TODO]]}}

Alternatively, use a keyboard shortcut:
Cmd-Return (macOS)
Ctrl-Return (Windows)

TODO. Turns the block into a todo, adding a clickable checkbox at the beginning of the block.
[[ ]] Page reference. Links to another page in the Roam database. If the page does not exist yet, linking will create it.

See the links and references article for more information.

(( )) Block reference. Shows the contents of another block, without duplicating its contents.

See the links and references article for more information.

{{[[ embed ]]: (( ))}}

Remove spaces around the word embed if you copy-paste from this page.

Block embed. Shows the contents of another block, without duplicating its content.

The difference between a block reference and a block embed is that you can directly edit an embedded block.

See the links and references article for more information.

[ ]([[ ]]) Alias. Creates an alias of an internal link, enabling you to give it a different label text.

See the Links and references section for more information.

/time Current time. Gives the current time in 24-hour notation, based on your computer’s time.
{{[[POMO]]}} Pomodoro timer. Starts a timer that ends at 25 minutes, then turns into
{{date}} Date picker. Gives you a calendar view to add a link to a date.

See the working with dates article for more information.

/today Today’s date. Shows today’s date and turns it into a link to that day’s page.
/tomorrow Tomorrow’s date. Shows tomorrow’s date and turns it into a link to that day’s page.
/yesterday Yesterday’s date. Shows yesterday’s date and turns it into a link to that day’s page.
** **

Alternatively, use a keyboard shortcut:
Cmd-b (macOS)
Ctrl-b (Windows)

Bold. Bolds all text between **
__ __

Alternatively, use a keyboard shortcut:
Cmd-i (macOS)
Ctrl-i (Windows)

Italics. Italicizes all text between the __ (double underscore).
^^ ^^

Alternatively, use a keyboard shortcut:
Cmd-h (macOS)
Cmd-Shift-h (macOS/Safari and Firefox)
Ctrl-h (Windows)

HighlightHighlights all text between the ˆˆ

You can’t highlight text that’s already formatted (like bolded or italicized). If you want to both bold and highlight some text, start out by highlighting.

~~ ~~

Alternatively, use a keyboard shortcut:
Cmd-y (macOS)

StrikethroughDraws a line through the text between ~~
` ` Inline code. Shows the text between the backticks (`) in monospace font, like in a code editor.
``` ``` Code block. Turns the block into a multi-line code editor that accepts Clojure, JavaScript, HTML, and CSS.

You can leave the space between the backticks (`) empty as you’ll fill this in via the editor.

$$ $$ LaTeX. Equations written in LaTeX between the $$ are turned into proper equations.
{{[[calc]]: (( ))}} Inline calculator. A calculator that works on the numbers found in the referenced blocks.* The calculator automatically looks for numbers in the referenced block, even if they also contain text.

When a block contains multiple numbers, they will be added as-is. For example, if you reference a block that contains a 1 and a 5, it will show as 15 (even if there were spaces or words between the 1 and 5).

* To get a block’s address, Right click on a block’s bullet, then click Copy block ref.

/upload Upload image or file. Opens a window to upload a file.

Supports images, PDFs, and audio files (MP3 and M4B)

{{[[slider]]}} Slider. Turns the block into a slider that goes from 0 to 10. Beneath the slider, the picture of the person giving that number shows (handy for in shared databases).

Roam slider

{{[[encrypt]]}} Encrypted text. Turns a block into an encrypted text field. Before you can encrypt data, you need to set a password and hint.
{{[[diagram]]}} Diagram. Turns the block into a diagramming canvas.

See the block visualization article for more information.

{{[[table]]}} Table. Turns the block into a table, using the nested blocks below as content.

See the block visualization article for more information.

{{[[kanban]]}} Kanban board.Turns the block into a kanban board, using the nested blocks below as content.

See the block visualization article for more information.

{{[video]: }} Embed video. Takes a YouTube, Loom, or Vimeo URL as input (after the colon :) and embeds it on the page.
{{[[mentions]]: [[ ]]}} Mentions of page or block. When you’re on a page, you see all the linked references to that page at the end. You can recreate the same behavior anywhere on pages and with any keyword by using the mentions shortcode.
{{word-count}} Word count. Shows a counter that adds up all words in the block and associated nested blocks.
{{[[query]]: {and: [[A]] [[B]]}}} Query (and). Queries let you search your entire Roam database for the mentions in your query.

When you use the and argument, Roam will return all blocks that mention A and B; when only one of them appear in a block, the and query will not return that block.

{{[[query]]: {or: [[A]] [[B]]}}} Query (or). Queries let you search your entire Roam database for the mentions in your query.

When you use the or argument, Roam will return all blocks that mention A or B; only one of the two have to appear in the block for the query to return it.

{{[[query]]: {and: [[A]] {or: [[B]] [[C]]}}
}}
Query (and or). Queries let you search your entire Roam database for the mentions in your query.

When you use the and argument and the or argument in conjunction, you can create complex queries. In this example, the query will return all blocks that mention A and that mention eitheror C. So, it will return blocks that mention A and B, A and C, A and B and C, but not blocks that only mention B and C.

{{[[query]]: {and: [[A]] {not: [[B]]]}}}} Query (and not). Queries let you search your entire Roam database for the mentions in your query.

When you use the and argument and the not argument in conjunction, the query will return all blocks that do mention A but don’t mention B. In other words: if a block contains A and B, the block will not be returned with this query.

 

Tags: , , , , ,

Was this helpful?