ZotFlow

https://zotflow.peterduan.dev/
Admin
ZotFlow is an Obsidian plugin that connects Zotero and Obsidian into a seamless workflow for syncing...
Tokens:41,154
Snippets:381
Trust Score:4.8
Update:1 month ago
Show doc for...
Tokens:
Raw
### wrap_editable region examples

Source: https://zotflow.peterduan.dev/template-filters

Examples for note, annotation comment, and persist regions using wrap_editable. Annotation comments undergo lightweight conversion before entering context.

```liquid
{{ note.note | html2md | wrap_editable: "NOTE", note.key }}
```

```liquid
{{ annotation.comment | wrap_editable: "ANNO", annotation.key }}
```

```liquid
{{ "Write your thoughts here…" | wrap_editable: "PERSIST", "summary" }}
```

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

### Example Footnote Reference Template marker

Source: https://zotflow.peterduan.dev/releases/1.2.1

Example marker pattern for the Footnote Reference Template. Ensure your definition template uses the same marker to keep references aligned.

```handlebars
[^{{ item.citationKey | default: item.key }}]  
```

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

### Render bibliographies with the bibliography filter

Source: https://zotflow.peterduan.dev/template-filters

Examples of rendering bibliographies for items or lists of items using the bibliography filter.

```liquid
{{ items | bibliography }}  

{{ items | bibliography: style: "apa", join: "\n\n" }}  

{{ item  | bibliography: "ieee" }}             →  [1] A. Author, …
```

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

### Markdown syntax preservation examples

Source: https://zotflow.peterduan.dev/markdown-support

Demonstrates that Markdown syntax elements like wikilinks, embeds, callouts, tasks, and tags are preserved exactly as written.

```markdown
[[wikilink]]        these are examples, not links

![[embed.png]]      and they stay examples

> [!note]

- [x] task

#tag
```

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

### Basic Citation and Bibliography Filter Usage

Source: https://zotflow.peterduan.dev/csl-citations

Examples of using the citation and bibliography filters in templates to produce formatted output.

```liquid
{{ item | citation }}                     →  (Doe, 2020)  

{{ annotation | citation }}               →  (Doe, 2020, p. 5)  

{{ items | bibliography: style: "apa" }}  →  a full, correctly sorted bibliography
```

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

### Render citations with the citation filter

Source: https://zotflow.peterduan.dev/template-filters

Examples of rendering citations using the citation filter with various arguments like style, locale, and format.

```liquid
{{ item | citation }}                          →  (Doe, 2020)  

{{ item | citation: "ieee" }}                  →  [1]           (positional arg = style id)  

{{ item | citation: style: "apa", locale: "de-DE", format: "text" }}  

{{ items | citation }}                         →  (Doe, 2020; Roe, 2021)
```

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

### Markdown Syntax Normalization Examples

Source: https://zotflow.peterduan.dev/markdown-support

Examples of how ZotFlow reformats markdown syntax elements such as list markers, horizontal rules, headings, quotes, URLs, HTML entities, and reference links.

```markdown
- item          →   * item            list markers  

---             →   ***               horizontal rules  

Title           →   # Title           "underline" headings become #  

=====  

>> quote        →   > > quote         nested quote spacing  

<https://x>     →   https://x         plain URLs stay plain  

&amp;           →   &                 HTML entities resolve  

[a][ref]        →   [a](url)          reference links become direct links  

[ref]: url
```

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

### Render annotation citations

Source: https://zotflow.peterduan.dev/template-filters

Examples of using the citation filter with annotations to automatically include page locators.

```liquid
{{ annotation | citation }}                    →  (Doe, 2020, p. 5)  

{{ annotations | citation }}                   →  (Doe, 2020, p. 5; Roe, 2021, p. 12)
```

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

### 附件链接（默认打开方式与 Zotero 本地阅读器）

Source: https://zotflow.peterduan.dev/template-guide

生成指向附件的 Markdown 链接，默认打开 Obsidian 内部附件；若要使用 Zotero 原生阅读器打开，需传递参数 `"zotero"`。

```Liquid
- [{{ attachment.filename }}]({{ attachment | attachment_link }})

---

要在 Zotero 的本地阅读器中打开：

- [{{ attachment.filename }}]({{ attachment | attachment_link: "zotero" }})
```

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

### 渲染标签（YAML Frontmatter）

Source: https://zotflow.peterduan.dev/template-guide

以 YAML 数组格式列出所有标签，并用下划线替换空格以便用于 Obsidian 文件属性。

```Liquid
tags: [{% for t in item.tags %}"#{{ t.tag | replace: " ", "_" }}"{% unless forloop.last %}, {% endunless %}{% endfor %}]
```

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

### Related-works list bibliography

Source: https://zotflow.peterduan.dev/template-filters

Example of rendering a bibliography for related items using a conditional block.

```liquid
{% assign cited = item.relatedItems | where: "resolved", true %}  

{% if cited.size > 0 %}  

## References  

{{ cited | bibliography: style: "apa" }}  

{% endif %}
```

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

