diff --git a/README.md b/README.md index bb0348e..4de28fc 100644 --- a/README.md +++ b/README.md @@ -1,96 +1,85 @@ -# Obsidian Sample Plugin +# Entity Linker -This is a sample plugin for Obsidian (https://obsidian.md). +Entity linker is an Obsidian plugin links research terms to corresponding standard entities(wikidata, wikipedia, +openalex) -This project uses Typescript to provide type checking and documentation. -The repo depends on the latest plugin API (obsidian.d.ts) in Typescript Definition format, which contains TSDoc comments describing what it does. +### Usage -**Note:** The Obsidian API is still in early alpha and is subject to change at any time! +This plugin has two commands: -This sample plugin demonstrates some of the basic functionality the plugin API can do. -- Adds a ribbon icon, which shows a Notice when clicked. -- Adds a command "Open Sample Modal" which opens a Modal. -- Adds a plugin setting tab to the settings page. -- Registers a global click event and output 'click' to the console. -- Registers a global interval which logs 'setInterval' to the console. +1. `Link selection to entity`, which suggest entities using the selected text as search term. +2. `Link active note to entity`, which suggest entities using the active note's title as search term. -## First time developing plugins? +### Demo +#### Entity linking via selection as well as active note +![Entity linker demo ](demo/entity_linker.gif) -Quick starting guide for new plugin devs: +### How it works -- Check if [someone already developed a plugin for what you want](https://obsidian.md/plugins)! There might be an existing plugin similar enough that you can partner up with. -- Make a copy of this repo as a template with the "Use this template" button (login to GitHub if you don't see it). -- Clone your repo to a local development folder. For convenience, you can place this folder in your `.obsidian/plugins/your-plugin-name` folder. -- Install NodeJS, then run `npm i` in the command line under your repo folder. -- Run `npm run dev` to compile your plugin from `main.ts` to `main.js`. -- Make changes to `main.ts` (or create new `.ts` files). Those changes should be automatically compiled into `main.js`. -- Reload Obsidian to load the new version of your plugin. -- Enable plugin in settings window. -- For updates to the Obsidian API run `npm update` in the command line under your repo folder. +Plugins uses [OpenAlex](https://docs.openalex.org/) api to search for terms and create entity note for the same. -## Releasing new releases -- Update your `manifest.json` with your new version number, such as `1.0.1`, and the minimum Obsidian version required for your latest release. -- Update your `versions.json` file with `"new-plugin-version": "minimum-obsidian-version"` so older versions of Obsidian can download an older version of your plugin that's compatible. -- Create new GitHub release using your new version number as the "Tag version". Use the exact version number, don't include a prefix `v`. See here for an example: https://github.com/obsidianmd/obsidian-sample-plugin/releases -- Upload the files `manifest.json`, `main.js`, `styles.css` as binary attachments. Note: The manifest.json file must be in two places, first the root path of your repository and also in the release. -- Publish the release. +### Installation -> You can simplify the version bump process by running `npm version patch`, `npm version minor` or `npm version major` after updating `minAppVersion` manually in `manifest.json`. -> The command will bump version in `manifest.json` and `package.json`, and add the entry for the new version to `versions.json` +#### From github -## Adding your plugin to the community plugin list +1. Go to the [Releases](https://github.com/Ankush-Chander/obsidian-entity-linker/releases) page. +2. Download the latest obsidian-entity-linker-${version}.zip. +3. Extract its contents. +4. Move the contents into /your-vault/.obsidian/plugins/obsidian-entity-linker/. +5. Enable the plugin in Obsidian: + - Open Obsidian, go to Settings > Community Plugins. + - Make sure Restricted mode is off. + - Search installed plugins for entity-linker. + - Click Enable. -- Check https://github.com/obsidianmd/obsidian-releases/blob/master/plugin-review.md -- Publish an initial version. -- Make sure you have a `README.md` file in the root of your repo. -- Make a pull request at https://github.com/obsidianmd/obsidian-releases to add your plugin. +#### From within Obsidian -## How to use +You can install this plugin within Obsidian by doing the following: -- Clone this repo. -- Make sure your NodeJS is at least v16 (`node --version`). -- `npm i` or `yarn` to install dependencies. -- `npm run dev` to start compilation in watch mode. +1. Open Settings > Community plugins. +2. Make sure Restricted mode is off. +3. Click Browse. +4. Search for Entity Linker. +5. Click Install. +6. Once installed, click Enable. -## Manually installing the plugin +[//]: # (### Changelog) -- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`. +### For development -## Improve code quality with eslint (optional) -- [ESLint](https://eslint.org/) is a tool that analyzes your code to quickly find problems. You can run ESLint against your plugin to find common bugs and ways to improve your code. -- To use eslint with this project, make sure to install eslint from terminal: - - `npm install -g eslint` -- To use eslint to analyze this project use this command: - - `eslint main.ts` - - eslint will then create a report with suggestions for code improvement by file and line number. -- If your source code is in a folder, such as `src`, you can use eslint with this command to analyze all files in that folder: - - `eslint .\src\` +#### Compilation -## Funding URL +1. Clone this repo inside path/to/your/dev/vault/.obsidian/plugins. +2. npm i or yarn to install dependencies +3. npm run build to compile, or npm run dev to start compilation in watch mode. -You can include funding URLs where people who use your plugin can financially support it. -The simple way is to set the `fundingUrl` field to your link in your `manifest.json` file: -```json -{ - "fundingUrl": "https://buymeacoffee.com" -} -``` +### Roadmap -If you have multiple URLs, you can also do: +- [x] First release +- [ ] Add fuzzy logic +- [ ] Add direct search -```json -{ - "fundingUrl": { - "Buy Me a Coffee": "https://buymeacoffee.com", - "GitHub Sponsor": "https://github.com/sponsors", - "Patreon": "https://www.patreon.com/" - } -} -``` +### FAQs -## API Documentation +1. **Why is email(optional) asked in settings?** + We use OpenAlex API for fetching metadata. Their API is rate limited. If you add your email in the request, your + requests goes + into [polite pool](https://docs.openalex.org/how-to-use-the-api/rate-limits-and-authentication#the-polite-pool) which + has much faster and more consistent response times. -See https://github.com/obsidianmd/obsidian-api +### Recommendations + +1. [Obsidian Wikidata Importer](https://github.com/samwho/obsidian-wikidata-importer) pulls data from the Wikidata + database into your Obsidian notes +2. [Obsidian Wikipedia](https://github.com/jmilldotdev/obsidian-wikipedia) gets the first section of Wikipedia and + pastes it into your active note. + +### Acknowledgement + +1. Thanks to [OpenAlex](https://openalex.org/) team for providing free for use API over scholarly works +2. Thanks to [Obsidian](htts://obsidian.md]) team for upholding malleability in the product that allows people to add + and share new features + without hassle. diff --git a/demo/entity_linker.gif b/demo/entity_linker.gif new file mode 100644 index 0000000..8460abc Binary files /dev/null and b/demo/entity_linker.gif differ diff --git a/main.ts b/main.ts index 3902ece..113b389 100644 --- a/main.ts +++ b/main.ts @@ -132,16 +132,20 @@ export default class EntityLinker extends Plugin { }) } - async updateFrontMatter(file: TAbstractFile, entity_props: object,) { + async updateFrontMatter(file: TAbstractFile, entity_props: object, callback: () => void) { + console.log(typeof file) const overwrite_flag = this.settings.overwriteFlag if (file instanceof TFile) { await this.app.fileManager.processFrontMatter(file, (frontmatter) => { // set property if it doesn't exist or if overwrite flag is set + console.log(frontmatter) for (const [key, value] of Object.entries(entity_props)) { if (!frontmatter.hasOwnProperty(key) || overwrite_flag) { frontmatter[key] = value } } + console.log(frontmatter) + callback() }) } } @@ -157,19 +161,26 @@ export default class EntityLinker extends Plugin { // eslint-disable-next-line let entity_file = this.app.vault.getFileByPath(path) if (!entity_file) { - + console.log("file not found: " + path) // @ts-ignore - this.app.vault.create(this.settings.entityFolder + "/" + result.displayName + ".md", "", (new_file) => { - this.updateFrontMatter(new_file, entity_props) + this.app.vault.create(this.settings.entityFolder + "/" + result.displayName + ".md", "").then((new_file) => { + this.updateFrontMatter(new_file, entity_props, () => { + if (open_new_tab) { + this.app.workspace.getLeaf('tab').openFile(new_file) + } + }) + }, + () => { + console.log("failed to create file") + }) + } else { + this.updateFrontMatter(entity_file, entity_props, () => { if (open_new_tab) { - this.app.workspace.getLeaf('tab').openFile(new_file) + // @ts-ignore + this.app.workspace.getLeaf('tab').openFile(entity_file) } }) - } else { - this.updateFrontMatter(entity_file, entity_props) - if (open_new_tab) { - this.app.workspace.getLeaf('tab').openFile(entity_file) - } + } }) @@ -271,7 +282,7 @@ class EntityLinkerSettingsTab extends PluginSettingTab { containerEl.empty(); new Setting(containerEl) - .setName("Polite Email") + .setName("Polite email") .setDesc("Adding email to openalex API requests(for faster and more consistent response times)") .addText((text) => text