aleleba/wordcraft
1
0
Fork 0
mirror of https://github.com/storytold/wordcraft.git synced 2026-10-24 10:27:44 -06:00
Code Issues Packages Projects Releases Wiki Activity
Files
release
wordcraft/docs/architecture.md
T
witkowski01Claude Opus 5.5Brandon Thomas
 1fa5333b26 M15: Polish interface, and Polish spelling, grammar and hyphenation (#346) 
* M15: Polish interface, and Polish spelling, grammar and hyphenation

Interface
- Polish is the tenth interface language ("Polski", pl.tsv, 1,045 entries);
  pl, pl-PL and pl_PL.UTF-8 system locales select it automatically.
- Right-click menu labels now go through translation in every language.
- Review > Language is a menu (English US/UK, Polski, Do not check spelling
  or grammar); the status bar shows the language at the caret.
- With a Polish interface, new blank documents and opened .txt/.md files
  default to pl-PL.

Proofing
- Each run is checked in its own language (w:lang, resolved through
  styles): squiggles, F7, review.issues, suggestions and hyphenation.
  Text in languages without proofing tools is no longer flagged as English.
- Polish spelling from the SJP.PL Hunspell dictionary (Apache-2.0 option),
  read by a new Rust affix engine (crates/proof/src/affix.rs); 875 KB asset,
  ~4.5M word forms. Regenerate with the pl_dictionary example.
- Polish suggestions: case, missing diacritics, rz/ż, ó/u, ch/h confusions,
  missing spaces (napewno -> na pewno), edit distance.
- Conservative Polish grammar rules: repeated words, spacing, doubled
  punctuation, sentence capitals, missing comma before że/który/ponieważ/
  aby/żeby/jeśli…, we/ze forms.
- Polish hyphenation with the hyph-utf8 hyph-pl.tex patterns (MIT option);
  pattern keys widened to 20 letters, TeX exceptions parsed; the heuristic
  no longer treats ł, ż, ś… as vowels.

review.language validates and normalizes tags, can set noProof alone and
the document default; format.state reports lang and noProof.

Tests for every part, docs and ATTRIBUTION.md/NOTICE updated;
cargo xtask ci passes (fmt, clippy, test, assets, layers, wasm).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* Layout: rustfmt the test module order left unformatted by #391

cargo fmt --check failed on main after #391 added mod tests_grid.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* Review fixes for #346: read Polish spelling from the installed Hunspell dictionary

- Polish spelling uses the Hunspell pl_PL dictionary installed on the
  system (OS packages, Homebrew, LibreOffice, ~/.local/share/hunspell, or
  WORDCRAFT_DICTIONARIES) instead of a bundled 870 KB SJP.PL file;
  without one, Polish text gets no spelling marks, like Word without the
  language's proofing tools. .aff/.dic are size-capped and decoded from
  UTF-8 or ISO 8859-2 (crates/proof/src/hunspell.rs).
- The dictionary can be replaced at runtime (install_dictionary) or
  re-searched (reload_dictionary); an empty one accepts every word.
- Tests use small synthetic dictionaries written for them, so they don't
  depend on what the machine has installed.
- The bundled pl.dic, its ATTRIBUTION/NOTICE entries and the generator
  example are removed; docs describe the installed dictionary.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* M15: Polish catalog covers the interface text merged from main

The merge of main (98456ac) brought ~575 new interface strings (charts,
SmartArt, content controls, Developer tab, AutoCorrect, outline view,
protection, compare, print, accessibility, references and Language/
Hyphenation dialogs, Draw additions). pl.tsv lacked them, so
polish_covers_every_key_of_every_other_catalog and
every_tab_and_command_is_translated failed. All are now translated.

cargo xtask ci: all 6 steps pass.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: Brandon Thomas <echelon@gmail.com>
2026-10-12 04:04:03 -04:00

5.5 KiB
Raw Permalink Blame History

WordCraft architecture

Last reviewed: 2026-10-10 · Last updated: 2026-10-10 · Change: minor (proof is per language: English and Polish; previously major: first committed version; plan/architecture.md is local-only) · Target: Microsoft Word (Microsoft 365) for Mac 16.113.4

How WordCraft is built today (origin/main 40c5d51). The longer design notes in plan/architecture.md are gitignored and local to the original author's machine; this file is the committed, current summary. Rules for working in the code are in AGENTS.md.

Layers

~85,600 lines of Rust, 15 crates, 3 apps and xtask. Layering is enforced by cargo xtask layers: a crate may only depend on crates in lower layers, and nothing below L6 depends on egui, eframe, winit or rfd.

Layer Crate Lines Job
L0 geom 0.2k Units (points, twips, EMU, inches, cm), rectangles, measurement parsing
L1 doc 10.0k Document model: stories, paragraphs, runs, tables, sections, styles, numbering, fields, notes, comments, revisions, equations (OMML-shaped math tree, linear/LaTeX input); edit primitives; bidi
L1 fonts 2.3k Font database (bundled OFL + system fonts), metrics, outlines, shaping with HarfRust, Word font substitution (word.rs: Carlito ↔ Calibri, Caladea ↔ Cambria, Liberation ↔ Arial/Times/Courier), OpenType MATH
L1 proof 3.8k Proofing per language (ProofLang from a run's w:lang): English (public-domain word list) and Polish (installed Hunspell dictionary through a Hunspell-style affix engine) spelling and suggestions, rule-based grammar for both, hyphenation dictionary and Liang patterns (English, Polish)
L2 layout 9.6k Shaping runs, line breaking, tabs, lists, tables (row splitting, floating tables), pagination, headers/footers, notes, floating objects and wrap, math layout, fields, hit testing; produces a display list
L2 docx 8.4k OOXML WordprocessingML reader and writer (Transitional and Strict namespaces, .docx/.docm/.dotx/.dotm), OMML, custom properties, VBA parts preserved
L2 docbin 4.4k Word 97-2003 .doc reader ([MS-DOC]: FIB, piece table, FKPs, SPRMs, stylesheet, lists, tables, notes, pictures) over a CFB container
L2 formats 10.6k TXT, Markdown, HTML, RTF, ODT and LaTeX import/export through a shared intermediate model
L3 render 0.6k vello_cpu rasteriser: pages and thumbnails from the display list; PNG/JPEG
L3 pdf 1.6k krilla PDF export: font subsets, selectable text, links, outline, tagging
L4 engine 15.2k Session (document, selection, undo, layout cache, view state), command registry (422 CommandSpecs in cmd/*.rs), Word feature catalog (catalog.rs), samples, file I/O dispatch (io.rs), Read Aloud sentence model
L4 zotero 1.7k Zotero's word-processor integration protocol answered against a Session
L4 control-key 0.1k Per-window control-port key files shared by the app and the MCP bridge
L5 mcp 1.0k MCP server: every command as a tool; headless or bridged to the running app
L6 ui-egui 13.1k Word-style front end: ribbon, keytips, mini-toolbar, Backstage, canvas, rulers, panes, dialogs, Equation tab, i18n catalogs, themes, control channel, headless ui_shot example
apps wordcraft 1.6k Desktop app (eframe + wgpu; logging, window geometry, file associations)
apps wordcraft-cli 0.4k convert, text, inspect, run, commands, parity, mcp, zotero
apps wordcraft-web 0.3k Browser build (eframe web runner, WebGPU with WebGL2 fallback)

Data flow

  1. Open: engine::io picks a reader by extension (docx, docbin, formats, JSON) and produces a doc::Document.
  2. Edit: every user-visible action is a command id run through Session::run (ribbon, shortcuts, command search, CLI, control channel and MCP all dispatch by id). Session::run snapshots for undo (blocks are Arc-shared, so snapshots are cheap) and catches an escaped panic, restoring the document (never-crash standard).
  3. Layout: layout turns the document into pages of positioned glyphs, boxes and images (display list), incrementally: an edit relayouts only what changed (1.4 ms on a 188-page document, measured 2026-10-06).
  4. Draw: the UI paints pages through render (CPU raster, cached per page, pixel-aligned) on an egui/wgpu canvas; PDF export walks the same display list through pdf.
  5. Save: engine::io picks a writer by extension.

Testing and gates

  • 821 #[test] functions and 10 property-test blocks: model, layout, DOCX round-trip and hostile input, .doc, formats, typing parity (engine/src/tests_typing.rs), bidi, i18n catalogs, UI interaction (egui_kittest), MCP acceptance; hostile_params_never_panic runs every command with junk params.
  • cargo xtask ci: fmt, clippy -D warnings, tests, asset attribution, layering, wasm build.
  • cargo xtask parity regenerates parity-checklist.md; a test keeps the catalog percentage above a floor that only rises.
  • GitHub Actions on PRs: packaging lint, and FreeBSD / Windows ARM64 when build files change; release builds on pushes to release.

Revision history

Date Change Summary
2026-10-10 minor proof: proofing languages (English, Polish), affix engine, Polish patterns; layout and engine route each run by its language
2026-10-10 major First committed architecture doc, from the crates' sources and AGENTS.md
Reference in New Issue View Git Blame Copy Permalink