Skip to content

Releases

0.2.9

Choose a tag to compare

@github-actions github-actions released this 14 Nov 16:39

0.2.8

Footnote rendering and superscript fixes.

Footnote normalization

  • New shared normalize_arabic_footnotes pass, used by the raw transcription formatter and the Level 2 Markdown-update layer.
  • Each page is reduced to one arabic-footnotes callout.
  • All footnote paragraphs are written as > - ....
  • Continuation paragraphs under the same footnote, or under no number, receive a > separator.
  • A paragraph following a footnote callout on the same page is folded into the callout.
  • Existing correct callouts are preserved; the pass is idempotent.

Footnote anchors

  • Increased the CSS specificity of the superscript rule so Obsidian’s core default and the Qur'ān inline-block rule cannot override it.
  • Arabic footnote anchors are now 75% of the surrounding text.

Documentation

  • Documented the one-callout-per-page footnote convention in the Transcription guide.

0.2.8

Choose a tag to compare

@github-actions github-actions released this 13 Nov 17:22

0.2.8

Footnote rendering and superscript fixes.

Footnote normalization

  • New shared normalize_arabic_footnotes pass, used by the raw transcription formatter and the Level 2 Markdown-update layer.
  • Each page is reduced to one arabic-footnotes callout.
  • All footnote paragraphs are written as > - ....
  • Continuation paragraphs under the same footnote, or under no number, receive a > separator.
  • A paragraph following a footnote callout on the same page is folded into the callout.
  • Existing correct callouts are preserved; the pass is idempotent.

Footnote anchors

  • Increased the CSS specificity of the superscript rule so Obsidian’s core default and the Qur'ān inline-block rule cannot override it.
  • Arabic footnote anchors are now 75% of the surrounding text.

Documentation

  • Documented the one-callout-per-page footnote convention in the Transcription guide.

0.2.7

Choose a tag to compare

@github-actions github-actions released this 13 Nov 16:30

0.2.7

Font and footnote refinements.

Qur'ānic text font restored

  • Restored DigitalKhatt New Madina as the preferred Qur'ānic text face.
  • KFGQPC Uthmanic Script HAFS is again reserved for the ۝ verse emblem.
  • The U+06DF mark still uses DigitalKhatt first, with Amiri Quran / Scheherazade as fallbacks.
  • Updated the README and Setup font documentation to reflect the intended stack.

Footnote anchors

  • Arabic footnote superscripts are now 75% of the surrounding text with no additional line box.

0.2.6

Choose a tag to compare

@github-actions github-actions released this 13 Nov 16:16

0.2.6

Qur'ānic font rendering fix.

U+06DF small high rounded zero

  • KFGQPC HAFS maps U+06DF (the mark after wāw in forms such as أُو۟لَٰٓئِكَ) to a dotted-circle placeholder.
  • Added a range-scoped mas-quran-mark face that routes only U+06DF through Amiri Quran, Scheherazade New, or Noto Naskh Arabic, while the rest of the verse keeps KFGQPC.

Bottom clipping

  • Expanded the painted box around Arabic verse text and inline .quran-quote text so the gilded background covers descenders and combining marks instead of clipping their lower edge.

Documentation

  • Noted the U+06DF font routing in the Setup guide’s font section.

0.2.5

Choose a tag to compare

@github-actions github-actions released this 12 Nov 19:49

0.2.5

Community-scorecard cleanup.

CSS review warnings

  • Removed !important from the poetry, Qurʾān, footnote, TOC, and version-manager rules, using more specific selectors where needed.
  • Replaced the flagged column-gap with the gap shorthand.
  • Removed a duplicate margin-block declaration.
  • Replaced the flagged text-indent hanging indent with padding/margin spacing.

Code review warnings from 0.2.4

  • Floating promises, unnecessary assertions, unused imports, unsafe JSON assignment, and file-deletion preference warnings are fixed.
  • Lint now reports one deliberate warning: the template-driven JsonObject uses any.

Remaining disclosures

These are intentional and documented in the README rather than code warnings:

  • Direct filesystem access for PDFs and pipeline files outside the vault.
  • Shell execution for the local Python pipeline.
  • Clipboard access for transliteration.
  • Vault enumeration for indexing.
  • Network access for imports, Zotero, and LLM services.
  • GPL-3.0 copyleft licensing.

0.2.4

Choose a tag to compare

@github-actions github-actions released this 12 Nov 19:43

0.2.4

Code-quality and documentation sync release.

Lint and review cleanup

  • Reduced lint output from 36 warnings to one deliberate JsonObject any in the render-model type.
  • Fixed floating promises, unnecessary assertions, unused imports, unsafe JSON assignments, and sentence-case warnings.
  • Switched version-note deletion to FileManager.trashFile() so the user’s file-deletion preference is respected.
  • Corrected the annotation-sidebar version notice and version-manager labels to sentence case.

