Skip to content

Releases

0.5.9

Choose a tag to compare

@github-actions github-actions released this 12 Nov 22:07

ScholarWeft 0.5.9 refines linked citations, literature-note updates, and bibliography search.

Linked citations

The narrative form no longer needs a space before its dash: [[@key|@-]] is now the same as [[@key|@ -]], and it works with a locator ([[@key|@-, p. 6]]). A lone - is now shorthand for the suppress-author form: [[@key|-]] is the same as [[@key|-@]]; for a suppressed-author citation with a locator, keep using [[@key|-@, p. 6]]. Both forms work in live preview, reading mode, and export. The linked-citation syntax guide has the updated table.

Literature notes

Manual “Update this literature note” now fetches the item’s current children instead of trusting a cached snapshot, so annotations removed in Zotero are actually removed from the note. Automatic updates now ignore Zotero’s lastRead attachment marker when a PDF is opened, including when the children snapshot is missing or stale, so viewing a PDF does not rewrite the note.

Literature notes now receive one default alias — Author - year - Short Title (or the title when there is no creator) — rather than three. Add further aliases by hand if you want them.

When the “Add literature notes/citations” modal is set to Citations, it now honours the same Insert a literature note whenever a linked citation is inserted preference as the @ popup. Missing notes are created quietly; existing notes are left alone.

Bibliography and search

“Refresh bibliography” now merges Zotero’s delta and rebuilds the citation engine without clearing the loaded library, so search remains available while it runs. If the delta finds no changes, it retries with a full fetch but still keeps the existing cache in place until the replacement is ready. Returning to Obsidian from Zotero now also handles a focus event that arrives before the window reports focus, so the incremental refresh is less likely to be skipped.

Validation

All 1,163 tests pass, the TypeScript check is clean, and lint reports 0 errors.

0.5.8

Choose a tag to compare

@github-actions github-actions released this 03 Nov 22:39

ScholarWeft 0.5.8 is a follow-up to 0.5.7: it fixes author-note cleanup and placement, removes Zotero tags from author related lists, and adds a title text colour for the YAML formatting addon.

Author notes

The Unassigned placeholder that Templater's basic note template adds is now removed reliably after the template settles, so a new author note no longer keeps an up: "[[Unassigned]]" entry. The cleanup retries as the file is written instead of racing the create event.

Author pages now migrate once to the default section order: # Overview (AI generated) first, then # Publications, then your own sections. A new Place new Publications sections setting controls where a first-time # Publications region goes — after the AI overview (default), at the top, or at the end. Existing regions are left where you put them and are not moved on later updates; only a first insertion and the one-time migration use the setting.

Template-only duplicates are tidied up. If a note with up: "[[Authors]]" sits outside the Authors folder and a same-named author page already exists inside it, the outside copy is removed only when its body contains nothing but the managed template output. A duplicate with an AI overview or your own text is preserved.

The author related list now contains only the works that list the person as a creator. Zotero item tags are deliberately not copied into it, so article keywords no longer turn the list into a keyword dump.

YAML properties

The Format YAML properties addon has a new Title colour picker for the title and short-title text. It is separate from the title background, so a light text colour can be used on a dark background. The colour is applied to the inner metadata editor as well as its container, which is where Obsidian actually paints the text.

Documentation

The author notes and setup guides describe the new placement setting, the title colour control, and the duplicate cleanup.

0.5.7

Choose a tag to compare

@github-actions github-actions released this 03 Nov 20:37

ScholarWeft 0.5.7 adds author-note pages and optional AI overviews, plus literature-note and reference improvements.

Author notes

Creator links in literature notes can now become real author pages. Clicking an unresolved [[Last, First]] link fills an empty note from the author template; existing notes can be merged into the Authors folder with Merge existing author notes. Author pages now use a title: "First Last" property instead of an H1 author-name heading, and their managed bibliography section is # Publications. Entries in that section link to their literature notes while keeping the note's normal text formatting rather than the theme's link colour and underline.

