Bookmarks / Headings / TOC

Open
#52 5 comments 1 reaction 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
20/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
kotlin, sqlite
Domain
database, mobile

Research direction

Read the issue’s proposed bookmark workflow and its current data model: a separate SQLite database keyed by the top-left stroke ID, with bitmaps stored outside the database. Start by examining how strokes, pages, and notebooks are represented and how their IDs change when strokes are moved, duplicated, or cut. Done means bookmarks can be added, listed, opened across notebooks, and deleted without breaking when strokes are modified.

Written by the indexing model from the issue text.

Description

enhancement

nobody:

...

georghendrik:

What if we could like, mark handwriting in a notebook so we can quickly jump back to it?

georghendrik also:

You mean like bookmarks?

georghendrik:

Yes, or maybe table-of-contents / TOC, or todo's, depending on how you use it.

georghendrik also:

This needs a video

georghendrik:

https://github.com/user-attachments/assets/b7565990-ad16-4c10-889f-2ec19d9961ea

Features:

  • Bookmark any handwriting (strokes), by selecting it, then tapping the bookmark icon from the selection menu.
  • Open the bookmark list by tapping the bookmark button in the main toolbar.
  • Jump to any bookmark by tapping it from the bookmark list.
  • Works across notebooks.
  • Easy on the page cache: scrolls only if a bookmark is not visible.
  • Allows deleting bookmarks.

This is work in progress, and currently:

  • Bookmarks are kept in a separate sqlite database, at least until the data model feels okay to merge.
  • Bookmarks are modeled as (bookmarkId, top-left strokeId, bitmapUri). Pages, page number, scroll position, and notebooks are derived from the strokeId . This allows moving the stroke around the page without breaking the bookmark. Duplicating and cutting however, modifies the strokeIds and currently breaks the bookmark. Still working on that.
  • The bitmaps are stored outside of the database.

@Ethran I'm curious to your thoughts on this approach to bookmarks. If you are open to a pull request for this, let me know, happy to open one!

Dominant language
Kotlin
Stars
269
Forks
44
Avg merge
1d 17h
Merged PRs (30d)
22

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Ethran/notable

All issues in Ethran/notable

Similar issues

More Kotlin issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.