obsidian-occura-plugin README

The project's README from github.com/Krusty84/obsidian-occura-plugin. As one markdown file: README.md.

Occura Plugin: highlighting word occurrences

Why another plugin?

I couldn't find the usual functionality that I used in Notepad++ or different IDEs, where double-clicking on a word immediately showed me how often it appears in the open document.

Features

Release 1.6.3

Support for Obsidian color schemes has been added, thanks to dear werunom for the idea. image

image

Release 1.6.2

This release stabilizes occurrence matching and navigation across Source Mode, Live Preview, and Reading View. Counts now cover the complete note, Unicode word boundaries are supported, short selections are debounced, and permanent highlight/tag commands avoid protected Markdown regions.

Keyboard shortcuts are configured through Obsidian Settings → Hotkeys. Occura does not install global keyboard handlers or reserve built-in Find shortcuts.

Release 1.6.1

No new features. Some issues has been fixed.

Release 1.6.0

New features has been added:

  1. Dynamic occurrences highlighting, words classes highlighting now works in Reading View too, not only in Source or Live Preview mode
image

2. Added navigation between occurrences with new commands and configurable hotkeys: - Go to next occurrence - Go to previous occurrence image

image

3. Added support for highlighting repeated phrases with spaces, not only single words image

image

4. Added a context menu action to quickly add the selected word into an existing word class image

image

Release 1.5.1

No new features. Various minor issues with Obsidian's expansion quality rating system have been resolved, I hope. I'm preparing for more functionality, so stay tuned for updates.

Release 1.5.0

New features has been added:

  1. You can create classes of words with individual colors, for example terms from different domains, parasite words, etc
image

Release 1.4.1:

The issues with selecting special chartes like $ # % @ has beein fixed, thanks dear Logovaz26

Release 1.4.0:

New features has been added:

  1. Added case insensitivity mode for dynamic word selection

  2. Keywords can be uploaded/downloaded to/from a plain text file with a comma separator between words

  3. Added a reset button to default settings

image

Release 1.3.2:

Some bugs have been fixed, thanks dear BlackUdon

Release 1.3.1:

Some bugs have been fixed, thanks dear BlackUdon

Release 1.3.0:

Automatic highlighting of keywords (It works only in Source or Live preview mode!)

New settings has been added image

New command has been added

image

Release 1.2.0:

Convert found occurrences to tags (It works only in Source or Live preview mode!)

New command has been added

image

Release 1.1.0:

Permanent Highlighting for found occurrences (It works only in Source or Live preview mode!)

New command has been added:

  1. Set permanently highlight for occurrences
  2. Remove permanently highlight for occurrences

image

When Occura has highlighted the available occurrences, call the command: Set permanently highlight for occurrences and then the occurrences will be highlighted by the regular for Obsidian.md by color

image

And call the: Remove permanently highlight for occurrences command to remove the previously set highlight

Release 1.0.0:

Basic functionality

Installing the plugin

Manually installing the plugin

For platform and mode verification, see MANUAL_TESTING.md.

License

MIT

Author

Alexey Sedoykin

obsidian-occura-plugin (Krusty84/obsidian-occura-plugin)

Searching Database…

What is this?A community plugin for Obsidian that highlights every other occurrence of a word or phrase you double-click in the open note, so you can see how often it appears.
Is it a standalone app or something inside Obsidian?It is a plugin that runs inside Obsidian, not a separate program. You can install it from Community Plugins or copy its files into your vault manually.
How do I get it running?Open Obsidian settings, go to Community Plugins, choose Browse, search for Occura Plugin, install it and turn it on. For a manual install, copy main.js and manifest.json into your vault's .obsidian/plugins/obsidian-occura-plugin/ folder and enable it in Community Plugins.
Do I need anything besides Obsidian?No. The README mentions only Obsidian itself, with no extra services, accounts or API keys.
Does it work in every Obsidian view?Not entirely. Automatic keyword highlighting, permanent highlighting and convert-to-tag commands work only in Source or Live Preview mode. Word-class highlighting also works in Reading View since version 1.6.0.
Why did the author build this instead of using an existing tool?The author missed the Notepad++ and IDE habit of double-clicking a word to see how often it appears in the open document, and did not find an Obsidian plugin that did that.
Can I group words into colored classes?Yes. Since 1.5.0 you can create word classes with individual colors, for example for terms from different domains or filler words, and add a selected word to a class from the context menu.
Does it match phrases and ignore case?Yes. It highlights repeated phrases with spaces, not only single words, and has a case-insensitive mode. Keywords can be imported or exported as a comma-separated text file.
Can I turn found occurrences into permanent highlights or tags?Yes. Commands can set or remove permanent highlights for occurrences, and another converts found occurrences into tags, all in Source or Live Preview mode.
Creator
Krusty84
Size
0.3 MB
Stars
345
Age
2y
Commits · 90 Days