Link author name as a variant connects an alternate creator name to a main author page. It adds the name to the main note's plain-text variants, generates convenient aliases, rewrites creator links to [[Main|Variant]], and moves the old author note to the trash. Variants and creator names are matched with punctuation, spacing, case, diacritics and ʿayn/hamza normalization; name order remains significant. New Zotero items update author related properties, while imported literature notes update the Publications list, without replacing existing related material. A main author page no longer needs to match a Zotero creator name if its variants do, so existing people notes such as BN can be promoted with up: "[[Authors]]".

AI overviews

A new AI overviews settings page holds the shared OpenAI-compatible LLM configuration: base URL, model (default gemini-3.1-flash-lite), API key, and independent enable/prompt settings for author and work overviews. The default author prompt asks for an 80-word scholarly blurb plus relevant links; the default work prompt asks for a 50-word overview and builds its reference through ScholarWeft's existing CSL reference renderer. Both commands open a modal containing the entire editable prompt, including the author/works or work reference, and insert an unmanaged # Overview (AI generated) section at the top of the note.

Literature notes and references

Clicking an unresolved [[@citekey]] now imports the matching item and replaces the empty link stub, when the citekey exists in the loaded Zotero cache. Literature-note updates can recover when a Zotero item was re-created and its stable item key changed, by falling back to the note's own citekey. Numeric volumes values are written as numbers rather than quoted strings, avoiding Obsidian's property warning.

Settings

The new AI overviews page sits alongside Author notes and Literature note import. Author-note link creation, the author folder, template, merge, and variant controls remain on Author notes; literature-note import, the new unresolved-citekey import toggle, and automatic update controls remain on Literature note import.

The documentation and release notes have been updated for the new pages, commands, and template output.

0.5.6

Choose a tag to compare

@github-actions github-actions released this 29 Oct 23:11

ScholarWeft 0.5.6 is a one-fix release.

Citation popup

The @ search popup now closes as soon as you finish a citation with ] — [[@smith2005]], [[@smith2005|see @, p. 10]], or a plain [@smith2005]. Before, the @ inside the finished citation was still treated as an active search, so the popup hung around until you typed a period. A period still closes it, as do Escape and moving the cursor away.

The only other change is that the searching documentation now says so.

0.5.5

Choose a tag to compare

@github-actions github-actions released this 27 Oct 20:46

ScholarWeft 0.5.5 gives Zotero annotation callouts their own sw- namespace, scopes the plugin's stylesheet to its own material, and fixes two long-standing annotation-rendering bugs.

Annotation callouts

Annotations are now generated as [!sw-annotation sw-yellow sw-highlight], with [!sw-excerpt sw-highlight-text] inside and [!sw-comment] for comments. The old ids ([!yellow-highlight-annotation], [!ann-highlight-text-yellow]) were built by string concatenation, so any other plugin that put “annotation” in the same place could be caught by ScholarWeft's CSS — Midad's [!mas-annotation-*] bullet lists, for instance, were being rendered as coloured chips. The new ids are prefixed with sw-, which makes that collision impossible, and the inner excerpt no longer repeats the colour because it inherits it from the outer callout.

If you have existing annotation notes: they keep the old ids and will show without the annotation styling until they are regenerated. Run Update all literature notes in the vault once after updating; Zotero-driven auto-updates also refresh them as items change.

Stylesheet

  • Every annotation variable and CSS function is now --sw--prefixed (--sw-hue, --sw-yellow…, --sw-annot-*, --sw-light/--sw-bright/--sw-dark). The old bare names could collide with a theme or another plugin; Midad had been borrowing --gold and --bright() without defining them.
  • The three global SVG presentation properties are gone from :root — they applied to every SVG in the app, not just callouts.
  • .csl-entry and .csl-entry-wrapper are citeproc's classes (ZotLit and other reference plugins emit them), so they keep their names, but every rule is now scoped to ScholarWeft's own containers.
  • The obsolete .hl-* custom-highlight rules are removed; Obsidian's native highlight colours (==🟢text==) do that job now.

