SPB Git

Repository Public

README.md 5.2 KB

# DOCX reference corpus

Every file here was produced by a tool other than ORIX Docs, or written by hand as raw OOXML. Nothing was downloaded; no third-party document is included. Microsoft Word was not used to produce or to check any of these files.

# Tool-generated files (committed, regenerated by generate.sh)

File Generator Source fixture What it exercises
pandoc-basic.docx pandoc 3.9.0.2 sources/basic.md title/author/keywords metadata, headings, emphasis, strong, strikeout, sub/superscript, small caps, inline code, external and internal links, heading bookmarks, block quote, forced line break, highlighted code block
pandoc-lists.docx pandoc 3.9.0.2 sources/lists.md bullets on three levels, decimal / alpha / roman numbering, a list starting at 5
pandoc-tables.docx pandoc 3.9.0.2 sources/tables.md header rows, column alignment, a cell with two paragraphs, table caption
pandoc-footnotes.docx pandoc 3.9.0.2 sources/footnotes.md three footnotes, one with two paragraphs, one with emphasis
pandoc-math.docx pandoc 3.9.0.2 sources/math.md real OMML: inline and display equations, fraction, radical, n-ary operators with limits, matrix
pandoc-images.docx pandoc 3.9.0.2 sources/images.md, sources/pixel-*.png two inline PNG pictures with sizes and alternative text
pandoc-unicode.docx pandoc 3.9.0.2 sources/unicode.md emoji sequences, combining marks, astral characters, CJK, Arabic, Hebrew, soft and non-breaking hyphens
pandoc-toc.docx pandoc 3.9.0.2 (--toc --toc-depth=2) sources/toc.md table-of-contents content control and field
libreoffice-merged.docx LibreOffice 26.8.2.2 headless sources/merged.html column and row spans, direct character formatting, alignment, indent, nested list
libreoffice-pagesetup.docx LibreOffice 26.8.2.2 headless sources/pagesetup.fodt A4 with asymmetric margins, header, footer with PAGE / NUMPAGES fields, a two-column continuous section, a landscape section, merged table cells with shading and borders

The PNG fixtures are generated by the small Python snippet that created them (solid colour, 48 × 32 and 20 × 20 pixels); they are committed as binary files.

Regenerate with:

text
Packages/ORIXDocsKit/Tests/DocDOCXTests/Corpus/generate.sh

generate.sh runs pandoc and soffice --headless with a private, temporary profile; it opens no window. Regenerating with other tool versions can change the files and therefore some expectations in ImportCorpusTests.swift.

# Hand-authored packages (hand-authored/, built by the tests)

The packages in hand-authored/ are not inputs of the tests: the tests build them in memory from HandAuthoredFixtures.swift (Hand.all()), and Scripts/docx-compat.sh writes a copy here so they can be inspected. They cover what no available tool can generate:

File Content
hand-tracked-changes.docx w:ins, w:del / w:delText, w:rPrChange, tracked paragraph marks, a tracked move, w:trackRevisions
hand-comments.docx comment ranges within and across paragraphs, a reply and a resolved thread (commentsExtended.xml), a comment without range
hand-fields.docx PAGE, NUMPAGES, DATE with a picture, TITLE, AUTHOR (fldSimple), SEQ, REF / PAGEREF to bookmarks, HYPERLINK fields, an unknown field, a broken reference, a multi-paragraph TOC field with stale entries
hand-drawings.docx anchored and inline pictures with crop, rotation and alternative text; a linked (external) picture; a picture relationship that tries to leave the package; a text box with a VML fallback; a preset shape; a chart; SmartArt; an OLE object with a preview picture; an unknown run element
hand-tables.docx gridSpan, vMerge, table and cell borders, shading, vertical alignment, header row, row height, cell margins, a nested table
hand-sections.docx three sections (letter portrait with title page and even footer; landscape, two columns, roman page numbers from 5, continuous; A4 odd page with page border), header inheritance, a watermark, page and column breaks
hand-styles-lists.docx document defaults with theme fonts, localised heading style ids, style inheritance, numbered headings, lists with start values, level patterns, symbol-font bullets, numbering through a style and a start override, footnote and endnote, external / internal links, every direct paragraph and run property, core properties
hand-equations.docx OMML written the way Word writes it (m:ctrlPr, m:naryPr), and an unknown OMML element
orix-rich.docx not hand-authored: the export of the ORIX Docs model built by richDocument() in RoundTripTests.swift, fed back in as a source document

Hostile inputs (decompression bomb, traversal entry names, DOCTYPE / entities, 20 000-level nesting, macro and OLE parts, corrupted and truncated archives) are generated inside SecurityTests.swift and are deliberately not written to disk.

Files main
Menu

Theme