Add word generation font options

Author: johnml1135

Src/xWorks/xWorksTests/LcmWordGeneratorTests.cs

@@ -8,6 +8,8 @@
 using System.Linq;
 using System.Text.RegularExpressions;
 using System.Xml;
+using DocumentFormat.OpenXml;
+using DocumentFormat.OpenXml.Wordprocessing;
 using NUnit.Framework;
 using SIL.FieldWorks.Common.Framework;
 using SIL.FieldWorks.Common.FwUtils;
@@ -19,6 +21,7 @@
 using SIL.TestUtilities;
 using XCore;
 using static SIL.FieldWorks.XWorks.LcmWordGenerator;
+using W14 = DocumentFormat.OpenXml.Office2010.Word;
 // ReSharper disable StringLiteralTypo
 
 namespace SIL.FieldWorks.XWorks
@@ -59,6 +62,7 @@ static LcmWordGeneratorTests()
 			WordNamespaceManager.AddNamespace("w", openXmlSchema);
 			WordNamespaceManager.AddNamespace("r", openXmlSchema);
 			WordNamespaceManager.AddNamespace("wp", openXmlSchema);
+			WordNamespaceManager.AddNamespace("w14", "http://schemas.microsoft.com/office/word/2010/wordml");
 		}
 
 		[OneTimeSetUp]
@@ -210,6 +214,62 @@ public void Setup()
 			DefaultSettings.StylesGenerator.AddGlobalStyles(null, new ReadOnlyPropertyTable(m_propertyTable));
 		}
 
+		[Test]
+		public void GenerateCharacterStyleFromLcmStyleSheet_OpenTypeFontFeatures_AddsWordTypographyProperties()
+		{
+			var styleName = "WordFeatureStyle" + Guid.NewGuid().ToString("N");
+			var fontInfo = new FontInfo { m_features = { ExplicitValue = "liga=0,lnum=1,pnum=1,calt=0,ss02=0,cv01=2" } };
+			var projectStyle = new TestStyle(fontInfo, Cache) { Name = styleName, IsParagraphStyle = false };
+			FontHeightAdjuster.StyleSheetFromPropertyTable(m_propertyTable).Styles.Add(projectStyle);
+
+			var style = WordStylesGenerator.GenerateCharacterStyleFromLcmStyleSheet(styleName, Cache.DefaultVernWs,
+				new ReadOnlyPropertyTable(m_propertyTable));
+
+			var runProps = style.GetFirstChild<StyleRunProperties>();
+			AssertWordTypographyProperties(runProps, W14.LigaturesValues.None, W14.NumberFormValues.Lining,
+				W14.NumberSpacingValues.Proportional, false, 2U, false);
+		}
+
+		[Test]
+		public void GetExplicitFontProperties_OpenTypeFontFeatures_AddsWordTypographyProperties()
+		{
+			var fontInfo = new FontInfo { m_features = { ExplicitValue = "liga=1,clig=1,onum=1,tnum=1,calt=1,ss03=1,cv01=2" } };
+
+			var runProps = WordStylesGenerator.GetExplicitFontProperties(fontInfo);
+
+			AssertWordTypographyProperties(runProps, W14.LigaturesValues.StandardContextual, W14.NumberFormValues.OldStyle,
+				W14.NumberSpacingValues.Tabular, true, 3U, true);
+		}
+
+		private static void AssertWordTypographyProperties(OpenXmlCompositeElement runProps,
+			W14.LigaturesValues ligaturesValue, W14.NumberFormValues numberFormValue,
+			W14.NumberSpacingValues numberSpacingValue, bool contextualAlternativesValue,
+			uint stylisticSetId, bool stylisticSetValue)
+		{
+			Assert.That(runProps, Is.Not.Null);
+			var ligatures = runProps.GetFirstChild<W14.Ligatures>();
+			Assert.That(ligatures, Is.Not.Null);
+			Assert.That(ligatures.Val.Value, Is.EqualTo(ligaturesValue));
+
+			var numberForm = runProps.GetFirstChild<W14.NumberingFormat>();
+			Assert.That(numberForm, Is.Not.Null);
+			Assert.That(numberForm.Val.Value, Is.EqualTo(numberFormValue));
+
+			var numberSpacing = runProps.GetFirstChild<W14.NumberSpacing>();
+			Assert.That(numberSpacing, Is.Not.Null);
+			Assert.That(numberSpacing.Val.Value, Is.EqualTo(numberSpacingValue));
+
+			var contextualAlternatives = runProps.GetFirstChild<W14.ContextualAlternatives>();
+			Assert.That(contextualAlternatives, Is.Not.Null);
+			Assert.That(contextualAlternatives.Val.Value, Is.EqualTo(contextualAlternativesValue));
+
+			var stylisticSets = runProps.GetFirstChild<W14.StylisticSets>();
+			Assert.That(stylisticSets, Is.Not.Null);
+			var styleSet = stylisticSets.Elements<W14.StyleSet>().Single();
+			Assert.That(styleSet.Id.Value, Is.EqualTo(stylisticSetId));
+			Assert.That(styleSet.Val.Value, Is.EqualTo(stylisticSetValue));
+		}
+
 
 		[Test]
 		public void GenerateWordDocForEntry_OneSenseWithGlossGeneratesCorrectResult()