Fixes

  • Text-comment callouts render again. [!sw-excerpt sw-text]Text comment… needed a space after the closing bracket; without it Obsidian treated the block as an ordinary quote rather than a callout.
  • Annotation icons are correct on first load. Obsidian sets a callout's icon once, when it renders; a note restored at startup could render before the plugin's stylesheet was in effect and keep the default pencil. The plugin now re-applies the computed icon when the layout is ready and when a note is opened.
  • All annotation icons share one colour — the same blue — while each annotation kind keeps its own glyph. Highlight icons previously inherited the pale highlight accent and looked white.
  • Icon values are no longer quoted, so --callout-icon resolves exactly as documented.

Under the hood

Callout selectors now use prefixes and suffixes (^="sw-annotation-", $="-sw-image") instead of substring matches on “annotation” and “ann-”, and the annotation colour variables only apply inside ScholarWeft's own callouts. The stylesheet no longer styles citeproc output outside ScholarWeft's panels.

0.5.4

Choose a tag to compare

@github-actions github-actions released this 15 Oct 14:12

ScholarWeft 0.5.4 clears 26 more of the community directory's review findings — and fixes a packaging bug that made a fresh clone impossible to build.

The review, continued

The directory re-scanned 0.5.3 and moved the plugin from one bar to two ("Caution"), reporting 111 issues, down from 1720, none of them errors. This release clears 26 of the 31 TypeScript ones. The rest are almost all CSS notices about the plugin's own citation-underline styling, which the scanner marks "only partially supported" even though every property involved works in every Obsidian version the plugin supports.

  • Five unsafe-any findings, one root cause. @codemirror/language was listed under devDependencies — pinned to a git+ssh:// fork — while its siblings (state, view, lezer/common) sat under dependencies. The scanner installs only dependencies, so the module never resolved, and syntaxTree, tree and the token-class node property all became any.
  • That was also a real bug, not just lint noise. The lockfile resolved that package over git+ssh, so anyone without SSH keys to GitHub could not install the dependencies at all. It is now an ordinary registry dependency, with the single Obsidian-only export declared locally.
  • Six redundant type assertions removed, and two promises fixed: an async callback passed where a void return was expected, and a rejection carrying a bare value instead of an Error.
  • The global app object is gone from the last three places that used it; app is now threaded through the docs modal, the citation widget and the dependency notes.
  • Two debug loggers now use console.debug — the review allows warn, error and debug, and objects only to console.log.
  • Four deprecated calls removed: unescape, document.execCommand('copy') (the async Clipboard API is present in every Obsidian runtime, so the hidden-textarea fallback was dead code), and two legacy settings reads that the upgrade migration still needs but now reaches without touching the deprecated members.

Still outstanding

Two things are deliberately left alone:

  • The settings tab does not yet implement Obsidian 1.13's declarative settings API, so its settings will not appear in Obsidian's settings search on 1.13+. Adopting it needs a real 1.13 app to test against, because getting it wrong risks rendering every control twice.
  • The CSS notices describe the plugin's own rendering — the colour-coded citation underlines. Clearing them means changing how citations look, so they wait for a visual pass.

0.5.3

Choose a tag to compare

@github-actions github-actions released this 15 Oct 12:57

ScholarWeft 0.5.3 clears every error the community directory's own code review reports, and nearly every warning.

The code review is now clean

The directory runs a linter over the plugin's source (the same rules the review page shows), and 0.5.2 was reported with 1720 issues — including six classes of error. This release fixes all of them and reduces the total to 18, none of which are errors:

  • Unsafe HTML — four innerHTML assignments replaced with inert parsing (DOMParser, or moving child nodes), which is also what the review asks for.
  • Inline styles — 88 direct element.style.x = … assignments replaced with Obsidian's setCssStyles.
  • Regular-expression lookbehind — rewritten without it, because iOS before 16.4 cannot parse one.
  • Settings headings — built with Obsidian's heading API instead of raw <h2> elements.
  • Directive comments — every suppression now says why it is there.
  • Node built-ins — fs, path, os, child_process and util are now guarded by Platform.isDesktop (or reached through one guarded accessor), so the desktop-only paths degrade instead of crashing on mobile.

