Obsidian Book Search Plugin
Easily create book notes.
Changelog
To view the changelog for the latest and previous versions, please click here to visit the GitHub releases page for the Obsidian Book Search Plugin.
Demo
https://user-images.githubusercontent.com/3969643/184918274-8ad24546-2e01-4288-a855-c8eeb1feca7d.mp4
Description
Use to query book using :
- A book title, author, publisher or ISBN (10 or 13).
Use Google Books API to get the book information.
How to install
Click the link to install the Book Search plugin: Install Link
Or, Search in the Obsidian Community plugin. And install it.
Enhancements: Cover Image Display in Search Results
We've introduced a new setting in our plugin that allows users to display cover images alongside book suggestions in the search results. This feature aims to enrich the search experience by providing visual cues, making it easier for users to identify books at a glance. The cover images are designed to complement the textual information, offering a more engaging and intuitive search interface.
By default, this feature is disabled to maintain a clean, text-focused search experience. Users who prefer to keep their search results streamlined without images will find the default setting optimized for their preference.
Enabling Cover Images
To activate cover images in your search results:
- Go to the plugin settings.
- Find the "Show Cover Images in Search" option.
- Switch the toggle to on to enable cover images.
CSS Styling for Cover Images
For those who enable this feature, we've added CSS styling to ensure that cover images are displayed effectively without disrupting the flow of information. To add this CSS snippet in Obsidian, you can either include it directly in your plugin's CSS file or insert it into Obsidian's custom CSS section for your vault. Here's how to add the CSS snippet for styling the book suggestions with cover images:
- Open Obsidian.
- Navigate to Settings > Appearance.
- Under the CSS Snippets section, click on Open snippets folder.
- Create a new .css file in this folder and paste the following CSS snippet into the file.
- Go back to Obsidian, and under CSS Snippets, turn on the snippet you just added.
.book-suggestion-item {
display: flex;
align-items: center;
margin-bottom: 10px;
}
.book-cover-image {
max-width: 100px;
max-height: 100px;
margin-right: 10px;
object-fit: cover;
border-radius: 3px;
}
.book-text-info {
flex-grow: 1;
}How to use
1. Click the ribbon icon, or excute the command "Create new book note".
2. Search for books by keywords.
3. Select the book from the search results.
4. Voila! A note has been created.
How to use settings
New file location
Set the folder location where the new file is created. Otherwise, a new file is created in the Obsidian Root folder.
New file name
You can set the file name format. The default format is {{title}} - {{author}}.
You can use {{DATE}} or {{DATE:YYYYMMDD}} to set a unique file name.
Template file
You can set the template file location. There is an example template at the bottom.
Service Provider
You can set up the services that you use to search for books. Only Google and Naver(네이버) are available now. To use Naver Book Search, clientId and clientSecret are required. I will explain how to get clientId and clientSecret from Naver on my blog.
Cover Image Edge Curl
By default, the Google Books API adds a "page curl" effect to image thumbnails. Disabling this toggle will remove this effect from the cover images.
Cover Image Saving
This feature allows for the automatic downloading and saving of book cover images directly into your Obsidian vault.
By default, this option is turned off and can be activated in the plugin settings.
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.
To include these images in your notes, use the {{localCoverImage}} Templater variable.
Example template
Please also find a definition of the variables used in this template below (see: Template variables definitions).
---
tag: 📚Book
title: "{{title}}"
subtitle: "{{subtitle}}"
author: [{{author}}]
category: [{{category}}]
publisher: {{publisher}}
publish: {{publishDate}}
total: {{totalPage}}
isbn: {{isbn10}} {{isbn13}}
cover: {{coverUrl}}
localCover: {{localCoverImage}}
status: unread
created: {{DATE:YYYY-MM-DD HH:mm:ss}}
updated: {{DATE:YYYY-MM-DD HH:mm:ss}}
---
%% To use an image URL from the server, use the following syntax: %%
<%* if (tp.frontmatter.cover && tp.frontmatter.cover.trim() !== "") { tR += `` } %>
%% To save images locally, enable the 'Enable Cover Image Save' option in the settings and enter as follows: %%
<%* if (tp.frontmatter.localCover && tp.frontmatter.localCover.trim() !== "") { tR += `![[${tp.frontmatter.localCover}|150]]` } %>
# {{title}}
Dataview rendering
Here is the dataview query used in the demo
# 📚 My Bookshelf
```dataview
TABLE WITHOUT ID
status as Status,
rows.file.link as Book
FROM #📚Book
WHERE !contains(file.path, "Templates")
GROUP BY status
SORT statusList of all books
TABLE WITHOUT ID
status as Status,
"![|60](" + cover + ")" as Cover,
link(file.link, title) as Title,
author as Author,
join(list(publisher, publish)) as Publisher
FROM #📚Book
WHERE !contains(file.path, "Templates")
SORT status DESC, file.ctime ASC
The banner at the top of the document is rendered using [Obsidian-banners](https://github.com/noatpad/obsidian-banners) plugin.
<br>
## Template variables definitions
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:
| Field | Description |
| --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| title | The title of the book. |
| subtitle | The subtitle of the book; may be absent. |
| author | A comma-separated string containing the names of the book's authors, indicating that multiple authors can be represented within a single string. |
| authors | An array of strings, each element representing the name of one of the book's authors, indicating that multiple authors can be listed individually. |
| category | A comma-separated string indicating the book's category or categories, allowing representation of multiple categories within a single string. |
| categories | An array of strings, each representing a different category that the book belongs to, indicating that a book can fall into multiple categories. |
| description | Book description. |
| publisher | The publisher of the book. |
| totalPage | The total number of pages in the book. |
| coverUrl | Book cover image URL. |
| coverSmallUrl | A smaller book cover image URL. |
| localCoverImage | Local path for the downloaded cover image. Requires activation of "Enabling Cover Images." |
| publishDate | The year the book was published. |
| isbn10 | ISBN10 |
| isbn13 | ISBN13 |
<br>
## Advanced
### Inline Script
- The object "book" gives access to all attributes managed by the plugin.
- Using `<%= book %>` one can manipulate the different attributes, or use all attributes together.
#### To print out a book object:
<%=book%>
or
<%=JSON.stringify(book, null, 2)%>
#### When you want to list or link authors:
authors: <%=book.authors.map(author=>\n - ${author}).join('')%>
authors: <%=book.authors.map(author => [[${author}]]).join(', ')%>
#### When you want to list or link categories:
categories: <%=book.categories.map(category=>\n - ${category}).join('')%>
categories: <%=book.categories.map(category => [[${category}]]).join(', ')%>
#### When you want to isolate publication year
published_at: <%= book.publishDate.substring(0, 4) %>
#### When you want to have the publucation date under the format YYYYMMDD and not YYYY-MM-DD
published_at: <%= book.publishDate.replace(/-/g,'') %>
### How to add an API Key to bypass rate limits
If the plugin fails to fetch book metadata, it might be that you have hit the free API rate limits, and need to add an API key.
Here's how to create and use one:
- Create a project on [Google Cloud](https://console.cloud.google.com/projectcreate)
- Enable the Books API for your project using the [Books API page](https://console.cloud.google.com/apis/library/books.googleapis.com)
- Create an API key for your Google Cloud project using the [Google Cloud Credentials](https://console.cloud.google.com/apis/credentials) page
- To limit the security risks of losing that key, you can edit it, and click on "Restrict key" under "API restrictions", then select only the "Books API" API
- Add the API key to the settings of the Book Search plugin, under "Set API Key"
- Once added, click on "Save", then "API Check"
<br>
## License
[Obsidian Book Search Plugin](https://github.com/anpigon/obsidian-book-search-plugin) is licensed under the GNU AGPLv3 license. Refer to [LICENSE](https://github.com/SilentVoid13/Templater/blob/master/LICENSE.TXT) for more information.
<br>
## Contributing
Feel free to contribute.
You can create an [issue](https://github.com/anpigon/obsidian-book-search-plugin/issues) to report a bug, suggest an improvement for this plugin, ask a question, etc.
You can make a [pull request](https://github.com/anpigon/obsidian-book-search-plugin/pulls) to contribute to this plugin development.
<br>
## Support
If this plugin helped you and you wish to contribute :)
Buy me coffee on [buymeacoffee.com/anpigon](https://www.buymeacoffee.com/anpigon)
<a href="https://www.buymeacoffee.com/anpigon" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" height="60"></a>
<a href="https://anpigon.github.io/buymeacoffee/"><img src="https://user-images.githubusercontent.com/3969643/184924261-f0224843-08fa-4bce-af70-dc5db589979f.png" height="60"></a>