lkn
/
kdenote
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

README: update to reflect all features

This commit is contained in:
Levi Neely 2026-07-12 21:07:43 +02:00
parent 39e37cf602
commit 1387deed4a
1 changed files with 12 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -2,11 +2,13 @@
KDE integration plugins for [Denote](https://protesilaos.com/emacs/denote) notes. KDE integration plugins for [Denote](https://protesilaos.com/emacs/denote) notes.
## Components ## Features
- **Baloo extractor** — KFileMetaData plugin that indexes denote file metadata (title, tags, date, signature) so Dolphin search, KRunner, and Baloo queries work on your notes. - **Baloo extractor** — Indexes denote metadata (title, tags, creation date, signature) into Baloo. Enables Dolphin search, KRunner, and Baloo queries over your notes. Supports frontmatter extraction from Markdown, Org-mode, and plain text files.
- **Dolphin context menu** — "Rename with Denote..." action for files that don't yet conform to the denote naming scheme. - **New Denote File...** — Dolphin context menu action (right-click a directory). Creates a new note with the correct denote filename and frontmatter. Choose format: Markdown, Org-mode, or Plain Text.
- **Shared library** — Denote filename parsing/building and frontmatter handling (YAML/Org/txt), used by both plugins. - **Rename with Denote...** — Dolphin context menu action (right-click a non-denote file). Generates a denote-conformant filename, renames atomically, and injects/updates frontmatter.
- **Compound extension support** — Handles `.md.gpg`, `.org.age`, etc.
- **i18n** — Translatable UI. German translation included.
## Building ## Building
@ -14,20 +16,21 @@ KDE integration plugins for [Denote](https://protesilaos.com/emacs/denote) notes
mkdir build && cd build mkdir build && cd build
cmake .. -DBUILD_TESTING=ON cmake .. -DBUILD_TESTING=ON
make make
make install ctest
sudo make install
``` ```
### Dependencies ### Dependencies
- Qt 6 - Qt 6
- KDE Frameworks 6 (KFileMetaData, KIO, WidgetsAddons, ECM) - KDE Frameworks 6 (ECM, KFileMetaData, KIO, WidgetsAddons, I18n)
- C++20 compiler - C++20 compiler
## Configuration ## Configuration
If Baloo already indexes your home directory (the default), no configuration is needed — the extractor plugin activates automatically on the next index pass. No configuration required. The plugins activate based on filename pattern recognition — any file whose name starts with a denote identifier (`YYYYMMDDTHHMMSS`) is recognized, regardless of directory.
To immediately reindex existing notes after install: If Baloo already indexes your home directory (the default), the extractor works immediately. To reindex existing notes after install:
```sh ```sh
balooctl index /path/to/your/notes balooctl index /path/to/your/notes
@ -42,6 +45,7 @@ YYYYMMDDTHHMMSS[==signature]--slugified-title[__tag1_tag2].ext
Examples: Examples:
- `20240315T120000--my-daily-note__journal_daily.md` - `20240315T120000--my-daily-note__journal_daily.md`
- `20240315T120000==1a--project-plan__work.org` - `20240315T120000==1a--project-plan__work.org`
- `20260712T153000--encrypted-note__private.md.gpg`
## License ## License