This repository was archived by the owner on Nov 7, 2026. It is now read-only.
Repository navigation
Document every format the library reads or writes in docs/formats - #166
Merged
Merged
Conversation
…t, and a test keeps it complete. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
… profile, and a test checks its examples against their fixtures. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…ema and its JSON Schema export, and the docs test checks fixture excerpts too. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
… writing-system rule and backends, with Word HTML/RTF and tables marked planned. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…day, with the real-tables design marked planned. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…d status, and the README links to it. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
… error table, and fails on a malformed fixture marker. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…ls below, and cites no decision ids. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…rkdown form planned (#168), and states the Word plans as plain decisions. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…ses plain words for paths and blocks, and points schema validation at the planned fwmd CLI (#161). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…dangling references. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…re values take ASCII letters only, and marks its clipboard form planned. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…inside quotes. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Start here:
docs/formats/README.md, the index. It lists every format SIL.TextEditing reads or writes, with its purpose, file extension or clipboard name, and whether it is shipped or planned.This PR adds user-facing format documentation in
docs/formats/:fieldworks-markdown.md: the FieldWorks Markdown profile of Pandoc Markdown. It covers the front matter, runs and writing systems, classes and attribute order, property keys, quoting, styles, empty and special paragraphs, divs, the five link forms and project paths, pictures, glossed examples, escapes, NFD/NFC, limits, the unsupported Pandoc constructs and the Pandoc reader flags.record-files.md: the YAML frame and its keys, quoting,|and|-, the body, partial files, the schema as data, and the JSON Schema export (contentMediaType,x-fieldworks-blocks).clipboard.md: the forms and their ids, copy, paste order, the writing-system rule, Copy as and backends. Word HTML/RTF (R-3, Q65–Q72) and tables (R-4, Q73–Q79) are in sections marked planned.tables.md: how tables are stored and written today, and the planned real-tables design.findings.md: every finding id (fwmd.*,fwmd.yaml.*,fwmd.record.*,textediting.lcm.*) with its severity, meaning, usual fix and a fixture case.Checkable. Every example is copied from a conformance fixture, and
FormatDocsTests(inSIL.TextEditing.Markdown.Tests) keeps the docs honest:fwmd.*/textediting.*id literal insrcmust have a row infindings.md, and every id in a table offindings.mdortables.mdmust still be insrc;<!-- fixturemarker must be well-formed, or the test fails;<!-- fixture: <file> | <case name> | markdown|canonical|file -->must equal that case's text;<!-- fixture-excerpt: <file> -->block must be part of that fixture file.No fixture cases were added and no library code changed. The README gets one line that links to the index.
Code compared with the older spec (be90c389b) and with code comments
Where they differ, the docs describe the code.
gdr.*ids are nowfwmd.*.gdr.abstract.block-syntaxis nowfwmd.field.block-syntax.gdr.ws.defaults-changedis retired, and the front matter's defaults win.{v}became.v,{empty}became[]{.empty},cs=/style=becamecustom-style=,cs=nonebecame.nostyle, andbrokenbecame.broken.[[kind:Name]]andlink=became path links in five forms.fw:picture/became/files/pictures/...{guid=}.\uXXXXands6="..."became character references andsNxhex. Bare values gained:and/, and keys may hold-. One-line fences became Pandoc divs. The table styles are named by the host.RecordFileWriter's summary says every rich value is|-, but R-8 writes|for fields of paragraphs.RecordField.ContentMediaTypesays references aretext/x-fieldworks-markdown, but the code returns-inline.MarkdownDiagnosticIdssayslink.ambiguousandlink.brokenare reported by hosts, butObjectBuilderreports both.Next: the FieldWorks Markdown clipboard form (#168) and the fwmd CLI (#161); file issues for the stale comments.
🤖 Generated with Claude Code