NotePlan

https://help.noteplan.co
Admin
NotePlan is a note-taking and planning application that helps users organize their thoughts, tasks,...
Tokens:57,323
Snippets:422
Trust Score:9.5
Update:11 months ago
Show doc for...
Tokens:
Raw
### Complete Daily Template Example

Source: https://help.noteplan.co/article/229-auto-insert-templates

This is a complete example of a daily calendar note template, including frontmatter with repeat, title, and type, followed by Markdown content for daily goals and tasks.

```markdown
---
repeat: note = day
title: Daily Planning
type: calendar-note
---


## Today's Goals
> 




## Tasks


```

--------------------------------

### Minimal plugin.json for NotePlan Plugin

Source: https://help.noteplan.co/article/67-create-command-bar-plugins

This is a basic example of a plugin.json file, illustrating the essential fields required for a NotePlan plugin. It includes minimum app version requirements, plugin identification, author details, versioning, script reference, and command definitions.

```json
{
  "noteplan.minAppVersion": "3.0.21", 
  "macOS.minVersion": "10.15.7",
  "iOS.minVersion": "14",
  "plugin.id": "eduardme.move", 
  "plugin.name": "Move selected note to another folder", 
  "plugin.description": "Move a note from the current folder into another.", 
  "plugin.author": "Eduard Metzger",
  "plugin.url": "https://&hellip;",
  "plugin.version": "0.0.2", 
  "plugin.dependencies": [ ], 
  "plugin.script": "script.js",
  "plugin.lastUpdateInfo": "",
  "plugin.requiredFiles": "",
  "plugin.commands": [
    {
      "name": "move", 
      "alias": ["m", "mv"],
      "description": "Moves note to another folder", 
      "jsFunction": "moveNote",
      "arguments": ["note title", "heading"]
    }
  ],
  "plugin.settings": []
}
```

--------------------------------

### Define and Use Prompt Later (Templating)

Source: https://help.noteplan.co/article/261-template-prompts-dialogs

This example shows how to define a prompt at the beginning of a template and use its value later. This is useful for collecting information upfront that will be referenced multiple times throughout the template.

```html
<% prompt('lastName','What is your last name?') -%>

The rest of this could be your template code
And then finally use the `lastName` variable
<%- lastName %>

```

--------------------------------

### Example: Random Annual Goal from Yearly Note

Source: https://help.noteplan.co/article/233-ai-prompts-in-templates

