Skip to content

Mentions ​

Mentions are links to components and boards within your Arcweave project.

Example of mentioning a component by typing the @ character followed by a few letters of the component's name. A list opens, from which the user can choose an existing component or create a new one.

You can insert mentions while typing in the following fields:

In the board, component mentions appear as orange text and board mentions as gold text.

ℹ️ Inside Arcscript segments and branch conditions, typing @ lists elements instead, so you can use them as arguments of the visits function.

ℹ️ Mentions are not visually styled in Play Mode; they appear as regular text.

⚠️ Not to be confused with user mentions in comments.

Benefits of mentions ​

Mentions offer several advantages that improve project navigation and consistency:

  • Quick navigation: Clicking on a mention instantly opens the referenced component or board.
  • Auto-updating: If the referenced item is renamed, all related mentions are automatically updated.
  • Distraction-free writing: You can create and reference new components on the fly without breaking your writing flow.

Create a mention ​

To mention an existing component or board:

  1. While typing, type the @ character.
  2. Start typing the name of the component or board.
  3. Click the correct item in the dropdown list, or move to it with the arrow keys and press Enter.

ℹ️ The @ character opens the list only at the start of a paragraph or after a space or an opening parenthesis (.

⚠️ The Create "..." option is highlighted first in the list. Pressing Enter without moving to another item creates a new component, even if an existing component matches your text.

Animated GIF demonstrating how to mention an existing component.

Create new components ​

Mentions also allow you to create new components as you write.

To create one, type @ followed by the desired name and press Enter. Arcweave will automatically create and mention the new component without interrupting your writing flow.

⚠️ This method creates only components; not boards.

ℹ️ To include spaces in the name, use underscores (_). For example, typing @bronze_key will create a component named bronze key.