openspec/changes/add-opentype-font-features/design.md

@@ -72,6 +72,14 @@ The longer product phases are: add OpenType features now, remove Graphite later
 
 **Rationale:** Golden WinForms/Views captures help Phase 1 verification and later Avalonia comparison. Exact pixels are appropriate for same-renderer regressions; tolerant or semantic comparisons are appropriate across GDI/Uniscribe and Skia/HarfBuzz.
 
+### 7. Word DOCX export maps only documented Word typography features
+
+**Decision:** Map FieldWorks `tag=value` font feature strings to Office 2010 WordprocessingML `w14` typography elements only where Microsoft documents a Word representation: ligatures, number form, number spacing, contextual alternatives, and stylistic sets.
+
+**Rationale:** CSS can preserve arbitrary OpenType feature tags, but WordprocessingML does not provide a general `font-feature-settings` equivalent. A best-effort documented subset avoids producing invalid DOCX while preserving the features Word can actually display and round-trip.
+
+**Alternatives considered:** Store arbitrary tags in custom XML or undocumented extension markup. Rejected because Word would not apply those settings to text rendering and the export would give users a false parity signal.
+
 ## Risks / Trade-offs
 
 | Risk | Mitigation |
@@ -82,6 +90,7 @@ The longer product phases are: add OpenType features now, remove Graphite later
 | OpenType feature labels are incomplete or unlocalized | Use resource-backed labels for common tags and fall back to the four-character tag. |
 | Test fonts cannot be redistributed | Confirm SIL Open Font License or another redistributable license before adding binaries. |
 | HarfBuzz/Skia visual output differs from GDI/Uniscribe | Compare shaping data first; use tolerant image comparisons for cross-renderer evidence. |
+| Word DOCX cannot represent every OpenType feature tag | Map only documented `w14` typography elements and document unsupported tags such as character variants and private features. |
 
 ## Migration Plan
 
@@ -92,6 +101,7 @@ The longer product phases are: add OpenType features now, remove Graphite later
 5. Add render snapshot scenarios using the merged render baseline infrastructure.
 6. Add test-only HarfBuzzSharp + SkiaSharp comparison tests in FieldWorks test projects.
 7. Update help/localized UI text.
+8. Add Word DOCX export mapping for the documented WordprocessingML subset and tests that inspect generated Open XML.
 
 Rollback strategy: disable the OpenType provider and native OpenType shaping path behind a feature flag or fallback path if regressions are found; Graphite and old Uniscribe behavior remain available.
 

openspec/changes/add-opentype-font-features/proposal.md

@@ -11,6 +11,7 @@ LT-22324 requires FieldWorks to split Font Features from the Graphite-only UI an
 - Update render/cache invalidation rules so feature changes are treated as layout-changing, especially after `001-render-speedup` is merged.
 - Add UI/component tests for font-feature controls and high-level visual rendering tests proving feature settings change output.
 - Add a test-only HarfBuzzSharp + SkiaSharp comparison path for shaping/rendering confidence toward future Avalonia migration; this path is not a production renderer in Phase 1.
