Skip to content

0.3.0

Choose a tag to compare

@github-actions github-actions released this 02 Nov 17:07
· 67 commits to main since this release
29aef89

Requires Obsidian 1.13.0 or later. The strings added in this release are machine translations into all 33 languages and wait for review by native speakers, especially Arabic, Persian, Hebrew, Bengali and Thai. See Fix or add a translation.

Added

  • Skip, confidence and "I know this".
    • Skip leaves a concept out of the route: it opens what depends on it but never counts as mastered, and the progress line counts it apart.
    • I know this and what it needs marks a concept with its unmastered prerequisites in one step. The list shows them in learning order, anything can be unticked, and one Undo reverts the batch.
    • An optional confidence from 1 to 5 can be set on mastered and learning concepts.
    • New commands skip the open note, return it to the route, and mark it known with everything it needs.
    • The progress file gains skipped and confidence-N lists, written only when used.
  • Materials without a note. A concept can list links and attachments in its materials property, with an optional title, format and duration. The same link in several concepts is one material, and a link that already has a material note is shown as that note. They count in the route time like any material, and finished ones go to done-materials in the progress file. Add material offers attachments from the vault, and the new material dialog can keep the link in the concept instead of creating a note.
  • Map scope. Settings leave whole folders and notes with certain tags out of the map: nested tags count, folders are matched by whole path segments. Links to an excluded note are dropped, so it blocks nothing, while progress marks stay in the file and come back with the note.
  • Focus and fold.
    • Focus (F, or the context menu) shows only what is near a concept: one to three steps both ways, soft links included, with their materials. Esc puts the map back where it was.
    • A badge under a concept folds away everything that needs it and then shows how many concepts it hides. Route steps hidden this way are marked in the route list, and picking one unfolds its branch.
    • Focus and folds are view state, kept with Obsidian's workspace layout.
  • Map audit.
    • The command Audit the map, and a button in the map's bar with the number of findings, open one list: dependency cycles as a chain back to their start, links to missing notes (with a button to create them), possible duplicate names (case and accents ignored), concepts without materials and notes with no links.
    • The button turns red when there is a cycle. Each row opens its note or shows it on the map.
  • Export. The map as it is drawn now, with focus and folds, can be saved to a JSON Canvas file or to SVG, from the bar or two commands.
    • The canvas points at your notes, keeps the positions and can be colored by progress (optional).
    • The SVG uses the current theme.
    • An existing file is never replaced without asking.

Changed

  • Own layout engine instead of dagre. On the benchmark graphs it draws with 15–26% fewer edge crossings and no edge through a node it does not belong to. Edges run straight down through each row and bend only between rows; soft links take part in ordering.
  • WebAssembly in a worker. Large maps (150 nodes and more) are laid out off the main thread by the engine's Rust port compiled to WebAssembly. It draws the same map to the last bit as the TypeScript engine, which stays as the fallback where WebAssembly or workers are unavailable.
    • The module is built from source in CI; its sha256 is printed in the release log and listed below these notes.
    • While a large map is laid out, the previous one stays on screen with a thin bar along the top.
  • Showing a note on the map (from the audit, the route list or a command) first turns on materials, opens folds or leaves the focus as needed, waits for the new layout, then centers the note.
  • Dashes when zoomed out. A map with more than 1000 edges drops the dashes of "teaches" and soft links when zoomed out, and soft links fade instead; smaller maps keep their dashes.

Performance

  • Layout time, in Chromium on the benchmark graphs (dense, synthetic):

    graph 0.2 (dagre) 0.3
    400 concepts 0.6 s 23 ms
    400 concepts with materials 5.7 s 0.16 s
    1000 concepts with materials 39.5 s 0.7 s

    The interface keeps responding meanwhile: the longest pause is under 20 ms.

  • Recently used layouts are kept by the shape of the graph, so switching between the route, the whole map and materials does not lay the map out again.

  • Changes on a large map repaint only what changed. On 1000 concepts with materials, a mark takes 20–36 ms instead of 58–108 ms: edges are no longer rebuilt, and the side panel no longer forces the page to lay out.

  • main.js is 724 KB (0.2.0: 364 KB). dagre is gone; the WebAssembly module adds 137 KB as base64, and the new features and their strings in 33 languages make up the rest.

Fixed

  • Maps zoomed out with thousands of dashed edges no longer freeze the browser for many seconds while it draws them.
  • When the note at the center of the focus is left out by the map scope or deleted, the focus closes and the map goes back to where it was. Before, the Focus button stayed pressed while the map already showed everything.
  • Folds follow changes of the map scope: the "+K" badge counts only what is still on the map, and a fold on a note that was left out is dropped.

Layout engine WebAssembly (inlined in main.js), sha256 a88682595bad6ac1378b5cd6017b37b0d1d93591b11d2f50eb48a1126214d4cc. Rebuild it from the source of this tag with npm run build:wasm.