Repository navigation
0.21.0
Eight features: a start and end time on every page, scheduled backups, a documented file format with a JSON Schema, an interactive HTML export, a back-of-book index, a reusable signature and date stamp, a way back to the current slide and a strip of recent symbols; plus the review fixes carried over from 0.20. The notebook format moves to version 19 (page start and end times): the migration from version 18 is automatic, and 0.20 and older open a v19 notebook read-only and never overwrite it.
Start and end time on every page (#217) and document format 19
- Start and end time on every page (#217), document format 19. A page now remembers when the first ink or object was added to it and when the last one was. They show in the page header line (when the header is on), on the cards of the notebook map (tooltip, label and a quiet line under the thumbnail) and in Page information (Page started, Page last written). The new setting Show when a page was written (Pages > Header) hides them from the header and the map; the page information always shows them. A page written before this version has none until something is added to it. They are also the time base audio recorded with a page will use (M5).
- Document format v19. Pages get an optional
startAtandendAt(ms since 1970, written together, end not before start). The v18 to v19 migration only drops these keys from a v18 file, so large v18 files still open page by page; a lone, fractional, out-of-range or inverted pair is dropped and counted when read and refused when written; 0.20 and older open a v19 notebook read-only and never overwrite it. The times are upkeep, not an edit: they are stamped by the history after a command that adds ink or an element succeeded, have no undo step of their own, and Undo and Redo never move them. A duplicated page, a template and a page made from one start without times; a page moved to another notebook or restored from the page trash keeps them; restoring an old version keeps the earliest start and latest end. A merge of conflicted copies takes the earliest start and the latest end and never stamps the moment of the merge. Repair keeps a valid pair and resets an invalid one. Seedocs/architecture.md, Page start and end time, format v19.
Scheduled backups (#127)
- Scheduled backups (#127). Settings > Sync & safety has Scheduled backups (off by default, every day or every week), Backup folder (a vault folder, default
Notebook backups; point your own sync tool at it to copy the zips elsewhere) and Backups to keep (default 5), and a Back up now row that shows the time and result of the last backup; the command palette has Back up the notebooks now. A backup is oneNotebook backup YYYYMMDD-HHmmss.zipwith every notebook file, the_assetsand_metafolders and the templates, read as they are on disk after the open notebooks were saved; the trash, the_backupcopies and the backup folder itself are left out. While Obsidian is open the schedule is checked a minute after start-up, every half hour and when the app returns to the foreground; a backup made by another device and synced here counts. It waits for the pen, reads in short slices with a progress notice, runs one at a time, writes under a temporary name, checks the size, renames, and only then trashes the older plugin-written backups beyond the number to keep (through Obsidian's trash, and only files that carry the plugin's exact backup name; the newest complete backup is never trashed to make room for partial ones). A file that cannot be read (a notebook still arriving from the sync client) is skipped and the backup is markedpartial. A failed run leaves the older backups as they were and the next try waits an hour. The folder is not part of the library, the shared-files inbox or the companion notes. No format change; no Drive and no folder outside the vault (the plugin has no Node or Electron access); the zip is built in memory, so a vault above 64 MB on a phone or tablet (1 GB on a computer) is refused with a message. Own STORE-only zip writer and strict reader insrc/model/zip.ts(no library, no licence to record), rules insrc/storage/backup-logic.ts, one run insrc/storage/backup-run.ts, Obsidian wiring insrc/storage/backup-service.ts. Tests:tests/zip.test.ts,tests/backup-logic.test.ts,tests/backup-run.test.ts,tests/backup-wiring.test.ts.
Documented format with a JSON Schema (#167)
- Documented format with a JSON Schema (#167). New
docs/schema/notebook-v19.schema.json(JSON Schema draft 2020-12, format 19, with the page timesstartAtandendAt) describes the.notebookfile exactly as the plugin writes it: document, meta, pages, strokes, all nine element types, comments, states, slides, groups and locks, every optional field, enum and limit. Newdocs/format.mdis the guide for third-party tools: file layout, versioning and migration policy, how to read leniently, the_assetsand_metafiles, a minimal example. A test validates real serializer output (a document that uses every element type and optional field) against the schema with a small dependency-free validator, and checks that invalid documents are refused. No format change and no runtime change.
Interactive HTML export (#164)
- Interactive HTML export (#164). Export… has a new format, Interactive HTML: one self-contained
.htmlfile (whole notebook, this page or some pages, ink and background choices and Clean copy as in the other formats) that opens in any browser without Obsidian. Each page is the inline SVG of the SVG export, with a small vanilla-JS viewer: page strip, wheel and pinch zoom, pan, fit width, keyboard navigation, light and dark by the system theme, links to pages of the notebook ([[Name#p3]]) that jump inside the file and web links that open normally. Pictures are embedded up to about 32 MB (a notice says how many were left out); a Content-Security-Policy forbids any network request; titles and text are escaped. The page strip fills its thumbnails only as they scroll into view (a 500-page file opens at once), and printing the file prints every page, one per sheet. Written next to the notebook, never over an existing file; built one page at a time. No format change. Pure builder insrc/ink/export-html.ts, writer insrc/view/export.ts. Tests:tests/export-html.test.ts. Harness:dev/harness/htmlexport-check.ts(doc=htmlexport).
Back-of-book index (#187)
- Back-of-book index (#187). Add to index… (selection bar and sheet) turns the lasso selection into an ordinary star marker labelled
#idx <term>; Back-of-book index… (page sheet, notebook menu, command palette) lists the terms A-Z with a page chip each (a tap goes to the page), sub-terms writtenTerm / Subtermnest, equal terms merge whatever the case or accents, and Write to note writes the list to<Notebook> — Index.mdnext to the notebook (only the generated region is rewritten; a note of yours without the markers is left untouched). Settings, Reading: Index term prefix. No format change. Pure logic insrc/model/book-index.ts, dialogs insrc/view/book-index.ts. Tests:tests/book-index.test.ts. Harness:dev/harness/bookindex-check.ts(doc=bookindex).
Reusable signature and date stamp (#154)
- Reusable signature and date stamp (#154). Sign and date (page sheet, Insert; command palette) opens a dialog with your saved signature. Draw signature opens a pad (finger, S Pen or mouse; undo, clear) and saves it as the personal stamp "My signature", so it syncs with the vault and shows in the stamp palette; no format change. Place puts the signature, scaled to a standard width, and today's date under it where the pen last touched (or the middle of the page in view) as one undo step; the items share one fresh group so they move together, a locked page refuses it. The date follows two new settings (Writing, Advanced): Signature date format (your language, ISO, custom) and Custom signature date pattern. Pure logic in
src/ink/signature.ts, storage insrc/storage/signature.ts, dialogs insrc/view/sign-dialog.ts. Tests:tests/signature.test.ts. Harness:dev/harness/signstamp-check.ts(doc=signstamp).
Back to the current slide (#225)
- Back to the current slide (#225). While lecture mode is on (or when you write beside a linked slide), the notebook remembers the place you last wrote. Scroll half a screen or more away from it and, once the scroll stops, a small pill at the top of the view offers the way back: Back to slide N (the PDF page or linked slide) or Back to current page, with an arrow towards it. Tapping it returns like a jump from the notebook map (recorded in the back history) and puts the written line near the middle of the view; the pill can be closed and comes back after you return and leave again. The command Back to the current slide or page does the same (no default hotkey). New setting Back to the current slide (Study, Timetable; on). The place lives in memory only: no format change, nothing written. Pure logic in
src/model/slide-back.ts, the pill insrc/view/slide-back.ts. Tests:tests/slide-back.test.ts. Harness:dev/harness/slideback-check.ts(doc=slideback).
Recent symbols (#212)
- Recent symbols (#212). A strip at the top of the page area with the symbols you use most: typographic ones (∀ ∃ ∫ → ⇒ ≠ ≤ …) and signs you saved with Save selection as symbol. Tap one, then tap the page: a character becomes a text box, a saved sign is drawn about one line high in the current pen colour and width (one group, one undo step, fresh ids). Ordered by use with decay (a use counts half as much after two weeks); counts stay on the device. Symbols are small personal stamps, so there is no format change. Settings, Writing: Recent symbols and Symbols shown.
Review fixes
- Dropped files are never trashed after a recorded change. Once the History has recorded a drop, the steps that follow (layout refresh, page navigation, scrolling to the page) can no longer make the edit report a failure, so the files the notebook already references are never moved to the trash; a failing step is logged.
- Heading pictures: edited pictures are recognised better. The checksum of a heading picture now covers every chunk except text and time (so a gamma, colour-profile or transparency edit counts as the user's edit, not only a change of the pixels). Pictures written by 0.20 (image-data checksum) are still recognised.
- Heading pictures: no silent drop when the names run out. Up to 24 names are tried; if all are taken, the previous picture stays linked in the companion note and one notice per session explains why.
- Reference window keeps its page. When the lending pane switches to another notebook or closes, the window reads the file and keeps its current page if it still exists, instead of jumping to page 1.
- Heading pictures: narrower overwrite window. A stale picture of ours is rewritten only if the file's size and time are still the ones probed, checked right before the write; otherwise the picture takes a new free name.
- Backups never lose the backup just written. The retention always keeps the zip a run has just made. A backup whose name is dated more than a day ahead (a device with a wrong clock) counts as the oldest instead of pushing the new one out, so Backups to keep: 1 can no longer leave you with no current backup.
- Backup folder cannot hide your notebooks. The folder is refused (a notice, the previous folder stays) when it is the notebooks folder, holds it, sits inside it (
_assetstoo), overlaps a templates folder or holds notebook files. A run with such a folder, or one whose plan has no notebook although the vault has some, now ends as failed instead of "ok" with nothing in it. Settings synced from another device fall back to the default folder. - Backups: old files are trashed only when they are ours. Before an old backup goes to the trash, the plugin reads the zip comment it wrote; a file you copied there under a backup's name is left alone. A leftover temporary file is removed only when it carries the mark or this device wrote it.
- Backups of a notebook that is being saved. The size and time of a notebook are checked before and after it is read; if they changed (an autosave overlapped) it is read once more, and a file that keeps changing is skipped and the backup is marked partial, instead of storing a cut-off copy as complete.
- Backups on phones and tablets. The limit is now 64 MB (the zip needs about twice that in memory); a vault over the limit fails with "too large for one backup on this device" and nothing is read. Computers keep 1 GB.
- Index note belongs to one notebook. The generated region of a "Notebook — Index" note records the notebook it was written for. Another notebook whose name collapses to the same file name (for example
Bio 1andBio 1) writes to… — Index (2).mdinstead of replacing the first one's list. - Heading pictures stay intact on devices still on 0.20. New pictures also carry the 0.20 checksum, so a device that has not updated no longer treats them as edited and piles up numbered copies. When all names are taken, the other names are not read again in the same session.
- A recorded step is always saved. The save is scheduled before the layout and viewport refresh that follow a change, so a refresh that fails can no longer leave a recorded step unsaved.
- Page times (format v19), review round. Undoing a merge no longer loses a stamp made after it: the merge's page-times step undoes only while the times are still what it set, and redo widens the current times, so the end stays at or after every ink on the page. A copy that differs from the notebook only by a page's start or end now counts as a change to merge (the dialog, the Merge button and recovery agree, and recovery keeps the widest span). Clock readings before 2015 or after 2100 (a device that booted without network time) are ignored when stamping. Editing the text of an element (text box, sticky note, marker, box title, equation, checkbox label) now moves the page's last-written time; moving or restyling does not, and ink moved in from another page, or made from an equation, no longer stamps the page it lands on. The stamp runs after the step is recorded and is guarded, so a clock error never costs an undo step. Comments in
page-times.tsmatch the behaviour. - Index note keeps its notebook. The index note now also records the notebook's document id, so renaming or moving the notebook and its folder no longer leaves the note behind and starts a numbered copy; a note whose recorded path is gone is taken back at the notebook's own index name. Older markers still work.
- Backups. An old backup larger than this device's cap is never read or trashed (a phone no longer loads a desktop backup to check it). The per-device
_metafiles get the same changed-while-read check as notebooks. - Backup folder setting. The folder is checked and saved when you finish typing, not on every keystroke, so a refused name no longer leaves a half-typed folder behind. The retention text says plainly that a plugin backup in that folder is trashed when it is old.
- Heading pictures. When every picture name is taken, the old picture that stays linked is no longer remembered as current, so a name you free is used on the next write.