johannrichard/Frontmatter Template.jinja

## 2 changes: 1 addition & 1 deletion Header Template.jinja
@@ -14,7 +14,7 @@ _by: [[{{ author | replace('\n', ']], [[')}}]]_

    > ![|300]( {{ cover_image_url }}) {% endif %}
> ![|300]( {{ cover_image_url }}) {% endif %}

    > Authors: [[{{ author | replace('\n', ']], [[')}}]]
> Authors: [[{{ author | replace('\n', ']], [[')}}]]

    > Category: {{ category }}
> Category: {{ category }}

    > Number of Highlights: =={{ num_highlights }}==
> Number of Highlights: =={{ num_highlights }}==

    > Number of Highlights: {{ num_highlights }}
> Number of Highlights: {{ num_highlights }}

    > Readwise URL: {{ highlights_url }}
> Readwise URL: {{ highlights_url }}

    > Source URL: [{{ source_url }}]({{ source_url }})
> Source URL: [{{ source_url }}]({{ source_url }})

    > Date: [[{{ updated }}]]
> Date: [[{{ updated }}]]


## 6 changes: 3 additions & 3 deletions Frontmatter Template.jinja
@@ -2,14 +2,14 @@

    ---
---

    id: {{ id }}
id: {{ id }}

    created: {{ updated }}