### Apply default frontmatter with ?? prefix

Source: https://zotflow.peterduan.dev/releases/1.6.0

Use the ?? prefix in template keys to provide a default value that does not overwrite existing user-maintained values. The prefix is stripped during rendering, and keys without it continue to refresh from the template.

```yaml
---

??rating: unrated

status: reviewed

---
```

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

### Numbered style footnote workflow

Source: https://zotflow.peterduan.dev/template-filters

Example of stripping the numbering from a bibliography entry for use in Obsidian footnotes.

```liquid
[^{{ item.citationKey }}]: {{ item | bibliography: "ieee" | remove_first: "[1] " }}
```

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

### Encode annotation JSON

Source: https://zotflow.peterduan.dev/template-filters

Example of using the process_raw_anno_json filter to encode annotation data for comment markers.

```liquid
{{ annotation.raw | process_raw_anno_json }}
```

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

### 注解链接（跳到特定注解）

Source: https://zotflow.peterduan.dev/template-guide

生成一个 ZotFlow callout，标题中包含注解类型和颜色，链接跳转到具体注解。使用 Zotero 本地阅读器版本时去掉 callout 前缀。

```Liquid
> [!zotflow-{{ annotation.type }}-{{ annotation.color }}] [{{ attachment.filename }}, p.{{ annotation.pageLabel }}]({{ annotation | annotation_link }})


```

```Liquid
[{{ attachment.filename }}, p.{{ annotation.pageLabel }}]({{ annotation | annotation_link: "zotero" }})
```

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

### Footnote workflow with citation filter

Source: https://zotflow.peterduan.dev/template-filters

Example of using the citation filter to generate a footnote body for note-class styles.

```liquid
[^{{ item.citationKey }}]: {{ item | citation: "chicago-note-bibliography" }}
```

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

### 按附件分组注解

Source: https://zotflow.peterduan.dev/template-guide

这是一个多行 Liquid 循环，遍历附件的所有注解，按附件文件名分组列出。

```Liquid
{%- for attachment in item.attachments -%}

{%- if attachment.annotations.length > 0 -%}

### {{ attachment.filename }}

{%- for annotation in attachment.annotations -%}

- p.{{ annotation.pageLabel }}: {{ annotation.text }}

{%- endfor -%}

{%- endif -%}

{%- endfor -%}
```

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

### 内联注释 callout 中的标签

Source: https://zotflow.peterduan.dev/template-guide

若注解有标签，则生成一个引用块，其中包含用#号开头的标签，并用空格分隔。

```Liquid
{% if annotation.tags and annotation.tags.length > 0 -%}

> {% for t in annotation.tags %}#{{ t.tag | replace: " ", "_" }}{% unless forloop.last %} {% endunless %}{% endfor %}

{%- endif %}
```

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

### 路径模板

Source: https://zotflow.peterduan.dev/template-guide

使用 collection 路径生成目录结构，若没有路径则默认使用“Unsorted”，若没有 citationKey 则使用默认的 key。示例输出：`References/Research/Machine Learning/@smith2024`。

```Liquid
References/{{ itemPaths[0] | default: "Unsorted" }}/@{{ citationKey | default: key }}
```

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

### 安全的 YAML 值（json 过滤器）

Source: https://zotflow.peterduan.dev/template-guide

对可能包含特殊字符的字符串使用 `json` 过滤器，以避免 YAML 解析错误。

```Liquid
title: {{ item.title | json }}
```

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

### 注解 Callout 容器

Source: https://zotflow.peterduan.dev/template-guide

生成一个包含注解类型和颜色信息的 callout，内部可嵌入引用块。可通过 CSS 自定义每个 callout 样式。

```Liquid
> [!zotflow-{{ annotation.type }}-{{ annotation.color }}] Title text

> > Quoted annotation text
```

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

### Citation Filter with Style Override

Source: https://zotflow.peterduan.dev/csl-citations

Demonstrates using the citation filter with a default call and a per-call style override.

```liquid
{{ item | citation }}  

{{ item | citation: "ieee" }}          {%- comment %} per-call style override {% endcomment %}
```

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

### 逗号分隔的创作者列表

Source: https://zotflow.peterduan.dev/template-guide

生成一个包含所有创作者名称并用逗号分隔的字符串，常用于 frontmatter 的 authors 字段。

```Liquid
authors: [{% for c in item.creators %}"{{ c.name }}"{% unless forloop.last %}, {% endunless %}{% endfor %}]
```

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

### Markdown Table Padding Normalization

Source: https://zotflow.peterduan.dev/markdown-support

Demonstrates how ZotFlow pads markdown table columns to ensure they line up correctly.

```markdown
| A | B |          | A              | B      |  

| --- | --- |  →   | -------------- | ------ |  

| longer | b |     | longer         | b      |
```

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

### Footnote Reference Template

Source: https://zotflow.peterduan.dev/template-variables

Template for generating inline footnote markers.

```liquid

[^{{ item.citationKey | default: item.key }}]  


```
Tokens:
Raw