+- Add Word DOCX export support for the subset of OpenType font features that Microsoft WordprocessingML can represent, and document unsupported feature tags.
 - Document research for later phases: Graphite removal while retaining WinForms, Avalonia alongside WinForms, and eventual WinForms retirement.
 
 ## Non-goals
@@ -39,5 +40,6 @@ LT-22324 requires FieldWorks to split Font Features from the Graphite-only UI an
 - **Managed rendering bridge:** `Src/Common/SimpleRootSite/RenderEngineFactory.cs` and post-`001-render-speedup` render/cache invalidation paths.
 - **Native C++ Views:** `Src/views/lib/UniscribeEngine.cpp`, `UniscribeSegment.cpp`, `Render.idh` only through additive interfaces if needed, and existing Graphite code for regression coverage.
 - **Tests:** FwCore dialog/control tests, SimpleRootSite/render-factory tests, native Views tests, and post-`001-render-speedup` render baseline/snapshot tests.
+- **Word DOCX export:** `Src/xWorks/WordStylesGenerator.cs`, configured dictionary/reversal DOCX tests in `Src/xWorks/xWorksTests/LcmWordGeneratorTests.cs`, and OpenType export documentation.
 - **Test-only dependencies:** HarfBuzzSharp + SkiaSharp in test/comparison projects only.
 - **Documentation/help:** FieldWorks Help and localized UI text for the renamed Font Features/Font Options surfaces.

openspec/changes/add-opentype-font-features/research.md

@@ -110,3 +110,24 @@ Useful references:
 - Test-only comparison: HarfBuzzSharp and SkiaSharp remain isolated to `RenderComparisonTests`. HarfBuzzSharp is used only as a test comparison path for shaping data; production rendering remains Uniscribe/Graphite.
 - Export audit: CSS already emits `font-feature-settings` and is covered by `GenerateCssForConfiguration_CharStyleFontFeaturesWorks`. Notebook export preserves writing-system `DefaultFontFeatures`. `WordStylesGenerator` did not show a feature-string mapping and should be tracked separately if Word export parity is required.
 - Help/docs: no existing FieldWorks help source for Font Options was found in this workspace. Phase 1 adds `Docs/opentype-font-features.md` to document the UI, storage model, temporary Graphite role, and export status.
+
+## Word DOCX Export Analysis
+
+Microsoft Word support for OpenType features is exposed in DOCX through a fixed Office 2010 WordprocessingML typography subset, not through an arbitrary CSS-style `font-feature-settings` property. The relevant Open XML SDK classes live under `DocumentFormat.OpenXml.Office2010.Word` and serialize into the `w14` namespace (`http://schemas.microsoft.com/office/word/2010/wordml`).
+
+Authoritative references gathered for the implementation:
+
+- Microsoft Support: Publisher/Office typography UI covers number styles, ligatures, stylistic sets, swash, stylistic alternates, true small caps, and font-dependent OpenType availability: https://support.microsoft.com/en-us/office/use-typographic-styles-to-increase-the-impact-of-your-publication-10e14096-452f-4d3b-9938-1d537572a377
+- Microsoft Support: Word compatibility notes identify ligatures, stylistic sets, contextual alternative characters, font-based kerning, and number forms/spacing as advanced typography features that may be preserved even when older Word versions do not display them: https://support.microsoft.com/en-us/office/about-ligatures-and-compatibility-64ffd007-6e5c-4d38-b87d-0935f37714fe
+- OpenType feature tag registry and definitions: https://learn.microsoft.com/en-us/typography/opentype/spec/featuretags, plus registered descriptions for `calt`, `clig`, `cvXX`, `kern`, `liga`, `lnum`, `onum`, `pnum`, `smcp`, `ss01`-`ss20`, and `tnum`.
+- Open XML SDK classes: `Ligatures` (`w14:ligatures`), `NumberingFormat` (`w14:numForm`), `NumberSpacing` (`w14:numSpacing`), `ContextualAlternatives` (`w14:cntxtAlts`), `StylisticSets` (`w14:stylisticSets`), and `StyleSet` (`w14:styleSet`).
+
+Planned DOCX subset:
+
+- `liga`, `clig`, `hlig`, and `dlig` map to the aggregate `w14:ligatures` value.
+- `lnum` and `onum` map to `w14:numForm` values `lining` and `oldStyle`.
+- `pnum` and `tnum` map to `w14:numSpacing` values `proportional` and `tabular`.
+- `calt` maps to `w14:cntxtAlts`.
+- `ss01` through `ss20` map to `w14:stylisticSets/w14:styleSet` with ids 1 through 20.
+
+Unsupported tags such as `cv01`-`cv99`, `smcp`, `c2sc`, `kern`, `salt`, `swsh`, and private/vendor tags do not have a documented arbitrary WordprocessingML feature-tag representation. They should be ignored by Word export while remaining valid for rendering and CSS export where those paths can consume them.