created: {{ updated }}

    {#- For fields like title and aliases, remove linebreaks and either add spaces (title, alias) or create multiple list entries (author) -#}
{#- For fields like title and aliases, remove linebreaks and either add spaces (title, alias) or create multiple list entries (author) -#}

    {# For fields like title and aliases, remove linebreaks and either add spaces (title, alias) or create multiple list entries (author) #}
{# For fields like title and aliases, remove linebreaks and either add spaces (title, alias) or create multiple list entries (author) #}

    title: "{{ title | replace('\n', ' ')}}"
title: "{{ title | replace('\n', ' ')}}"

    aliases: ["{{ title | replace('\n', ' ') }}"{%- if sanitized_title %}, "{{sanitized_title}}"{%- endif %}]
aliases: ["{{ title | replace('\n', ' ') }}"{%- if sanitized_title %}, "{{sanitized_title}}"{%- endif %}]

    author: ["{{ author | replace('\n', '", "')}}"]
author: ["{{ author | replace('\n', '", "')}}"]

    category: "{{ category }}"
category: "{{ category }}"

    highlights: {{ num_highlights }}
highlights: {{ num_highlights }}

    last_highlight_at: {{ last_highlight_at }}
last_highlight_at: {{ last_highlight_at }}

    source: {{ unique_url }}
source: {{ unique_url }}

    {#- Replace special characters in tags. Eventually, some of that might end up in the plugin as well -#}
{#- Replace special characters in tags. Eventually, some of that might end up in the plugin as well -#}

    {# Replace special characters in tags. Eventually, some of that might end up in the plugin as well #}
{# Replace special characters in tags. Eventually, some of that might end up in the plugin as well #}

    tags: [ {%- if tags_nohash %}{{ tags_nohash | replace('&', 'and') | replace('@', '') }},{%- endif %}{%- if hl_tags_nohash %}{{ hl_tags_nohash | replace('&', 'and') | replace('@', '')}}{%- endif %} ]
tags: [ {%- if tags_nohash %}{{ tags_nohash | replace('&', 'and') | replace('@', '') }},{%- endif %}{%- if hl_tags_nohash %}{{ hl_tags_nohash | replace('&', 'and') | replace('@', '')}}{%- endif %} ]

    ---
---

    ---
---

## 12 changes: 7 additions & 5 deletions Header Template.jinja
@@ -1,11 +1,12 @@

    {#- Header Template
{#- Header Template

        This is included once, and used to display variables of a Readwise Document (e.g. Author, Title, etc.) -#}
    This is included once, and used to display variables of a Readwise Document (e.g. Author, Title, etc.) -#}

    {# Header Template
{# Header Template

        This is included once, and used to display variables of a Readwise Document (e.g. Author, Title, etc.) #}
    This is included once, and used to display variables of a Readwise Document (e.g. Author, Title, etc.) #}

    %%
%%

    ID: {{ id }}
ID: {{ id }}

    Updated: {{ updated }}
Updated: {{ updated }}

    %%
%%

    # {{ title }}
# {{ title }}

    {#- Replace linebreaks and create multiple *Author* entries -#}
{#- Replace linebreaks and create multiple *Author* entries -#}

    {# Replace linebreaks and create multiple *Author* entries #}
{# Replace linebreaks and create multiple *Author* entries #}


    _by: [[{{ author | replace('\n', ']], [[')}}]]_
_by: [[{{ author | replace('\n', ']], [[')}}]]_


    > [!info]-
> [!info]-
@@ -36,11 +37,12 @@ _by: [[{{ author | replace('\n', ']], [[')}}]]_

    {%- endif %}
{%- endif %}


    ## Incoming Links
## Incoming Links

    {#- This requires that the dataview plugin is installed. It will show all incoming links to this file -#}
{#- This requires that the dataview plugin is installed. It will show all incoming links to this file -#}

    {# This requires that the dataview plugin is installed. It will show all incoming links to this file #}
{# This requires that the dataview plugin is installed. It will show all incoming links to this file #}


    ```dataview
```dataview

    LIST FROM  [[]] SORT file.frontmatter.created DESC
LIST FROM  [[]] SORT file.frontmatter.created DESC

    ```
```


    ## Highlights
## Highlights

    {#- After this heading, the highlights will follow, using the Highlight Template -#}
{#- After this heading, the highlights will follow, using the Highlight Template -#}

    {# After this heading, the highlights will follow, using the Highlight Template #}
{# After this heading, the highlights will follow, using the Highlight Template #}


## 5 changes: 2 additions & 3 deletions Highlight Template.jinja
@@ -1,8 +1,8 @@

    {#- Highlight template that does a few things:
{#- Highlight template that does a few things:

    {# Highlight template that does a few things:
{# Highlight template that does a few things:

      - Convert Readwise's "Highlight" syntax (__Highlight__) to Obsidian Highlight Syntax (==Highlight==)
  - Convert Readwise's "Highlight" syntax (__Highlight__) to Obsidian Highlight Syntax (==Highlight==)

      - Link to the Source and to the Highlight in Readwise
  - Link to the Source and to the Highlight in Readwise

      - Add block-id's both for the highlight and the note (Please be aware that line breaks, lists etc. in a note might create multiple blocks and referencing the "block-id-note" block might only link to the last block of the note.
  - Add block-id's both for the highlight and the note (Please be aware that line breaks, lists etc. in a note might create multiple blocks and referencing the "block-id-note" block might only link to the last block of the note.

    -#}
-#}

    #}
#}

    > [!quote]
> [!quote]

    > {{ text | bq | replace('__', '==') }}
> {{ text | bq | replace('__', '==') }}

    {%- if category == 'books' %}
{%- if category == 'books' %}
@@ -13,7 +13,6 @@

    ^{{ id }}-note
^{{ id }}-note

    {% endif %}
{% endif %}


    ({% if url %}[Source]({{ url }}), {% endif %}[Readwise](https://readwise.io/open/{{ id }}), [[{{ highlighted_at }}|{{ highlighted_at }}]])
({% if url %}[Source]({{ url }}), {% endif %}[Readwise](https://readwise.io/open/{{ id }}), [[{{ highlighted_at }}|{{ highlighted_at }}]])


    ----
----

## 2 changes: 1 addition & 1 deletion Highlight Template.jinja
@@ -4,7 +4,7 @@

      - Add block-id's both for the highlight and the note (Please be aware that line breaks, lists etc. in a note might create multiple blocks and referencing the "block-id-note" block might only link to the last block of the note.
  - Add block-id's both for the highlight and the note (Please be aware that line breaks, lists etc. in a note might create multiple blocks and referencing the "block-id-note" block might only link to the last block of the note.

    -#}
-#}

    > [!quote]
> [!quote]

    > {{ text | bq | replaace('__', '==') }}
> {{ text | bq | replaace('__', '==') }}

    > {{ text | bq | replace('__', '==') }}
> {{ text | bq | replace('__', '==') }}

    {%- if category == 'books' %}
{%- if category == 'books' %}

    > (*Original*: [{{ location }}]({{ locationUrl }})){%endif %}
> (*Original*: [{{ location }}]({{ locationUrl }})){%endif %}

    ^{{ id }}
^{{ id }}


## 15 changes: 15 additions & 0 deletions Frontmatter Template.jinja
@@ -0,0 +1,15 @@

    {#- Frontmatter Template - also called *Properties* in Obsidian -#}
{#- Frontmatter Template - also called *Properties* in Obsidian -#}

    ---
---

    id: {{ id }}
id: {{ id }}

    created: {{ updated }}
created: {{ updated }}

    {#- For fields like title and aliases, remove linebreaks and either add spaces (title, alias) or create multiple list entries (author) -#}
{#- For fields like title and aliases, remove linebreaks and either add spaces (title, alias) or create multiple list entries (author) -#}

    title: "{{ title | replace('\n', ' ')}}"
title: "{{ title | replace('\n', ' ')}}"

    aliases: ["{{ title | replace('\n', ' ') }}"{%- if sanitized_title %}, "{{sanitized_title}}"{%- endif %}]
aliases: ["{{ title | replace('\n', ' ') }}"{%- if sanitized_title %}, "{{sanitized_title}}"{%- endif %}]

    author: ["{{ author | replace('\n', '", "')}}"]
author: ["{{ author | replace('\n', '", "')}}"]

    category: "{{ category }}"
category: "{{ category }}"

    highlights: {{ num_highlights }}
highlights: {{ num_highlights }}

    last_highlight_at: {{ last_highlight_at }}
last_highlight_at: {{ last_highlight_at }}

    source: {{ unique_url }}
source: {{ unique_url }}

    {#- Replace special characters in tags. Eventually, some of that might end up in the plugin as well -#}
{#- Replace special characters in tags. Eventually, some of that might end up in the plugin as well -#}

    tags: [ {%- if tags_nohash %}{{ tags_nohash | replace('&', 'and') | replace('@', '') }},{%- endif %}{%- if hl_tags_nohash %}{{ hl_tags_nohash | replace('&', 'and') | replace('@', '')}}{%- endif %} ]
tags: [ {%- if tags_nohash %}{{ tags_nohash | replace('&', 'and') | replace('@', '') }},{%- endif %}{%- if hl_tags_nohash %}{{ hl_tags_nohash | replace('&', 'and') | replace('@', '')}}{%- endif %} ]

    ---
---

## 46 changes: 46 additions & 0 deletions Header Template.jinja
@@ -0,0 +1,46 @@

    {#- Header Template
{#- Header Template

        This is included once, and used to display variables of a Readwise Document (e.g. Author, Title, etc.) -#}
    This is included once, and used to display variables of a Readwise Document (e.g. Author, Title, etc.) -#}

    %%
%%

    ID: {{ id }}
ID: {{ id }}

    Updated: {{ updated }}
Updated: {{ updated }}

    %%
%%

    # {{ title }}
# {{ title }}

    {#- Replace linebreaks and create multiple *Author* entries -#}
{#- Replace linebreaks and create multiple *Author* entries -#}

    _by: [[{{ author | replace('\n', ']], [[')}}]]_
_by: [[{{ author | replace('\n', ']], [[')}}]]_


    > [!info]-
> [!info]-

    {%- if category == 'books' or category == 'supplementals' %}
{%- if category == 'books' or category == 'supplementals' %}

    > ![|300]( {{ cover_image_url }}) {% endif %}
> ![|300]( {{ cover_image_url }}) {% endif %}

    > Authors: [[{{ author | replace('\n', ']], [[')}}]]
> Authors: [[{{ author | replace('\n', ']], [[')}}]]

    > Category: {{ category }}
> Category: {{ category }}

    > Number of Highlights: =={{ num_highlights }}==
> Number of Highlights: =={{ num_highlights }}==

    > Readwise URL: {{ highlights_url }}
> Readwise URL: {{ highlights_url }}

    > Source URL: [{{ source_url }}]({{ source_url }})
> Source URL: [{{ source_url }}]({{ source_url }})

    > Date: [[{{ updated }}]]
> Date: [[{{ updated }}]]

    > Last Highlighted: [[{{ last_highlight_at }}]]
> Last Highlighted: [[{{ last_highlight_at }}]]


    {%- if summary %}
{%- if summary %}

    ## Summary
## Summary


    {{ summary }}
{{ summary }}

    ^summary
^summary

    {%- endif %}
{%- endif %}


    ---
---


    {%- if document_note %}
{%- if document_note %}

    ## Document Note
## Document Note


    {{ document_note }}
{{ document_note }}

    ^document-note
^document-note

    {%- endif %}
{%- endif %}


    ## Incoming Links
## Incoming Links

    {#- This requires that the dataview plugin is installed. It will show all incoming links to this file -#}
{#- This requires that the dataview plugin is installed. It will show all incoming links to this file -#}


    ```dataview
```dataview

    LIST FROM  [[]] SORT file.frontmatter.created DESC
LIST FROM  [[]] SORT file.frontmatter.created DESC

    ```
```


    ## Highlights
## Highlights

    {#- After this heading, the highlights will follow, using the Highlight Template -#}
{#- After this heading, the highlights will follow, using the Highlight Template -#}

## 19 changes: 19 additions & 0 deletions Highlight Template.jinja
@@ -0,0 +1,19 @@

    {#- Highlight template that does a few things:
{#- Highlight template that does a few things:

      - Convert Readwise's "Highlight" syntax (__Highlight__) to Obsidian Highlight Syntax (==Highlight==)
  - Convert Readwise's "Highlight" syntax (__Highlight__) to Obsidian Highlight Syntax (==Highlight==)

      - Link to the Source and to the Highlight in Readwise
  - Link to the Source and to the Highlight in Readwise

      - Add block-id's both for the highlight and the note (Please be aware that line breaks, lists etc. in a note might create multiple blocks and referencing the "block-id-note" block might only link to the last block of the note.
  - Add block-id's both for the highlight and the note (Please be aware that line breaks, lists etc. in a note might create multiple blocks and referencing the "block-id-note" block might only link to the last block of the note.

    -#}
-#}

    > [!quote]
> [!quote]

    > {{ text | bq | replaace('__', '==') }}
> {{ text | bq | replaace('__', '==') }}

    {%- if category == 'books' %}
{%- if category == 'books' %}

    > (*Original*: [{{ location }}]({{ locationUrl }})){%endif %}
> (*Original*: [{{ location }}]({{ locationUrl }})){%endif %}

    ^{{ id }}
^{{ id }}

    {%if note %}
{%if note %}

    {{ note }}
{{ note }}

    ^{{ id }}-note
^{{ id }}-note

    {% endif %}
{% endif %}


    ({% if url %}[Source]({{ url }}), {% endif %}[Readwise](https://readwise.io/open/{{ id }}), [[{{ highlighted_at }}|{{ highlighted_at }}]])
({% if url %}[Source]({{ url }}), {% endif %}[Readwise](https://readwise.io/open/{{ id }}), [[{{ highlighted_at }}|{{ highlighted_at }}]])


    ----
----

## 16 changes: 16 additions & 0 deletions Readwise Mirror Templates.md
@@ -0,0 +1,16 @@

    # What?
# What?


    These three files are my (current) Templates for the [Readwise Mirror](https://github.com/jsonMartin/readwise-mirror) plugin for Obsidian. They include (some) documentation.
These three files are my (current) Templates for the [Readwise Mirror](https://github.com/jsonMartin/readwise-mirror) plugin for Obsidian. They include (some) documentation.


    # Why?
# Why?


    They started to become complex enough to warrant some revision control, for which gist is perfect. They're probably useful for others too, hence the public gist.
They started to become complex enough to warrant some revision control, for which gist is perfect. They're probably useful for others too, hence the public gist.


    # How?
# How?


    * Install the plugin
* Install the plugin

    * Fill in the Header Template, the Frontmatter Template, and the Highlight Template
* Fill in the Header Template, the Frontmatter Template, and the Highlight Template

    * Use a Jinja Parser & Template engine (e.g. [this one](https://j2live.ttl255.com)[^1] to preview the files.
* Use a Jinja Parser & Template engine (e.g. [this one](https://j2live.ttl255.com)[^1] to preview the files.


    [^1]: I'm not affiliated but found this one to be sufficiently simple to test *basic* templates. However, be aware that the plugin's own functions (e.g. `bq`) can not be parsed and rendered by third party parsers.
[^1]: I'm not affiliated but found this one to be sufficiently simple to test *basic* templates. However, be aware that the plugin's own functions (e.g. `bq`) can not be parsed and rendered by third party parsers.