Localize the manual first, then the application #2

Closed
opened 2026-11-16 13:56:12 +01:00 by Dandaedre · 0 comments
Owner

Make Canvas Pilot usable in other languages, starting with the book and then the application. This is a distant-future goal with no committed release date. English remains the source language; French is a suggested first translation, subject to confirming a reviewer and the initial language scope.

Phase 1: book

  • Confirm the first language, reviewer and release scope; establish a glossary shared with the future UI translation.
  • Pilot one chapter and the feature matrix before choosing translated Markdown or message catalogs. Translate canonical sources and track their source revision.
  • Build each language with its own navigation and output path while preserving existing English and template-download URLs.
  • Provide a chapter-aware language selector and clearly identified English fallback.
  • Review translated installation, quick start, format matrices, template catalog and advanced instructions. Keep exact English control labels while the application remains English-only.
  • Validate links, anchors, search, print view, images, tables, downloads and publication boundaries with the pinned mdBook version.
  • Document contribution, review and update procedures before publishing the first language.

Phase 2: application

Start after the book workflow and glossary have been validated.

  • Inventory visible text and choose a small localization mechanism with stable keys, complete messages, named placeholders, plurals and English fallback.
  • Add a workstation language preference, including System default and defined region/fallback behavior. Preserve unsaved work when switching languages.
  • Keep project schemas, protocol identifiers, file extensions, numeric serialization and clipboard exchange language-independent. Never rename existing layers or folders.
  • Define decimal-entry behavior without ambiguous measurements or changes to device writes.
  • Validate long translations, font coverage, shortcuts, scaling, small windows, missing messages and translated Help links.
  • Review recovery, overwrite and Preview/Program wording; test cross-language clipboard/project interoperability and run the existing Rust/coverage gates.

Later, when needed

Evaluate right-to-left layout and shaping before advertising languages that require them. Add translated video captions when videos exist; consider a hosted translation service only if contributor volume warrants it.

Completion criteria and reference

The first agreed language is reviewed and usable in the book and application, with a maintainable update process and unchanged file/device compatibility. Detailed implementation and acceptance tasks remain in the localization roadmap.

Make Canvas Pilot usable in other languages, starting with the book and then the application. This is a distant-future goal with no committed release date. English remains the source language; French is a suggested first translation, subject to confirming a reviewer and the initial language scope. ## Phase 1: book - [ ] Confirm the first language, reviewer and release scope; establish a glossary shared with the future UI translation. - [ ] Pilot one chapter and the feature matrix before choosing translated Markdown or message catalogs. Translate canonical sources and track their source revision. - [ ] Build each language with its own navigation and output path while preserving existing English and template-download URLs. - [ ] Provide a chapter-aware language selector and clearly identified English fallback. - [ ] Review translated installation, quick start, format matrices, template catalog and advanced instructions. Keep exact English control labels while the application remains English-only. - [ ] Validate links, anchors, search, print view, images, tables, downloads and publication boundaries with the pinned mdBook version. - [ ] Document contribution, review and update procedures before publishing the first language. ## Phase 2: application Start after the book workflow and glossary have been validated. - [ ] Inventory visible text and choose a small localization mechanism with stable keys, complete messages, named placeholders, plurals and English fallback. - [ ] Add a workstation language preference, including System default and defined region/fallback behavior. Preserve unsaved work when switching languages. - [ ] Keep project schemas, protocol identifiers, file extensions, numeric serialization and clipboard exchange language-independent. Never rename existing layers or folders. - [ ] Define decimal-entry behavior without ambiguous measurements or changes to device writes. - [ ] Validate long translations, font coverage, shortcuts, scaling, small windows, missing messages and translated Help links. - [ ] Review recovery, overwrite and Preview/Program wording; test cross-language clipboard/project interoperability and run the existing Rust/coverage gates. ## Later, when needed Evaluate right-to-left layout and shaping before advertising languages that require them. Add translated video captions when videos exist; consider a hosted translation service only if contributor volume warrants it. ## Completion criteria and reference The first agreed language is reviewed and usable in the book and application, with a maintainable update process and unchanged file/device compatibility. Detailed implementation and acceptance tasks remain in the [localization roadmap](https://proxy.dandaedre.com/gitea/idle-org/canvas-pilot/src/branch/main/docs/development/localization.md).
Dandaedre added the
enhancement
help wanted
labels 2026-11-16 14:03:38 +01:00
Dandaedre self-assigned this 2026-11-16 14:03:41 +01:00
Sign in to join this conversation.
No Milestone
No project
No Assignees
1 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: idle-org/canvas-pilot#2
No description provided.