Skip to content

Obsidian plugin that loads information from a glossary file into a sidebar

License

Notifications You must be signed in to change notification settings

echinopscis/obsidian-glossary-plugin

 
 

Repository files navigation

Obsidian Wikidata Sidebar Plugin

Load data from wikidata to a sidebar, using a direct text search or via mapped frontmatter properties.


Changelog

0.2.0

  • Use selected text as search input, if available (issue #3).
  • Add bracketed description text in entity selection list, if available (issue #4)
  • Correct display in select modal when called from frontmatter (shows full URL for entity id) (issue #5)
  • Bypass select modal if only one item found (issue #6)

0.1.0 Initial revision

Features

  • Specify frontmatter mappings (eg DOI - P356)
  • Specify frontmatter property that holds a wikidata entity ID (Q-number)
  • Simple text search
  • Navigation through linked wikidata entities in the sidebar
  • Links to external conent (to wikidata and using identifiers attached to an entity

Demo

TBC

Description

TBC

How to install

Download the zip file named "wikidata-sidebar-plugin.zip" attached to the latest release and unzip in under the .obsidian/plugins directory under your Obsidian vault.

How to use

1. To use frontmatter properties to retrieve associated wikidata entities

Click the ribbon icon 🌍, or excute the command "Wikidata sidebar: Load wikidata from frontmatter".

2. To search wikidata

Use the command "Wikidata sidebar: Search wikidata for sidebar".

3. Select the wikidata entity from the search results.

4. The entity will be loaded in a sidebar.

How to use settings

Frontmatter property mapping

By default this is:

{
  orcid: 'P496',
  doi: 'P356',
  ipni_name_id: 'P961',
  ihcode: 'P5858',
}

Frontmatter property for the wikidata entity ID

This defaults to wikidata_entity_id

License

Wikidata sidebar plugin is licensed under the MIT license. Refer to LICENSE for more information.


Contributing

Feel free to contribute.

You can create an issue to report a bug, suggest an improvement for this plugin, ask a question, etc.

You can make a pull request to contribute to this plugin development.

Credits

Sincere thanks to Toby Hudson (AKA 99of9) for his work on the browser plugin Entity Explosion which inspired this plugin, and to anpigon who developed the obsidian book search plugin which was used as the basis for this development.

About

Obsidian plugin that loads information from a glossary file into a sidebar

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Languages

  • TypeScript 88.2%
  • JavaScript 8.2%
  • CSS 1.8%
  • HTML 1.6%
  • Shell 0.2%