The remaining 18 are deliberate: seven read settings fields older builds wrote (deprecated, but an upgrade must still find them), two are the plugin's own gated debug loggers, and the rest need either Obsidian 1.13 or a change in behaviour to clear.

Fixes found along the way

Typing the code to satisfy the review turned up real bugs, not just lint noise:

  • makeBibliography() returns false, not only a citation list, when there is nothing to render. The untyped code indexed it anyway — a crash waiting to happen. Now narrowed properly.
  • A tooltip lookup used if (!file && !(file instanceof TFile)), so a folder passed the guard and was then treated as a file. Now a correct instanceof check.
  • sourceFile() fell back to casting the vault root folder to a file. It now returns a real file or null.
  • An old template that still wrote zotero-key would have silently stripped a note's identity property. ScholarWeft now writes sw-zotero-id from it instead.
  • Two notes can no longer share one sw-zotero-id, which would have split updates and citation links between them.
  • A ! in one note-list lookup was masking a bitwise-or typo.

Also in this release

  • The plugin is smaller still (3.4 MB) and its release assets carry a build-provenance attestation.
  • The Zotero picker is gone (see 0.5.2) — removed because Zotero's own picker searches every library, including ones the plugin does not load.

0.5.2

Choose a tag to compare

@github-actions github-actions released this 14 Oct 01:05

ScholarWeft 0.5.2 is a smaller, tidier build.

The Zotero picker is gone

The Import literature notes from Zotero… command has been removed.

It opened Zotero's own item picker, which searches every library in Zotero — including ones you have not enabled in ScholarWeft. Importing from those produced citations nothing could resolve, so the command could quietly create broken references. Add Literature Notes/Citations searches and filters the libraries you actually load, inside Obsidian, and does the same job without that trap — and without needing Better BibTeX.

Nothing else changes: the same command still creates or refreshes literature notes, inserts citations, or both.

A much smaller download

The plugin is now 3.4 MB instead of 10.5 MB, comfortably under the 5 MB line that matters for syncing. Release builds are minified, and the bundled export templates and documentation screenshots are stored at sensible sizes rather than at full resolution. The export templates keep small placeholder images, so it stays clear how images are handled in a compiled document.

Tidy-ups

  • The Add Literature Notes/Citations and Import a Word/ODT document dialogs now remember their last search, folder and destination in the plugin's own settings file rather than in browser storage.
  • Release assets carry a build-provenance attestation, so you can verify cryptographically that they were built from this repository by its release workflow.
  • The plugin description no longer names Obsidian (redundant in the plugin directory), and the author link points at the author's profile rather than the plugin's own repository.
  • Dead code left behind by earlier changes has been removed, and the codebase now passes the community directory's own linter with no errors.

0.5.1

Choose a tag to compare

@github-actions github-actions released this 13 Oct 20:57

ScholarWeft 0.5.1 fixes how a literature note is taken over when its identity is missing, and tidies the settings.

A renamed note is adopted, not duplicated

If you rename one of ScholarWeft's notes — or remove its sw-zotero-id — ScholarWeft now recognises it by its own citekey and takes it over in place, renaming it back to @citekey.md and restoring its identity property. It no longer writes a second note beside it.

This was a wiring bug: the note was looked up only by its Zotero item key, which the note no longer carried, so the conventional @citekey.md looked free and was created. Notes that another plugin made under its own naming (Zotero Integration writes a citekey property) are handled the same way — adopted and renamed rather than duplicated.

Two notes can never share one identity

A note's sw-zotero-id must be unique. If two files claim the same item, later lookups would reach only the first, so updates and citation links would split between them. ScholarWeft now refuses to stamp a second file with an identity an existing note already holds: it reports the collision and leaves both files alone. The background review also skips such duplicates rather than offering to adopt them.

Unmanaged notes are re-checked during the session

The review that offers to take over notes from other plugins used to run once, just after startup — so a note that lost its identity later in the session sat unnoticed until the next launch. It now re-checks every couple of minutes, acting silently when you have already chosen "Always adopt". A new command, Review literature notes from other plugins, runs it on demand and tells you how many notes remain.

One control shape for on/off settings

