Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file removed docs/public/img/choices/capture-builder.png
Binary file not shown.
Binary file removed docs/public/img/choices/macro-builder.png
Binary file not shown.
Binary file removed docs/public/img/choices/multi-choice.png
Binary file not shown.
Binary file removed docs/public/img/choices/template-builder.png
Binary file not shown.
Binary file removed docs/public/img/examples/capture-add-task.png
Binary file not shown.
Binary file removed docs/public/img/issue-1642-after.png
Binary file not shown.
Binary file removed docs/public/img/issue-1642-before.png
Binary file not shown.
15 changes: 10 additions & 5 deletions docs/src/content/docs/docs/AIAssistant.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,14 @@ online features** is turned off in QuickAdd settings.

## Setup {#setup}

1. Create a folder for AI prompt templates, for example `bins/ai_prompts`.
2. Open QuickAdd settings.
1. Create a folder for AI prompt templates, for example `AI prompts`.
2. Open QuickAdd settings and turn off **Disable AI & online features** (under **AI & online**).
3. In the choice list, click the **Configure AI Assistant** icon button. It uses the sparkles icon at the bottom of the list.
4. Set **Prompt template folder path** to the folder you created.
5. Click **Edit providers** and configure at least one provider and model.
5. Click **Edit providers** and configure at least one provider. OpenAI and Gemini are already listed: click **Edit**, link an API key secret with **Link...**, click **Sync now** to pull the provider's current models, and **Save**. See [Connect a provider](#providers-and-local-models) for other providers.
6. Choose a **Default model**, or leave it as **Ask me** to pick a model each run.

![AI Assistant Setup](./Images/AI_Assistant_Setup.gif)
![Setting up the AI Assistant: enabling AI features, setting the prompt template folder, linking an OpenAI API key, syncing models, and choosing gpt-6-luna as the default model](./Images/AI_Assistant_Setup.gif)

Prompt templates are Markdown notes in your prompt template folder. They can use
QuickAdd [Format Syntax](/docs/FormatSyntax/), including values collected earlier
Expand All @@ -47,7 +47,12 @@ After setup, add an **AI Assistant** command to a Macro. The command formats the
selected prompt template, sends it to the selected model, then stores the
response as macro variables for later steps.

![AI Assistant Macro](./Images/AI_Assistant_Macro.gif)
In the recording below, a `Summarize` prompt template (containing
`{{SELECTED}}`) feeds the selected paragraph to the model, the command stores
the reply as `summary`, and a Capture writes `{{VALUE:summary}}` to the bottom of
the active note.

![Building a Summarize selection macro with an AI Assistant command and a Capture, then running it on a selected paragraph to append a summary](./Images/AI_Assistant_Macro.gif)

## What each setting does {#settings-semantics}

Expand Down
21 changes: 14 additions & 7 deletions docs/src/content/docs/docs/Choices/MultiChoice.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,22 @@ picker grows past a handful of items. In the settings list, a Multi is the entry
you can fold and unfold. Create one with **New folder** in **Settings →
QuickAdd**.

![The Multi choice settings modal](../Images/choices/multi-choice.png)
![The QuickAdd choice list with a Journal folder unfolded, showing two choices nested inside it](../Images/choices/multi-choice-list.png)

## Put choices inside a multi {#add-choices}

To create a new choice inside a multi, unfold it and click its **Add choice**
link. To move an existing choice in, **drag it in**. Make sure the multi is
unfolded (as in the screenshot above), grab the drag handle of the choice you
want to move, and drop it just below and slightly to the right of the multi's
own drag handle. When it works, the choice appears indented under the multi.
unfolded (as in the screenshot above), then grab the drag handle (⠿) at the
right end of the choice's row - it appears when you hover the row - and drop
the choice onto the rows under the multi. When it works, the choice appears
indented under the multi.

:::tip
The first choice is the fiddly one, since there's nothing nested yet to aim for.
Drop it just below and to the right of the multi's drag handle and watch for the
indent. Once one choice is inside, the rest are easy.
An empty multi shows a band that reads **Empty — add a choice or drag one
here**. Drop your first choice onto that band; it highlights when the drop
will land inside the multi. Once one choice is inside, drop the rest among the
nested rows.
:::