This template example demonstrates fetching a random bullet point from a yearly note (the current year's calendar note). It uses `NotePlan.ai` with the prompt 'Return a bullet. Not just the first one, make it random' and references 'this year'. The output is then formatted with markdown.

```javascript
**Random Annual Goal:**
<%- await NotePlan.ai("Return a bullet. Not just the first one, make it random", ["this year"])
```

--------------------------------

### Initialize Plugin Hooks in JavaScript

Source: https://help.noteplan.co/article/137-plugin-hooks

Defines three essential NotePlan plugin hooks for managing plugin lifecycle events. The init() function runs before any command execution for setup, onUpdateOrInstall() handles post-update preparations like data migration, and onSettingsUpdated() responds to configuration changes. Each hook receives no parameters and returns void.

```JavaScript
function init() {
  console.log("Initialize the plugin before the command is executed")
}

```

```JavaScript
function onUpdateOrInstall() {
  console.log("Plugin updated or installed, perform migration or other preparations now")
}

```

```JavaScript
function onSettingsUpdated() {
  console.log("Settings updated of this plugin, run cleanup, or other preparations")
}

```

--------------------------------

### Defining a Specific OpenAI Model

Source: https://help.noteplan.co/article/233-ai-prompts-in-templates

This example shows how to specify a particular OpenAI model to be used by the `NotePlan.ai` function, especially when using your own API key. You can provide model identifiers like 'o1' or 'o3-mini'. If omitted, NotePlan defaults to using GPT-4o.

```javascript
// Use a specific OpenAI model
<%- await NotePlan.ai("Generate creative ideas", ["Project Ideas.md"], false, "o1") %>
```

--------------------------------

### Define Text Styles in JSON Theme

Source: https://help.noteplan.co/article/44-customize-themes

This JSON snippet outlines the styles section for configuring text properties like fonts, sizes, and colors for various elements such as body text and titles. No dependencies are needed; inputs are style objects, and outputs are rendered text styles in the NotePlan editor.

```json
"styles": {
    "body": {
        "font": "AvenirNext-Regular",
        "size": 16,
        "color": "#333333"
    },
    "title1": {
        "color": "#000000",
        "size": 28
    },
    "title2": {
        "color": "#000000",
        "size": 24
    }
}
```

--------------------------------

### Disable Font Overwriting in JSON Theme

Source: https://help.noteplan.co/article/44-customize-themes

This JSON attribute allows overriding the default font overwriting behavior in NotePlan themes, enabling custom font definitions. It depends on the theme file setup and toggles font control between app preferences and theme settings.

```json
"shouldOverwriteFont": false
```

--------------------------------

### Async Function for Folder Selection in JavaScript

Source: https://help.noteplan.co/article/67-create-command-bar-plugins

This example demonstrates an async JavaScript function using await to prompt user input for folder selection in NotePlan. It relies on CommandBar and DataStore global objects provided by NotePlan. The function takes no explicit inputs, awaits user choice, and allows access to selected folder via value or index. Suitable for interactive plugin commands but requires async prefix.

```JavaScript
async function selectFolder() {
    let folder = await CommandBar.showOptions(DataStore.folders, "Select")
    // Use folder.value or folder.index [...]
}

```

--------------------------------

### Example: Generating Quotes Without Note References

Source: https://help.noteplan.co/article/233-ai-prompts-in-templates

This example shows a simple use of `NotePlan.ai` to generate content without referencing any specific notes. The prompt 'Return 3 stoic inspirational quotes' is provided directly, and the `filenames` argument is omitted. This is useful for generating standalone content like quotes or ideas.

```javascript
**Think:**
<%- await NotePlan.ai("Return 3 stoic inspirational quotes") %>
```

--------------------------------

### Output module method result

Source: https://help.noteplan.co/article/260-template-tags

The <%- tag can output results from module methods. In this example, it displays the current date from the Date module. The templating engine does not escape characters by default.

```javascript
<%- date.now() %>
```

--------------------------------

### Create Daily Note Template with Prompts and Events

Source: https://help.noteplan.co/article/136-templates

Creates a structured daily note with mood tracking, primary focus, tasks, and calendar events. Uses prompt dialogs for user input and requires Event Helper plugin for event listing. Outputs organized sections with dynamic content.

```ejs
*Mood: <%- prompt('What's your mood today?',['🙂','😐','😕']) %>*

## Primary Focus
* <%- prompt('Most important task today?') %>

## Tasks
* 

## Events
<%- listTodaysEvents({template:"- *|START|*-*|END|*: *|TITLE|*",allday_template:"- *|TITLE|*"}) %>
```

--------------------------------

### Get selected note title using AppleScript

Source: https://help.noteplan.co/article/120-apple-script

Retrieves the title of the currently opened note in NotePlan. Uses the `selectedNoteTitle` property and returns the title as a. No additional dependencies are required.

```AppleScript
tell application "NotePlan 3"
    set x to selectedNoteTitle
   end tell
```

--------------------------------

### Get selected note URL using AppleScript

Source: https://help.noteplan.co/article/120-apple-script

Retrieves the x-callback URL of the currently opened note in NotePlan. Uses the `selectedNoteUrl` property and returns the URL as a string. No additional dependencies are required.

```AppleScript
tell application "NotePlan 3"
    set x to selectedNoteUrl
    return x
end tell
```

--------------------------------

### Example JSON Response from CoinDesk API

Source: https://help.noteplan.co/article/146-add-a-webservice-to-templates

This is a raw JSON response from the CoinDesk API endpoint for current bitcoin prices. It contains detailed information including timestamps, disclaimers, and price data in various currencies (USD, GBP, EUR). This format is used to identify the specific data points needed for custom template integration.

```json
{"time":{"updated":"Jun 1, 2022 16:01:00 UTC","updatedISO":"2022-06-01T16:01:00+00:00","updateduk":"Jun 1, 2022 at 17:01 BST"},"disclaimer":"This data was produced from the CoinDesk Bitcoin Price Index (USD). Non-USD currency data converted using hourly conversion rate from openexchangerates.org","chartName":"Bitcoin","bpi":{"USD":{"code":"USD","symbol":"$","rate":"30,710.6775","description":"United States Dollar","rate_float":30710.6775},"GBP":{"code":"GBP","symbol":"&pound;","rate":"24,407.1574","description":"British Pound Sterling","rate_float":24407.1574},"EUR":{"code":"EUR","symbol":"&euro;","rate":"28,663.2274","description":"Euro","rate_float":28663.2274}}}
```

--------------------------------

### Get total number of project notes in JavaScript

Source: https://help.noteplan.co/article/148-run-javascript-code-in-your-templates

This snippet returns the total count of project notes currently available in NotePlan. It uses the DataStore API to access note metadata.

```javascript
- <%- DataStore.projectNotes.length %>
```

--------------------------------

### Fetching Weather Data with Fetch in JavaScript

Source: https://help.noteplan.co/article/67-create-command-bar-plugins

This async function uses the fetch API to retrieve current weather data from a public API in NotePlan plugins. It requires an HTTPS endpoint and takes no inputs beyond the hardcoded URL with API key. Outputs the response object to console; handle JSON parsing separately. Limited to SSL-certified sites and may need error handling for network issues.

```JavaScript
async function weatherFetch() {
    let response = await fetch("https://api.weatherapi.com/v1/current.json?key=f4c442d67eef4574b99184324211404&q=Berlin&aqi=no")
    console.log(response)
}

```

--------------------------------

### Prompt for Frontmatter Key (Templating)

Source: https://help.noteplan.co/article/261-template-prompts-dialogs

The `promptKey` function allows users to select a value from existing frontmatter keys in notes. It supports specifying the key, a custom message, note type, case sensitivity, folder restrictions, and full path matching. It can also use predefined options.

```html
Project status: <%- promptKey('projectStatus', 'Select project status:') %>

```

```html
Tag: <%- promptKey('tags', 'Select a tag:', 'Notes', true, 'Projects') %>
Tag: <%- promptKey('tags', 'Select a tag:', 'Notes', true, 'Work/Projects/Clients', true) %>

```

```html
Priority: <%- promptKey('priority', 'Set priority:', 'All', false, '', false, ['High', 'Medium', 'Low']) %>

```

--------------------------------

### Basic Plugin Command Function in JavaScript

Source: https://help.noteplan.co/article/67-create-command-bar-plugins

This snippet defines a simple JavaScript function that serves as a plugin command in NotePlan. It logs a message to the console and must be referenced in plugin.json. No external dependencies are required beyond NotePlan's runtime; it takes no inputs and produces console output. Limitations include basic execution without async support or user interaction.

```JavaScript
function moveNote() {
    console.log("Hello World")
}

```

--------------------------------

### Output unescaped web service result

Source: https://help.noteplan.co/article/260-template-tags

The <%- tag outputs unescaped results from web services. This example shows retrieving a developer quote from a web service defined in templating plugin settings. Dangerous characters from web requests should be escaped manually if needed.

```javascript
<%- web.service('developerQuote') %>
```

--------------------------------

### If/Else Conditionals in EJS

Source: https://help.noteplan.co/article/266-conditionals-if-else

This example illustrates if/else logic in EJS for NotePlan templates. It renders different content based on whether the condition is true or false. Requires the template processor to handle <% %> syntax and supports variable interpolation with note plan objects.

```EJS
<% if (1 > 0) { %>
 true
<% } else { %>
 else
<% } %>
```
Tokens:
Raw