DOCX Files

9.15.1 adds guides for questions raised in issues, and fixes image names, placeholders that patchDocument skipped, and text boxes in WPS Office. The docs now show how to style a list's numbers and bullets (#2328), number a list in legal style, for 1.1 under a level in Chinese counting (#3425), put space between images in a paragraph (#3021), and put a full-page background image behind the text without the header pushing the text down (#2349). They explain that a table row of exact height never splits across pages (#1615), that a table goes next to paragraphs and never in a paragraph's children (#2711), and how a hanging paragraph's left differs from the Left that Word's Paragraph dialog shows (#2448). The checkbox options now give their real type, their defaults and what alias does (#3007), createMathAccentCharacter is described as an n-ary operator's character, with a pointer to MathAccent for accents (#2511), and the README's browser example now uses the current docx rather than playgrounds on docx 7.1.0 (#2853). On the fixes side, images are now written to the package as image1.png, image2.jpg and so on, as Word names them, rather than under a hash of their data, which Word for the web showed as an empty box (#496). patchDocument and patchDetector now find placeholders in a link's text, in a content control and in text typed with Track Changes on, which they used to skip without an error (#2679). A text box of auto height is now written 1in tall, so WPS Office fits it to its text (#3171), and ImportedXmlComponent.fromXmlString no longer wraps its XML in an <undefined> element (#3862).

What's Changed

• chore: tag the tip of master in the release skill by @dolanmiu in https://github.com/dolanmiu/docx/pull/3850
• chore: tag origin/master in the release skill, stopping if a check fails by @dolanmiu in https://github.com/dolanmiu/docx/pull/3851
• docs: explain that a table row of exact height never splits across pages by @dolanmiu in https://github.com/dolanmiu/docx/pull/3852
• docs: show how to style a list's numbers and bullets by @dolanmiu in https://github.com/dolanmiu/docx/pull/3853
• docs: say createMathAccentCharacter is an n-ary operator's character, and point to MathAccent by @dolanmiu in https://github.com/dolanmiu/docx/pull/3854
• docs: give the checkbox options' real type, defaults and what alias does by @dolanmiu in https://github.com/dolanmiu/docx/pull/3855
• docs: show how to put space between images in a paragraph by @dolanmiu in https://github.com/dolanmiu/docx/pull/3856
• docs: explain legal style numbering, for 1.1 under a level in Chinese counting by @dolanmiu in https://github.com/dolanmiu/docx/pull/3857
• fix: write a text box of auto height 1in tall, so WPS Office fits it to its text by @dolanmiu in https://github.com/dolanmiu/docx/pull/3858
• docs: say a table goes next to paragraphs, never in a paragraph's children by @dolanmiu in https://github.com/dolanmiu/docx/pull/3859
• docs: say Word's dialog shows a hanging paragraph's Left where its first line starts by @dolanmiu in https://github.com/dolanmiu/docx/pull/3860
• docs: show a browser example in the README in place of playgrounds on docx 7.1.0 by @dolanmiu in https://github.com/dolanmiu/docx/pull/3861
• fix: write ImportedXmlComponent.fromXmlString's XML without an <undefined> element around it by @dolanmiu in https://github.com/dolanmiu/docx/pull/3863
• fix: patch placeholders in links, content controls and tracked changes by @dolanmiu in https://github.com/dolanmiu/docx/pull/3864
• build(deps-dev): bump @typescript-eslint/parser from 8.72.0 to 8.72.1 by @dependabot[bot] in https://github.com/dolanmiu/docx/pull/3868
• build(deps-dev): bump @microsoft/api-extractor from 7.59.4 to 7.60.0 by @dependabot[bot] in https://github.com/dolanmiu/docx/pull/3869
• build(deps-dev): bump inquirer from 14.2.4 to 14.2.5 by @dependabot[bot] in https://github.com/dolanmiu/docx/pull/3867
• build(deps-dev): bump typescript-eslint from 8.72.0 to 8.72.1 by @dependabot[bot] in https://github.com/dolanmiu/docx/pull/3866
• build(deps-dev): bump qs from 6.15.2 to 6.17.1 in the npm_and_yarn group across 1 directory by @dependabot[bot] in https://github.com/dolanmiu/docx/pull/3870
• docs: show a full-page background image the header doesn't push the text below by @dolanmiu in https://github.com/dolanmiu/docx/pull/3871
• fix: name images in the package as Word does, image1.png and so on by @dolanmiu in https://github.com/dolanmiu/docx/pull/3872
• chore: sweep other merged branches in post-merge cleanup by @dolanmiu in https://github.com/dolanmiu/docx/pull/3873
• docs: say a hanging paragraph's left is where the lines after the first start by @dolanmiu in https://github.com/dolanmiu/docx/pull/3874
• chore: Version bump to 9.15.1 by @dolanmiu in https://github.com/dolanmiu/docx/pull/3875

Full Changelog: https://github.com/dolanmiu/docx/compare/9.15.0...9.15.1