giteahh
8273017082
- Add 8 PARA directories to .gitignore whitelist (234 files) - Completes dual-layer sync: LLM Wiki layer + PARA personal knowledge layer - markdown_output/ remains excluded (transit zone)
119 lines
8.7 KiB
Markdown
119 lines
8.7 KiB
Markdown
---
|
|
title: "Variables"
|
|
source: "https://help.obsidian.md/web-clipper/variables"
|
|
author:
|
|
- "[[Obsidian Help]]"
|
|
published:
|
|
created: 2026-01-22
|
|
description: "Variables - Obsidian Help"
|
|
tags:
|
|
- "clippings"
|
|
rating: 4
|
|
---
|
|
|
|
[Web Clipper templates](https://help.obsidian.md/web-clipper/templates) can use variables to automatically pre-populate data from the page in a template. Variables can be used in the **note name**, **note location**, **properties**, and **note content**. Variables can also be modified using [filters](https://help.obsidian.md/web-clipper/filters).
|
|
|
|
Use the `…` icon in the [Web Clipper](https://help.obsidian.md/web-clipper) extension to access the current page variables for use in templates. There are five types of variables you can use:
|
|
|
|
## Preset variables
|
|
|
|
Preset variables are automatically generated based on the page content. These typically work for most websites.
|
|
|
|
The main content variable is `{{content}}`, which contains the article content, or the [highlights](https://help.obsidian.md/web-clipper/highlight), or the selection if there is any selected text on the page. Note that `{{content}}` attempts to extract the main content of the page, which may not always be what you want. In that case, you can use other preset variables or selector variables to extract the content you need.
|
|
|
|
| Variable | Description |
|
|
| --- | --- |
|
|
| `{{author}}` | Author of the page |
|
|
| `{{content}}` | Article content, [highlights](https://help.obsidian.md/web-clipper/highlight), or selection, in Markdown format |
|
|
| `{{contentHtml}}` | Article content, [highlights](https://help.obsidian.md/web-clipper/highlight), or selection, in HTML format |
|
|
| `{{date}}` | Current date, can be formatted using the `date` filter |
|
|
| `{{description}}` | Description or excerpt |
|
|
| `{{domain}}` | Domain |
|
|
| `{{favicon}}` | Favicon URL |
|
|
| `{{fullHtml}}` | Unprocessed HTML for the full page content |
|
|
| `{{highlights}}` | [Highlights](https://help.obsidian.md/web-clipper/highlight) with text and timestamps |
|
|
| `{{image}}` | Social share image URL |
|
|
| `{{published}}` | Published date, can be formatted using the `date` filter |
|
|
| `{{selection}}` | Selection in Markdown format |
|
|
| `{{selectionHtml}}` | Selection in HTML format |
|
|
| `{{site}}` | Site name or publisher |
|
|
| `{{title}}` | Title of the page |
|
|
| `{{time}}` | Current date and time |
|
|
| `{{url}}` | Current URL |
|
|
| `{{words}}` | Word count |
|
|
|
|
## Prompt variables
|
|
|
|
Prompt variables leverage language models to extract and modify data using natural language. Prompt variables require [Interpreter](https://help.obsidian.md/web-clipper/interpreter) to be enabled and configured.
|
|
|
|
Prompt variables use the syntax `This page documents the five types of variables available in Obsidian Web Clipper templates: Preset, Prompt, Meta, Selector, and Schema.org variables. It explains their syntax, use cases, and provides examples for each.`. The double quotes around the prompt are important and distinguish prompts from preset variables. Prompt responses can be post-processed with [filters](https://help.obsidian.md/web-clipper/filters), e.g. `> This page documents the five types of variables available in Obsidian Web Clipper templates: Preset, Prompt, Meta, Selector, and Schema.org variables. It explains their syntax, use cases, and provides examples for each.`.
|
|
|
|
### When to use prompt variables
|
|
|
|
Prompt variables have the benefit of being extremely flexible and easy to write, however they come with several tradeoffs: they are slower to run, and may have cost and privacy considerations depending on the [provider](https://help.obsidian.md/web-clipper/interpreter#Models) you choose.
|
|
|
|
Unlike other variable types, prompt variables need to be processed by an external language model, so they are replaced only once [Interpreter](https://help.obsidian.md/web-clipper/interpreter) has run.
|
|
|
|
It is best to *not* use prompt variables if the data you want to extract is in a consistent format that could be extracted with other variable types.
|
|
|
|
On the other hand, prompt variables can be useful if the data you want to extract is an *inconsistent* format across websites. For example, you can make a [template](https://help.obsidian.md/web-clipper/templates) to save books that is agnostic of the book site. Prompt variables like `The author of the book is extracted from the page content using a language model, providing a flexible method that works across different book websites where the author information may be presented in inconsistent formats.` will work across any book site, whereas selector variables typically only work for one site.
|
|
|
|
### Examples
|
|
|
|
Prompts can use almost any natural language query. Depending on the model you use, prompts can query or translate data across languages.
|
|
|
|
- `- Les variables prédéfinies sont générées automatiquement à partir du contenu de la page.
|
|
- Les variables d'invite utilisent des modèles de langage pour extraire et modifier des données.
|
|
- Les autres types incluent les variables méta, les variables de sélecteur et les variables Schema.org.` to extract bullet points about the page, and translate them to French.
|
|
- `- Les variables prédéfinies sont générées automatiquement à partir du contenu de la page.
|
|
- Les variables d'invite utilisent des modèles de langage pour extraire et modifier des données.
|
|
- Les autres types incluent les variables méta, les variables de sélecteur et les variables Schema.org.` to extract three bullet points using a prompt in French.
|
|
|
|
Prompts can transform page content into JSON that can be manipulated with [filters](https://help.obsidian.md/web-clipper/filters). For example:
|
|
|
|
```
|
|
— [[@]], [[]]
|
|
```
|
|
|
|
## Meta variables
|
|
|
|
- `{{meta:name}}` returns the content of the meta name tag with the given name, e.g. `{{meta:name:description}}` for the `description` meta tag.
|
|
- `{{meta:property}}` returns the content of the meta property tag with the given property, e.g. `{{meta:property:og:title}}` for the `og:title` meta tag.
|
|
|
|
## Selector variables
|
|
|
|
Selector variables allow you to extract text content from elements on the page using [CSS selectors](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_selectors/Selectors_and_combinators).
|
|
|
|
The syntax is `{{selector:cssSelector?attribute}}`, where `?attribute` is optional. If no attribute is specified, the text content of the element is returned. You can also use `{{selectorHtml:cssSelector}}` to get the HTML content of the element. Selector variables tend to work best on a specific website or set of websites that have consistent HTML structure.
|
|
|
|
- `{{selector:h1}}` returns text content of any `h1` elements on the page.
|
|
- `{{selector:.author}}` returns text content of any `.author` elements on the page.
|
|
- `{{selector:img.hero?src}}` returns the `src` attribute of the image with class `hero`.
|
|
- `{{selector:a.main-link?href}}` returns the `href` attribute of the anchor tag with class `main-link`.
|
|
- `{{selectorHtml:body|markdown}}` returns the entire HTML of the `body` element, converted to Markdown using the `markdown` [filter](https://help.obsidian.md/web-clipper/filters#HTML%20processing).
|
|
- Nested CSS selectors and combinators are supported if you need more specificity.
|
|
- If multiple elements match the selector, an array is returned, which you can process with [array and object filters](https://help.obsidian.md/web-clipper/filters#Arrays%20and%20objects) like `join` or `map`.
|
|
|
|
## Schema.org variables
|
|
|
|
Schema variables allow you to extract data from [schema.org](https://schema.org/) JSON-LD on the page. Schema.org data can also be used to automatically [trigger a template](https://help.obsidian.md/web-clipper/templates#Schema.org%20matching).
|
|
|
|
- `{{schema:@Type:key}}` returns the value of the key from the schema.
|
|
- `{{schema:@Type:parent.child}}` returns the value of a nested property.
|
|
- `{{schema:@Type:arrayKey}}` returns the first item in an array.
|
|
- `{{schema:@Type:arrayKey[index].property}}` returns the item at the specified index in an array.
|
|
- `{{schema:@Type:arrayKey[*].property}}` returns a specific property from all items in an array.
|
|
|
|
You can also use a shorthand notation without specifying the schema type:
|
|
|
|
- `{{schema:author}}` will match the first `author` property found in any schema type.
|
|
- `{{schema:name}}` will match the first `name` property found in any schema type.
|
|
|
|
This shorthand is particularly useful when you don't know or don't care about the specific schema type, but you know the property name you're looking for.
|
|
|
|
Nested properties and array access work as well, both with and without the schema `@Type` specified:
|
|
|
|
- `{{schema:author.name}}` will find the first `author` property and then access its `name` sub-property.
|
|
- `{{schema:author[0].name}}` will access the `name` of the first author in an array of authors.
|
|
- `{{schema:author[*].name}}` will return an array of all author names.
|