Documentation

  • Synced the latest vault Midad Docs README and Zotero guide into the repository.
  • Kept Midad Docs/ as the documentation source of truth; local builds sync it automatically.

The remaining JsonObject any is intentional: the acquisition render model is template-driven and loosely typed.

0.2.3

Choose a tag to compare

@github-actions github-actions released this 11 Nov 16:47

0.2.3

Documentation cleanup and clarification.

Automatic transcription/translation recognition

  • Documented the exact filename forms Midad recognizes automatically:
    • @citekey - transcription / translation
    • mas-citekey - transcription / translation
    • optional - vol. N and final variant suffix
  • Explained that @citekey means a Zotero/ScholarWeft literature note and mas- means a standalone PDF.
  • Clarified that recognition is filename-based, not dependent on a special YAML property, and that the title comes from title: frontmatter when present.

Documentation cleanup

  • Removed obsolete legacy-marker, retired-property, and migration notes from the guides.
  • Consolidated Unadopt under Managed regions, identity, and adoption instead of repeating it in the versions guide.
  • Updated links so version lifecycle and identity/cleanup have distinct homes.

Documentation workflow

  • Midad Docs/ in the vault is the source of truth. npm run sync-docs copies it into the development repo, and local builds run the sync automatically.

0.2.2

Choose a tag to compare

@github-actions github-actions released this 11 Nov 16:19

0.2.2

Documentation release for managed regions and cross-source identity.

New guide

  • Added Managed regions, identity, and adoption (docs/managed-regions.md), covering:
    • the mas-managed marker boundary and spacing;
    • adding managed tags to one note or all managed notes;
    • midad-id and retired identity properties;
    • adoption and Unadopt;
    • preservation during re-render and source removal;
    • identity cleanup and hash pruning.

Links

  • Linked the guide from the README, Commands, Document import, Templates, and Versions guides.
  • The command reference now covers every registered command, including Stop source import or render and Check imported source note sizes.

0.2.1

Choose a tag to compare

@github-actions github-actions released this 11 Nov 16:16

0.2.1

Documentation release for the source/version lifecycle.

New guide

  • Added Versions, removal, and cleanup (docs/versions.md), covering Version 0, saved versions, per-work archives, hash baselines, re-rendering, source removal, model-only deletion, re-download, correction consolidation, Unadopt, and orphan cleanup.

Command reference

  • Added the missing Stop source import or render and Check imported source note sizes commands.
  • Documented version caching, correction consolidation, Unadopt, and cleanup commands.
  • Linked the new guide from the README, Commands, Document import, Setup, and Transcription guides.

Documentation links

  • Version management is now discoverable from the places where users encounter it instead of being scattered across four guides.

0.2.0

Choose a tag to compare

@github-actions github-actions released this 11 Nov 16:05

0.2.0

This release completes the source/version lifecycle work: safer removal, per-work version archives, a unified hash index, automatic correction consolidation, and cleanup tools.

Versions and managed notes

  • Version 0 is virtual for installed and generated sources. It represents the installed model or archived transcription/translation and creates no snapshot. Saved user versions are Version 1 and later.
  • Version 0 can be selected, rendered as a separate .Version0.md note, or made the default independently of the other versions.
  • Saved versions are stored in per-work archives under .midad-arabic-sources/version-archives/; the old global source-versions.zip is migrated automatically.
  • Reinstalling or restoring a source automatically reapplies its saved versions.
  • Managed-region baselines and saved-version hashes now live in one index, .midad-arabic-sources/note-hashes.json.
  • Managed-region markers are normalized consistently on every write, including a blank line after the closing marker at the end of a note.
  • The version manager reports template/render-fingerprint changes without rewriting historical snapshots.

Safer source removal

  • Removing a source now keeps notes containing user-written text outside the managed region, stripping only the generated region.
  • The removal dialog offers Remove, keep my notes or Remove everything.
  • Delete cached model only keeps notes and versions while removing the model.
  • Re-download source/model re-fetches a source while preserving user content.
  • Source removal and model deletion require explicit confirmation.

Corrections and cleanup

  • Legacy *.corrections.json sidecars are consolidated automatically into saved versions named Committed corrections, with backups, and then retired.
  • Unadopt this note… removes Midad identity, managed tags, saved versions, and adopted-note registration while keeping the note content.
  • Clean up orphaned Midad data… prunes hash and adopted-registry records whose notes no longer exist.
  • Saved-version and annotation content is preserved when notes are removed.

Documentation

  • Updated the README and guides for version management, per-work archives, safe removal, re-download/model deletion, correction consolidation, Unadopt, and cleanup.
  • Documented the new .midad-arabic-sources/note-hashes.json and version-archives/ state.