openspec/changes/add-opentype-font-features/specs/font-feature-settings/spec.md

@@ -96,3 +96,22 @@ FieldWorks SHALL update user-visible strings and help so Font Features are descr
 #### Scenario: Help covers OpenType features
 - **WHEN** a user opens the relevant FieldWorks Help topic
 - **THEN** the Help content SHALL describe OpenType Font Features and their relationship to Graphite during Phase 1
+
+### Requirement: Word DOCX export preserves supported OpenType font features
+FieldWorks SHALL export supported OpenType font feature settings into configured dictionary/reversal Word DOCX output using documented Microsoft WordprocessingML typography elements.
+
+#### Scenario: Character style features are exported to Word typography properties
+- **WHEN** a configured Word DOCX export includes a character style with supported OpenType feature settings
+- **THEN** the generated Word style run properties SHALL include the equivalent Office 2010 `w14` typography elements for supported features
+
+#### Scenario: Explicit run features are exported to Word typography properties
+- **WHEN** direct run font properties include supported OpenType feature settings
+- **THEN** generated run properties SHALL include the equivalent Office 2010 `w14` typography elements for supported features
+
+#### Scenario: Unsupported feature tags do not break Word export
+- **WHEN** a feature string contains tags that WordprocessingML cannot represent, such as `cv01`, `smcp`, or private feature tags
+- **THEN** Word export SHALL ignore those unsupported tags without failing the export or removing supported tags from the same feature string
+
+#### Scenario: Word export uses a documented subset
+- **WHEN** documentation describes Word export behavior
+- **THEN** it SHALL list the supported WordprocessingML subset and identify arbitrary CSS-style feature tags as unsupported by DOCX export

openspec/changes/add-opentype-font-features/tasks.md

@@ -80,3 +80,11 @@
 - [x] 10.4 Add `RenderEngineFactoryTests` coverage proving writing-system default OpenType features are normalized into `LgCharRenderProps.szFontVar`, equivalent feature strings reuse the renderer cache entry, and different feature strings create separate renderer cache entries. [Managed C# Tests]
 - [x] 10.5 Run `./test.ps1 -TestProject SimpleRootSiteTests -StartedBy agent`; result: `Total tests: 113`, `Passed: 113`. [Validation]
 - [x] 10.6 Run `./test.ps1 -SkipManaged -TestProject TestViews -StartedBy agent`; result: `Tests [Ok-Fail-Error]: [295-0-0]`. [Validation]
+
+## 11. Word DOCX Export Parity
+
+- [x] 11.1 Add OpenSpec requirements, research analysis, implementation plan, and tasks for Microsoft Word DOCX OpenType feature subset export. [OpenSpec]
+- [ ] 11.2 Add failing managed tests proving style and explicit run font features emit documented WordprocessingML `w14` typography elements. [Managed C# Tests]
+- [ ] 11.3 Implement a Word DOCX feature mapper that reuses the renderer-neutral parser and maps supported tags to `w14` elements. [Managed C#]
+- [ ] 11.4 Keep unsupported tags non-fatal and document Word export subset behavior in `Docs/opentype-font-features.md`. [Docs]
+- [ ] 11.5 Run targeted xWorks Word generator tests. [Validation]