The three automatic-update settings — Update literature notes automatically, Update citekeys automatically, and Update notes when the template changes — used Yes/No radio buttons while everything else used a toggle. They are now the same slider toggle as the rest of the settings.

Notes made from an older template keep their identity

If your literature-note template was copied before the identity property was renamed, it still writes zotero-key — the property ZotLit reserves and claims. ScholarWeft rewrites that field to sw-zotero-id as it renders, so such a template keeps working instead of silently stripping the note's identity on every update.

0.5.0

Choose a tag to compare

@github-actions github-actions released this 13 Oct 16:57

ScholarWeft 0.5.0: literature notes now stand on their own, and the plugin no longer depends on ZotLit in any way.

ScholarWeft's notes are its own

Literature notes carry a new identity property, sw-zotero-id, instead of the zotero-key that ScholarWeft inherited from ZotLit. This matters because ZotLit treats any note carrying zotero-key as one of its own and reserves the name — so the two plugins were claiming the same notes. With sw-zotero-id, ZotLit no longer sees, adopts, or rewrites ScholarWeft's notes, and the two can coexist without interfering.

Your existing notes migrate automatically. On first load, ScholarWeft renames the property on every note it owns — silently, with no prompt, because the test is exact: ZotLit always writes its managed region, while ScholarWeft omits its own when an item has no annotations. A note with zotero-key and no ZotLit region is ScholarWeft's. A note never keeps both properties: once ScholarWeft manages a note it writes sw-zotero-id and drops zotero-key, so the two plugins can never both claim it.

ZotLit integration removed

ScholarWeft no longer hands note creation to ZotLit, installs ZotLit templates, or reads ZotLit's settings and folder. Everything ScholarWeft needs, it does itself. The ZotLit-only settings and the "Insert Zotero notes" command are gone with it.

Notes ZotLit created are still handled. ScholarWeft recognises them and, when you update one, asks whether to convert it (ScholarWeft takes over; ZotLit stops managing it) or leave it alone (it stays ZotLit's — ScholarWeft still links to it for citations, it just does not update it). If you keep using both plugins, they now stay out of each other's way.

You are asked once, on first load. Because the automatic update never opens a dialog mid-batch, it skips notes from another plugin rather than interrupting you. So ScholarWeft finds them on startup and asks once — convert them all, leave them alone, or ask each time — and records your answer. If you later import more, it asks again, since those notes are still unconverted. Change your mind any time under Settings → ScholarWeft → Literature note import → Literature notes from other plugins.

Crossed note names are now fixed

If two notes' names are swapped relative to their items — @foo1987 holding the item whose citekey is foo1987a, and vice versa — ScholarWeft exchanges them through temporary names so each note's name matches its item again. Previously it reported the pair as "name already in use" and left them crossed. A successful exchange is silent, like any other citekey update.

Two items sharing one citekey are reported, not skipped. A citekey must be unique; Better BibTeX adds a trailing letter automatically, but a hand-edited citekey can collide. When that happens no rename can fix it, so ScholarWeft says so plainly and points at the notes, instead of failing quietly. That, and notes not found in the loaded library, are the only citekey cases that ask for your attention.

Notes found under a different name

When a note is found under a name that is not its @citekey — another plugin's scheme, or an obsolete citekey — you are asked how to merge it, and that answer can be remembered so it is asked once. A name that is simply the citekey without its @ is not treated as foreign at all: ScholarWeft just adds the @.

Likewise, a file already sitting at @citekey.md but carrying no sw-zotero-id is no longer silently duplicated beside: ScholarWeft asks whether to adopt it as this reference's note, and can remember that too.

Smaller things

  • Fixed a startup bug where the note migration and the citation-index rebuild ran only when the reference-list sidebar was first created — which meant neither ran on a normal restart, once the sidebar was restored. They now run on every launch.
  • Removed two vault-maintenance tools (tools/add-page-locators.ts, tools/convert-citations.ts) that duplicated functionality the plugin already provides and could not run outside one vault.
  • The markdown style checkers are now part of the repo (tools/md/), so npm run check-md and the pre-commit hook work for anyone who clones it.