## Set the search box hint: Placeholder text {#placeholder-text}
Expand All @@ -35,6 +37,11 @@ the multi's name is used instead.
Because [search reaches everything nested under the multi](#searching-nested-choices),
word the hint for the whole group, not just the top level.

To set it, click the gear on the multi's row to open **Edit folder**, fill in
**Placeholder**, and click **Save**.

![The Edit folder modal with Name, Placeholder, and Icon settings](../Images/choices/multi-choice.png)

## Change a choice's icon {#icons}

Choices in the QuickAdd picker use the same Obsidian/Lucide icons as registered
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ You can make one Capture choice per export, so each has its own command.

## What you get

![Running the Import Todoist tasks choice: picking the QuickAdd Demo project appends its three tasks to the note as checklist items](../Images/todoist_import_demo.gif)

The tasks are written in this format:
`- [ ] <Task Content> 📅 <YYYY-MM-DD>`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ This macro asks which book you are reading and writes your answer to the **Book*

Run the macro and enter a book title at the prompt. QuickAdd updates the **Book** property in today's journal note to that title.

![The Macro builder for the log-book macro](../Images/choices/macro-builder.png)
![The Macro builder for the Log Book macro, with the logBook user script as its only command](../Images/examples/macro-log-book.png)

```js
// You have to export the function you wish to run.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ slug: docs/Examples/Macro_MoveNotesWithATagToAFolder

This macro moves every note carrying a tag you pick into a folder you pick. It matches the tag whether it lives in a note's frontmatter or inline in the body, and it can optionally include nested tags (for example `#project/work` when you choose `#project`). No extra plugins are needed - it uses only Obsidian's own API.

![h44DF7W7Ef](https://user-images.githubusercontent.com/29108628/122404732-c18d6f00-cf7f-11eb-8a6f-17d47db8b015.gif)
![Running the macro: picking the #website tag, answering No to nested tags, and choosing Projects/Website moves both tagged notes out of Inbox](../Images/move_tagged_notes_demo.gif)

## Setup

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ We use OMDb api to get the movie or TV show information. You can get an API key

## Demo

![Demo](../Images/moviescript.gif)
![Running the Movie macro: searching for Dune: Part Two creates a movie note with properties and the poster](../Images/moviescript.gif)

## Installation

Expand All @@ -32,7 +32,9 @@ You can find the script <a href="/scripts/movies.js" download>here</a>.
1. Set the template path to the template you created.
2. Enable File Name Format and use `{{VALUE:fileName}}` as the file name format. You can specify this however you like. The `fileName` value is the name of the Movie or TV show without illegal file name characters.
3. The remaining settings are for you to specify depending on your needs.
6. Click on the cog icon to the right of the script command to configure the script settings. This should allow you to enter the API key you got from OMDb. [Image demonstration](../Images/moviescript_settings.jpg).
6. Click on the cog icon to the right of the script command to configure the script settings. This should allow you to enter the API key you got from OMDb.

![The Movie macro with the movies script settings open, showing the OMDb API Key field](../Images/moviescript_settings.png)

You can now use the macro to create notes with movie or TV show information in your vault.

Expand Down
10 changes: 3 additions & 7 deletions docs/src/content/docs/docs/Examples/Macro_TogglManager.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,21 +11,17 @@ It uses the [Toggl plugin](https://github.com/mcndt/obsidian-toggl-integration)
![Toggl Manager](../Images/TogglManager.gif)

We'll need to install a QuickAdd user script for this to work. I have made a video which shows you how to do so - [click here](https://www.youtube.com/watch?v=gYK3VDQsZJo&t=1730s).
You will need to put the user script into a new macro and then create a Macro choice in the main menu to activate it.
You will need to add the user script to a new Macro choice, which you then run from the QuickAdd menu.
You can find the script <a href="/scripts/togglManager.js" download>here</a>.

## Installation
1. Save the script (`togglManager.js`) to your vault. Make sure it is saved as a JavaScript file, meaning that it has the `.js` at the end. **Important:** Do not save scripts in the `.obsidian` directory - they will be ignored. Valid locations include folders like `/scripts/`, `/macros/`, or any custom folder in your vault.
2. In **Settings → QuickAdd**, click **New choice** → **Macro**. This is what activates the macro. The Macro Builder opens; click its name at the top to rename it - you decide what to name it. I named mine ``⏳ Toggl Manager``.
2. In **Settings → QuickAdd**, click **New choice** → **Macro**. The Macro Builder opens; click its name at the top to rename it - you decide what to name it. I named mine ``⏳ Toggl Manager``.
3. Add the user script to the command list.

Your Macro should look like this:

![TogglManager Macro](../Images/TogglManagerMacro.png)

Your Macro Choice should look like this:

![Toggl Manager Macro Choice](../Images/TogglManagerMacroChoice.png)
![The Toggl Manager macro, with the togglManager user script as its only command](../Images/TogglManagerMacro.png)

## Configuration
You will need to configure your script to match your own settings. I have included some example settings from my own setup, but you'll likely want to make it match your own preferences.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,22 +13,22 @@ This example gives you a QuickAdd choice that creates a new inbox note in one st
## Setup

1. In **Settings → QuickAdd**, click **New choice** → **Template**. The Template choice settings open; click its name at the top to rename it (for example, `Inbox Item`). For a full tour of these settings, see [the Template choice docs](/docs/Choices/TemplateChoice/).
2. Set **Template Path** to your inbox template:
2. Set **Template path** to your inbox template:

```
bins/templates/Inbox Template.md
```

3. Enable **File Name Format** and set it to:
3. Turn on **File name format** and set it to:

```
{{DATE:YYYY-MM-DD-HH-mm-ss}} {{NAME}}
```

`{{DATE:YYYY-MM-DD-HH-mm-ss}}` becomes the current date and time down to the second, and `{{NAME}}` becomes whatever you type when the choice runs. Together they keep every inbox note uniquely named and in date order.
4. Choose the folder new notes should go into and set the remaining options to your liking.
4. Set **New note location** to **In a specific folder**, enter `Inbox` in **Folder path**, and click **Add**. Set the remaining options to your liking.

![A Template choice for adding an inbox item](../Images/choices/template-builder.png)
![The Inbox item Template choice, with the template path, file name format, and Inbox folder set](../Images/examples/template-add-inbox-item.png)

## What you get

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ slug: docs/Examples/Template_AutomaticBookNotesFromReadwise

This example creates a new book note from a template and fills in a book's highlights straight from [Readwise](https://readwise.io). When you run it, you pick a book, and QuickAdd builds a note whose body already contains that book's highlights and notes.

![OoBBhFGoxl](https://user-images.githubusercontent.com/29108628/122776753-ac7c4d00-d2ab-11eb-9ade-4b88afaee8e4.gif)
![Running the Add Book Notes choice: searching the Readwise library for The Art of War creates a book note with its highlights and notes](../Images/readwise_book_notes_demo.gif)

## Before you start

Expand All @@ -20,9 +20,9 @@ Here's a video guide for [installing user scripts in QuickAdd](/docs/Examples/Ca
1. Create a new JavaScript file (with the `.js` extension) containing the [script below](#script). In it, replace `YOUR_READWISE_TOKEN` with your own Readwise token.
2. Create the macro that runs the script: in **Settings → QuickAdd**, click **New choice** → **Macro**. The Macro Builder opens; click its name at the top to rename it (I use `Readwise`). See [the Macro choice docs](/docs/Choices/MacroChoice/) for a full walkthrough.
3. In the builder, add a **User Script** command: type the name of the script you created (or click **Browse**) and click **Add**.
4. Create a [Template choice](/docs/Choices/TemplateChoice/) whose **Template Path** points at the template you made from the [one below](#template). Set the remaining options to your liking. The screenshot shows settings resembling mine:
4. Create a [Template choice](/docs/Choices/TemplateChoice/) whose **Template path** points at the template you made from the [one below](#template). Set the remaining options to your liking. The screenshot shows settings resembling mine:

![Template choice setup](../Images/readwise_template_choice.png)
![A Template choice named Add Book Notes, with the file name format set to a Readwise macro call and Open set to a new tab](../Images/readwise_template_choice.png)

A few notes on how it behaves:

Expand Down
Binary file modified docs/src/content/docs/docs/Images/AI_Assistant_Macro.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/src/content/docs/docs/Images/AI_Assistant_Setup.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/src/content/docs/docs/Images/TogglManager.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/src/content/docs/docs/Images/TogglManagerMacro.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/src/content/docs/docs/Images/choices/macro-builder.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/src/content/docs/docs/Images/choices/multi-choice.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/src/content/docs/docs/Images/choices/template-builder.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/src/content/docs/docs/Images/moviescript.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/src/content/docs/docs/Images/script_with_settings.png
Binary file modified docs/src/content/docs/docs/Images/zettelizer_demo.gif
2 changes: 1 addition & 1 deletion docs/src/content/docs/docs/SuggesterSystem.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ tag from memory. Start typing a trigger like `[[` and QuickAdd shows a
searchable list of matches, exactly like Obsidian's own link and tag
autocomplete. Pick one, and QuickAdd drops it in where you were typing.

![The QuickAdd suggester listing files after typing two square brackets](https://github.com/user-attachments/assets/cc89f672-3451-42c0-89b8-89e0a1ebc780)
![The QuickAdd suggester listing files after typing two square brackets](./Images/suggester-file-search.png)

## What you can search for {#special-search-modes}

Expand Down
Loading