Skip to content

Commit a47bd82

Browse files
committed
Add book subtitle to template
1 parent 222ec68 commit a47bd82

File tree

1 file changed

+20
-23
lines changed

1 file changed

+20
-23
lines changed

README.md

+20-23
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/anpigon/obsidian-book-search-plugin/release.yml?logo=github)
44
![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/anpigon/obsidian-book-search-plugin?sort=semver)
5+
![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/anpigon/obsidian-book-search-plugin/total)
56
[![Korean](https://img.shields.io/badge/Language-한국어-blueviolet)](README.ko.md)
67

78
Easily create book notes.
@@ -139,16 +140,6 @@ By default, this option is turned off and can be activated in the plugin setting
139140
Upon enabling, you can designate a specific folder within your vault for storing these images, streamlining the management of book cover resources within your notes.
140141
To include these images in your notes, use the `{{localCoverImage}}` Templater variable.
141142

142-
### <strike>(Deprecated) Text to insert into front matter</strike>
143-
144-
<strike>You can add the following to the default Front Matter, or create a new Front Matter with the structure you want.</strike> Please use the template file described below.
145-
146-
### <strike>(Deprecated) Text to insert into content</strike>
147-
148-
<strike>You can add text to the content for [Dataview inline metadata](https://blacksmithgu.github.io/obsidian-dataview/data-annotation/#pages).</strike> Please use the template file described below.
149-
150-
<br>
151-
152143
## Example template
153144

154145
Please also find a definition of the variables used in this template below (see: [Template variables definitions](#template-variables-definitions)).
@@ -157,6 +148,7 @@ Please also find a definition of the variables used in this template below (see:
157148
---
158149
tag: 📚Book
159150
title: "{{title}}"
151+
subtitle: "{{subtitle}}"
160152
author: [{{author}}]
161153
publisher: {{publisher}}
162154
publish: {{publishDate}}
@@ -168,8 +160,12 @@ created: {{DATE:YYYY-MM-DD HH:mm:ss}}
168160
updated: {{DATE:YYYY-MM-DD HH:mm:ss}}
169161
---
170162
163+
%% To use an image URL from the server, use the following syntax: %%
171164
![cover|150]({{coverUrl}})
172165
166+
%% To save images locally, enable the 'Enable Cover Image Save' option in the settings and enter as follows: %%
167+
![[{{localCoverImage}}|150]]
168+
173169
# {{title}}
174170
175171
```
@@ -218,19 +214,20 @@ The banner at the top of the document is rendered using [Obsidian-banners](https
218214

219215
Please find here a definition of the possible variables to be used in your template. Simply write `{{name}}` in your template, and replace name by the desired book data, including:
220216

221-
| name | description |
222-
| --------------- | ------------------------------------------------------- |
223-
| title | The title of the book. |
224-
| author | The name of the book author. It can be multiple people. |
225-
| category | Book category. |
226-
| description | Book description. |
227-
| publisher | The publisher of the book. |
228-
| totalPage | The total number of pages in the book. |
229-
| coverUrl | Book cover image URL. |
230-
| publishDate | The year the book was published. |
231-
| isbn10 | ISBN10 |
232-
| isbn13 | ISBN13 |
233-
| localCoverImage | Local path of the downloaded cover image. |
217+
| name | description |
218+
| --------------- | ---------------------------------------------------------------- |
219+
| title | The title of the book. |
220+
| subtitle | The subtitle of the book may not be present in the API response. |
221+
| author | The name of the book author. It can be multiple people. |
222+
| category | Book category. |
223+
| description | Book description. |
224+
| publisher | The publisher of the book. |
225+
| totalPage | The total number of pages in the book. |
226+
| coverUrl | Book cover image URL. |
227+
| publishDate | The year the book was published. |
228+
| isbn10 | ISBN10 |
229+
| isbn13 | ISBN13 |
230+
| localCoverImage | Local path of the downloaded cover image. |
234231

235232
<br>
236233

0 commit comments

Comments
 (0)