DOCX Files

9.14.0 adds citations, captions, document protection and embedded files, and fixes tables of contents in LibreOffice. A document can now cite its sources and list them in a bibliography, in each of Word's citation styles, from the new docx/bibliography entry, and style: "Caption" now gives captions Word's Caption style, with a new guide to captions and cross-references (#557). protection makes a document read-only in Word, or keeps parts of it editable with EditableRangeStart and EditableRangeEnd, with an optional password (#2271). EmbeddedFileRun, from the new docx/embedded-files entry, embeds a file such as a spreadsheet as an object that opens when double-clicked (#719). There are smaller additions too. fitText fits a run's text to a width (#2597). Table cell borders take diagonalDown and diagonalUp to split a header cell (#3121). TableOfContents takes a tabLeader, so the space before page numbers can be blank or hyphens rather than dots (#1696). styles.default.lineNumber styles a section's line numbers (#551), and patchDocument can set a document's properties, such as its title and author (#2701). On the fixes side, docx now defines the TOC1 to TOC9 styles that table of contents entries use, so LibreOffice keeps the levels indented after it updates the table (#3819). It also writes a half-inch default tab stop, so tabs and list text line up in Pages (#2590). package.json now says docx needs Node.js 16 or later, as it already did in practice.

What's Changed

• feat: fit a run's text to a width with fitText (#2597) by @dolanmiu in https://github.com/dolanmiu/docx/pull/3801
• chore: evaluate-pr-comments reads CodeRabbit's comments in its reviews' bodies by @dolanmiu in https://github.com/dolanmiu/docx/pull/3803
• feat: embed files in a document as OLE objects, from docx/embedded-files (#719) by @dolanmiu in https://github.com/dolanmiu/docx/pull/3802
• build(deps-dev): bump eslint-plugin-jsdoc from 65.3.6 to 65.3.8 by @dependabot[bot] in https://github.com/dolanmiu/docx/pull/3804
• build(deps-dev): bump eslint from 10.12.0 to 10.13.0 by @dependabot[bot] in https://github.com/dolanmiu/docx/pull/3805
• feat: set a document's properties when patching it (#2701) by @dolanmiu in https://github.com/dolanmiu/docx/pull/3806
• fix: declare that docx needs Node.js 16 or later by @dolanmiu in https://github.com/dolanmiu/docx/pull/3807
• feat: style a section's line numbers with styles.default.lineNumber (#551) by @dolanmiu in https://github.com/dolanmiu/docx/pull/3808
• test: use toHaveBeenCalled* instead of the deprecated toBeCalled* matchers by @jasontd92 in https://github.com/dolanmiu/docx/pull/3809
• build(deps-dev): bump eslint-plugin-jsdoc from 65.3.8 to 65.3.11 by @dependabot[bot] in https://github.com/dolanmiu/docx/pull/3811
• build(deps-dev): bump execa from 10.1.1 to 10.2.0 by @dependabot[bot] in https://github.com/dolanmiu/docx/pull/3812
• feat: protect a document from changes in Word, with a password and editable ranges (#2271) by @dolanmiu in https://github.com/dolanmiu/docx/pull/3810
• feat: write Word's Caption style, and document captions and cross-references (#557) by @dolanmiu in https://github.com/dolanmiu/docx/pull/3813
• feat: cite sources and list them in a bibliography, in each of Word's styles, from docx/bibliography (#557) by @dolanmiu in https://github.com/dolanmiu/docx/pull/3814
• build(deps-dev): bump markdown-it from 14.3.2 to 14.3.3 in the npm_and_yarn group across 1 directory by @dependabot[bot] in https://github.com/dolanmiu/docx/pull/3815
• fix: write a half-inch default tab stop, so tabs and list text line up in Pages (#2590) by @dolanmiu in https://github.com/dolanmiu/docx/pull/3816
• feat: draw diagonal lines across table cells, to split a header cell (#3121) by @dolanmiu in https://github.com/dolanmiu/docx/pull/3817
• feat: choose what fills the space before a table of contents' page numbers, such as nothing or hyphens (#1696) by @dolanmiu in https://github.com/dolanmiu/docx/pull/3818
• build(deps-dev): bump eslint-plugin-jsdoc from 65.3.11 to 65.3.12 by @dependabot[bot] in https://github.com/dolanmiu/docx/pull/3820
• fix: define the TOC 1 to TOC 9 styles, so LibreOffice keeps the levels of a table of contents indented (#3819) by @dolanmiu in https://github.com/dolanmiu/docx/pull/3821

New Contributors

• @jasontd92 made their first contribution in https://github.com/dolanmiu/docx/pull/3809

Full Changelog: https://github.com/dolanmiu/docx/compare/9.13.0...9.14.0