From b31a153f3c77c8996631ba68542c24a6aefe72bc Mon Sep 17 00:00:00 2001 From: jun6lee Date: Sat, 15 Jul 2023 02:28:42 +0530 Subject: [PATCH 01/10] Update README.md Tidying to match other plugins --- README.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 4c40d29..c5a020a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Obsidian ibook Plugin +# Obsidian iBooks Plugin It allows you to export your mac ibook hightlights and annotations into your obsidian vault. @@ -8,9 +8,9 @@ It allows you to export your mac ibook hightlights and annotations into your obs # Attention -- If you want to use highlighted text's color from ibook, use [this template](https://github.com/bingryan/obsidian-ibook-plugin/blob/master/docs/example.md#ibook-selected-colors) +- If you want to use highlighted text's color from iBook, use [this template](https://github.com/bingryan/obsidian-ibook-plugin/blob/master/docs/example.md#ibook-selected-colors) -# Requirements(exists default) +# Requirements (exists default) The data of mac ibook exists in local sqlite3. and this plugin select database use the local SQLite3 @@ -20,17 +20,17 @@ brew install sqlite3 # How to Use -### export all +### Export All -`cmd + p` and input `ibook export` +`cmd + p` and input `iBooks Export` -### export single book by search +### Export a Single Book by Searching Your Library -`cmd + shift + b` and search by `book name/author` +`cmd + shift + b` and search by `Book Title or Author` ![](docs/images/screenshot-3.png) -### export book info by search [goodreads](https://www.goodreads.com/) +### Export Book Info by Search [goodreads](https://www.goodreads.com/) `cmd + shift + i` use file name to search book info, and insert current cursor position @@ -38,21 +38,21 @@ brew install sqlite3 # Features -[✓] support export by search book name/author +[✓] Support Export by Search Book Name/Author -[✓] export ibook hightlights and annotations into your obsidian vault. +[✓] Export iBooks hightlights and annotations into your Obsidian vault -[✓] user-defined template +[✓] User-defined Template Option (Default Provided) -[✓] search book info by [goodreads](https://www.goodreads.com/) +[✓] Search book info by [goodreads](https://www.goodreads.com/) [✗] More... # For User-Defined Templates -1. templating language: [https://handlebarsjs.com/](https://handlebarsjs.com/) - 1. built-in loaded [handlebars-helpers](https://github.com/helpers/handlebars-helpers), [handlebars-group-by](https://github.com/shannonmoeller/handlebars-group-by) -2. available parameters: [docs/parameters.md](docs/parameters.md) +1. Templating Language: [https://handlebarsjs.com/](https://handlebarsjs.com/) + 1. Built-in Loaded [handlebars-helpers](https://github.com/helpers/handlebars-helpers), [handlebars-group-by](https://github.com/shannonmoeller/handlebars-group-by) +2. Available Parameters: [docs/parameters.md](docs/parameters.md) If you don't know how to use these, you can visit [example](docs/example.md), and anyone is welcome to provide templates by PR @@ -64,6 +64,6 @@ you can activate this plugin within Obsidian by doing the following: - Open Settings > Third-party plugin - Make sure Safe mode is **off** - Click Browse community plugins -- Search for "Obsidian ibook" +- Search for "Apple iBooks Highlight and Note Importer" - Click Install - Once installed, close the community plugins window and activate the newly installed plugin From 3b3c4447cab6ab09322dcadfe18aa511fcd66a07 Mon Sep 17 00:00:00 2001 From: jun6lee Date: Sat, 15 Jul 2023 02:34:57 +0530 Subject: [PATCH 02/10] Delete styles.css Not needed --- styles.css | 5 ----- 1 file changed, 5 deletions(-) delete mode 100644 styles.css diff --git a/styles.css b/styles.css deleted file mode 100644 index 32a4b0c..0000000 --- a/styles.css +++ /dev/null @@ -1,5 +0,0 @@ -/* -This CSS file will be included with your plugin, and -available in the app when your plugin is enabled. -If your plugin does not need CSS, delete this file. -*/ From bd7d6a257fc1fa11b848bc5658e80baac3855b9a Mon Sep 17 00:00:00 2001 From: jun6lee Date: Sat, 15 Jul 2023 02:41:34 +0530 Subject: [PATCH 03/10] Update package.json --- package.json | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/package.json b/package.json index 9a73662..38dfcb4 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "obsidian-ibook-plugin", - "version": "1.0.4", - "description": "plugin for apple ibook.", + "version": "1.0.5", + "description": "Plugin to import Highlight and Notes from Apple iBooks.", "main": "main.js", "scripts": { "dev": "node esbuild.config.mjs", @@ -16,7 +16,8 @@ }, "keywords": [ "obsidian", - "ibook" + "apple", + "iBooks" ], "author": "bingryan", "license": "MIT", From d07c9f2ffd39bcaa0315446d1f5f1963635d3c19 Mon Sep 17 00:00:00 2001 From: jun6lee Date: Sat, 15 Jul 2023 02:50:58 +0530 Subject: [PATCH 04/10] Update manifest.json --- manifest.json | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/manifest.json b/manifest.json index 7243bcd..b691a40 100644 --- a/manifest.json +++ b/manifest.json @@ -1,10 +1,10 @@ { - "id": "ibook", - "name": "ibook", + "id": "apple-ibooks-highlighter", + "name": "Apple iBooks Highlight and Note Importer", "version": "2.0.10", "minAppVersion": "0.15.0", - "description": "plugin for apple ibook.", + "description": "Plugin to import Highlight and Notes from Apple iBooks.", "author": "bingryan", "authorUrl": "https://github.com/bingryan", "isDesktopOnly": true -} \ No newline at end of file +} From e21b2f77f1e2d5f2f371b20e239f6f9dad644b67 Mon Sep 17 00:00:00 2001 From: jun6lee Date: Sat, 15 Jul 2023 02:53:16 +0530 Subject: [PATCH 05/10] Update CHANGELOG.md --- CHANGELOG.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9532b38..59a3682 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +# 2.0.11 (Sat July 15 2023) + +#### 🐛 General Hygeine Cleanup + +- fix: Readme and Field text. + # 2.0.10 (Thu May 25 2023) #### 🐛 Bug Fix From f6bbd4b48987abc84040cbb19ab0f407a83ada40 Mon Sep 17 00:00:00 2001 From: jun6lee Date: Sat, 15 Jul 2023 02:53:41 +0530 Subject: [PATCH 06/10] Update manifest.json --- manifest.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/manifest.json b/manifest.json index b691a40..bda89b2 100644 --- a/manifest.json +++ b/manifest.json @@ -1,7 +1,7 @@ { "id": "apple-ibooks-highlighter", "name": "Apple iBooks Highlight and Note Importer", - "version": "2.0.10", + "version": "2.0.11", "minAppVersion": "0.15.0", "description": "Plugin to import Highlight and Notes from Apple iBooks.", "author": "bingryan", From 877579f88fffa8517a54bfda0e38b983c51ae5ca Mon Sep 17 00:00:00 2001 From: jun6lee Date: Sat, 15 Jul 2023 03:12:54 +0530 Subject: [PATCH 07/10] Update search.ts --- src/ui/search.ts | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/ui/search.ts b/src/ui/search.ts index 6921962..ad203b6 100644 --- a/src/ui/search.ts +++ b/src/ui/search.ts @@ -41,11 +41,11 @@ export class IBookSearchModal extends IbookFuzzySuggestModal { this.setInstructions([ { command: "↵", - purpose: "to export select book note", + purpose: "to export selected book to a note", }, { command: "esc", purpose: "to dismiss" }, ]); - this.setPlaceholder("Search by book's title or author"); + this.setPlaceholder("Search by Book's Title or Author"); } onChooseItem(item: LibraryAsset, evt: MouseEvent | KeyboardEvent): void { @@ -89,7 +89,7 @@ export class GoodReadBookFuzzySuggestModal extends FuzzySuggestModal Date: Sat, 15 Jul 2023 03:27:24 +0530 Subject: [PATCH 08/10] Update settings.ts Tidy Text --- src/settings.ts | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/src/settings.ts b/src/settings.ts index 75d62c8..e9465e1 100644 --- a/src/settings.ts +++ b/src/settings.ts @@ -16,17 +16,17 @@ export class IbookSettingTab extends PluginSettingTab { display(): void { const { containerEl } = this; containerEl.empty(); - containerEl.createEl("h1", { text: "Obsidian ibook" }); + containerEl.createEl("h1", { text: "Obsidian iBooks Plugin" }); containerEl.createEl("p", { text: "Created by " }).createEl("a", { text: "bingryan 🤓", href: "https://github.com/bingryan", }); - containerEl.createEl("h2", { text: "Obsidian ibook Settings" }); + containerEl.createEl("h2", { text: "Settings" }); new Setting(containerEl) - .setName("Custom default output path") - .setDesc("default directory for ibook note export") + .setName("Custom Default Highlight Path") + .setDesc("Highlights and Notes will be placed here.") .addText((text) => text .setPlaceholder("Enter default output path") @@ -38,9 +38,9 @@ export class IbookSettingTab extends PluginSettingTab { ); new Setting(containerEl) - .setName("Not export no annotation book") + .setName("Omit books with zero annotations") .setDesc( - "When the book has no annotations, it will not be exported" + "When a book has no annotations, note will not be created" ) .addToggle((toggle) => toggle @@ -52,9 +52,9 @@ export class IbookSettingTab extends PluginSettingTab { ); new Setting(containerEl) - .setName("backup old export markdown when exist") + .setName("Backup old highlights if they exist") .setDesc( - "if a export book with the same name is found, the previous export markdown will be backed up: bookname.md -> bookname.bk.time.md" + "If any previously imported highlights .md exist, they will be backed up as: bookname.md -> bookname.bk.time.md" ) .addToggle((toggle) => toggle From 9b67f512fb16da0d5755a035e957e8b4d75b1795 Mon Sep 17 00:00:00 2001 From: jun6lee Date: Sat, 15 Jul 2023 03:30:57 +0530 Subject: [PATCH 09/10] Update plugin.ts --- src/plugin.ts | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/plugin.ts b/src/plugin.ts index 5a64666..2aef051 100644 --- a/src/plugin.ts +++ b/src/plugin.ts @@ -24,8 +24,8 @@ export default class IbookPlugin extends Plugin { this.export = new IBookExport(this.settings, this); this.addCommand({ - id: "export all", - name: "ibook export all", + id: "Export All Highlights", + name: "Export all highlights from iBooks", callback: () => { this.export.all(); }, @@ -33,7 +33,7 @@ export default class IbookPlugin extends Plugin { this.addCommand({ id: "export-by-search", - name: "export by search", + name: "Export by Search", hotkeys: [{ modifiers: ["Mod", "Shift"], key: "b" }], callback: () => { tryCreateFolder(this, this.settings.output); @@ -44,7 +44,7 @@ export default class IbookPlugin extends Plugin { this.addCommand({ id: "insert-annotion-by-search", - name: "insert annotion by search", + name: "Insert Annotion by Search", hotkeys: [{ modifiers: ["Mod", "Shift"], key: "i" }], editorCallback: (editor) => { this.handleIbookAnnotationForActiveFile(editor); From e6a7c03fc8a387bba266fff9f8296b9f5d45f27d Mon Sep 17 00:00:00 2001 From: jun6lee Date: Sat, 15 Jul 2023 03:39:54 +0530 Subject: [PATCH 10/10] Update config.ts --- src/config.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/config.ts b/src/config.ts index 1416896..9924d5c 100644 --- a/src/config.ts +++ b/src/config.ts @@ -48,7 +48,7 @@ tags: ` export const DEFAULT_SETTINGS: IbookPluginSettings = { - output: 'ibook', + output: 'apple-ibooks-highlighter', notExportNoAnnotation: true, backupWhenExist: true, template: defaultTemplate