Release 3.2.5

.vscode/settings.json

@@ -1,9 +1,9 @@
 {
-    "omnisharp.organizeImportsOnFormat": true,
     "dotnet.completion.showCompletionItemsFromUnimportedNamespaces": false,
     "coverage-gutters.coverageFileNames":[
         "coverage.info"
     ],
     "coverage-gutters.showGutterCoverage": false,
-    "coverage-gutters.showLineCoverage": true
+    "coverage-gutters.showLineCoverage": true,
+    "dotnet.formatting.organizeImportsOnFormat": true
 }

CHANGELOG.md

@@ -1,5 +1,34 @@
 # Changelog
 
+## 3.2.5
+
+- Fix a crash with the new whitespace handling introduced in 3.2.3 #191
+- Fix crash when the html contains 2 images with identical source path #193
+- Support margin auto for table alignment #194
+- Fix handling whitespace between runs #195
+- Whitelist more mime-types as specified by the IANA standard #196
+- Support EMF file #196
+- Correct handling of `figcaption` (allow nested phrasings) #197
+- Numbering list now supports type attribute `<ol type="1|a|A|i|I">` #198
+- Always restart nested numbering list #198
+- Fix table borders being removed even when the specified word table style has borders #199
+- Defensive code when download image stream is truncated #201
+- Table inside list is constrained to not exceed page margin #202
+- Table now supports width:auto for auto-fit content #202
+
+## 3.2.4
+
+- Fix a crash with the new whitespace handling introduced in 3.2.3 #191
+- Table inside list must be aligned with the list item #192
+
+## 3.2.3
+
+- Improve support of table alignment #187
+- Fix a crash if a span is empty
+- Heading with only digits should not be considered as a numbering #189
+- Fix whitespaces inserted between spans #179 and #185
+- Support percentage size (typically width:100%) for img node #188
+
 ## 3.2.2
 
 - Supports a feature to disable heading numbering #175

examples/Demo/Demo.csproj

@@ -21,6 +21,7 @@
 
   <ItemGroup>
     <EmbeddedResource Include="Resources\*" />
+    <Content Include="images\*" CopyToOutputDirectory="PreserveNewest"/>
   </ItemGroup>
 
 </Project>

examples/Demo/Resources/LargeImg.html

@@ -0,0 +1 @@
+<img src="The-Song-of-the-World.jpg" style="max-width:100%"/>

src/Html2OpenXml/Expressions/BlockElementExpression.cs

@@ -27,6 +27,7 @@ class BlockElementExpression: PhrasingElementExpression
 {
     private readonly OpenXmlLeafElement[]? defaultStyleProperties;
     protected readonly ParagraphProperties paraProperties = new();
+    protected TableProperties? tableProperties;
     // some style attributes, such as borders or bgcolor, will convert this node to a framed container
     protected bool renderAsFramed;
     private HtmlBorder styleBorder;
@@ -115,22 +116,44 @@ protected override IEnumerable<OpenXmlElement> Interpret (
     public override void CascadeStyles(OpenXmlElement element)
     {
         base.CascadeStyles(element);
-        if (!paraProperties.HasChildren || element is not Paragraph paragraph)
+        if (!paraProperties.HasChildren)
             return;
 
-        paragraph.ParagraphProperties ??= new ParagraphProperties();
-
-        var knownTags = new HashSet<string>();
-        foreach (var prop in paragraph.ParagraphProperties)
+        if (element is Paragraph paragraph)
         {
-            if (!knownTags.Contains(prop.LocalName))
-                knownTags.Add(prop.LocalName);
-        }
+            paragraph.ParagraphProperties ??= new ParagraphProperties();
 
-        foreach (var prop in paraProperties)
+            var knownTags = new HashSet<string>();
+            foreach (var prop in paragraph.ParagraphProperties)
+            {
+                if (!knownTags.Contains(prop.LocalName))
+                    knownTags.Add(prop.LocalName);
+            }
+
+            foreach (var prop in paraProperties)
+            {
+                if (!knownTags.Contains(prop.LocalName))
+                    paragraph.ParagraphProperties.AddChild(prop.CloneNode(true));
+            }
+        }
+        else if (tableProperties != null && element is Table table)
         {
-            if (!knownTags.Contains(prop.LocalName))
-                paragraph.ParagraphProperties.AddChild(prop.CloneNode(true));
+            var props = table.GetFirstChild<TableProperties>();
+            if (props is null)
+                return;
+
+            var knownTags = new HashSet<string>();
+            foreach (var prop in props)
+            {
+                if (!knownTags.Contains(prop.LocalName))
+                    knownTags.Add(prop.LocalName);
+            }
+
+            foreach (var prop in tableProperties)
+            {
+                if (!knownTags.Contains(prop.LocalName))
+                    props.AddChild(prop.CloneNode(true));
+            }
         }
     }
 
@@ -170,9 +193,12 @@ protected override void ComposeStyles (ParsingContext context)
 
         JustificationValues? align = Converter.ToParagraphAlign(styleAttributes!["text-align"]);
         if (!align.HasValue) align = Converter.ToParagraphAlign(node.GetAttribute("align"));
+        if (!align.HasValue) align = Converter.ToParagraphAlign(styleAttributes["justify-content"]);
         if (align.HasValue)
         {
             paraProperties.Justification = new() { Val = align };
+            tableProperties ??= new();
+            tableProperties.TableJustification = new() { Val = align.Value.ToTableRowAlignment() };
         }
 
 
@@ -194,7 +220,7 @@ protected override void ComposeStyles (ParsingContext context)
         }
 
         var margin = styleAttributes.GetMargin("margin");
-         Indentation? indentation = null;
+        Indentation? indentation = null;
         if (!margin.IsEmpty)
         {
             if (margin.Top.IsFixed || margin.Bottom.IsFixed)
@@ -345,7 +371,7 @@ private static Paragraph CreateParagraph(ParsingContext context, IList<OpenXmlEl
 
         context.CascadeStyles(p);
 
-        p.Append(CombineRuns(runs));
+        p.Append(runs);
 
         // in Html, if a paragraph is ending with a line break, it is ignored
         if (p.LastChild is Run run && run.LastChild is Break lineBreak)

src/Html2OpenXml/Expressions/FigureCaptionExpression.cs

@@ -1,81 +1,125 @@
-/* Copyright (C) Olivier Nizet https://github.com/onizet/html2openxml - All Rights Reserved
- * 
- * This source is subject to the Microsoft Permissive License.
- * Please see the License.txt file for more information.
- * All other rights reserved.
- * 
- * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY 
- * KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A
- * PARTICULAR PURPOSE.
- */
-using System.Collections.Generic;
-using System.Globalization;
-using System.Linq;
-using AngleSharp.Html.Dom;
-using DocumentFormat.OpenXml;
-using DocumentFormat.OpenXml.Wordprocessing;
-
-namespace HtmlToOpenXml.Expressions;
-
-/// <summary>
-/// Process the parsing of a <c>figcaption</c> element, which is used to describe an image.
-/// </summary>
-sealed class FigureCaptionExpression(IHtmlElement node) : PhrasingElementExpression(node)
-{
-
-    /// <inheritdoc/>
-    public override IEnumerable<OpenXmlElement> Interpret (ParsingContext context)
-    {
-        ComposeStyles(context);
-        var childElements = Interpret(context.CreateChild(this), node.ChildNodes);
-        if (!childElements.Any())
-            return [];
-
-        var p = new Paragraph (
-            new Run(
-                new Text("Figure ") { Space = SpaceProcessingModeValues.Preserve }
-            ),
-            new SimpleField(
-                new Run(
-                    new Text(AddFigureCaption(context).ToString(CultureInfo.InvariantCulture)))
-            ) { Instruction = " SEQ Figure \\* ARABIC " }
-        ) {
-            ParagraphProperties = new ParagraphProperties {
-                ParagraphStyleId = context.DocumentStyle.GetParagraphStyle(context.DocumentStyle.DefaultStyles.CaptionStyle),
-                KeepNext = new KeepNext()
-            }
-        };
-
-        if (childElements.First() is Run run) // any caption?
-        {
-            Text? t = run.GetFirstChild<Text>();
-            if (t != null)
-                t.Text = " " + t.InnerText; // append a space after the numero of the picture
-        }
-
-        return [p];
-    }
-
-    /// <summary>
-    /// Add a new figure caption to the document.
-    /// </summary>
-    /// <returns>Returns the id of the new figure caption.</returns>
-    private static int AddFigureCaption(ParsingContext context)
-    {
-        var figCaptionRef = context.Properties<int?>("figCaptionRef");
-        if (!figCaptionRef.HasValue)
-        {
-            figCaptionRef = 0;
-            foreach (var p in context.MainPart.Document.Descendants<SimpleField>())
-            {
-                if (p.Instruction == " SEQ Figure \\* ARABIC ")
-                    figCaptionRef++;
-            }
-        }
-        figCaptionRef++;
-
-        context.Properties("figCaptionRef", figCaptionRef);
-        return figCaptionRef.Value;
-    }
-}
+/* Copyright (C) Olivier Nizet https://github.com/onizet/html2openxml - All Rights Reserved
+ * 
+ * This source is subject to the Microsoft Permissive License.
+ * Please see the License.txt file for more information.
+ * All other rights reserved.
+ * 
+ * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY 
+ * KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A
+ * PARTICULAR PURPOSE.
+ */
+using System.Collections.Generic;
+using System.Globalization;
+using System.Linq;
+using AngleSharp.Html.Dom;
+using DocumentFormat.OpenXml;
+using DocumentFormat.OpenXml.Wordprocessing;
+
+namespace HtmlToOpenXml.Expressions;
+
+/// <summary>
+/// Process the parsing of a <c>figcaption</c> element, which is used to describe an image.
+/// </summary>
+sealed class FigureCaptionExpression(IHtmlElement node) : BlockElementExpression(node)
+{
+
+    /// <inheritdoc/>
+    public override IEnumerable<OpenXmlElement> Interpret (ParsingContext context)
+    {
+        ComposeStyles(context);
+        var childElements = Interpret(context.CreateChild(this), node.ChildNodes);
+
+        var figNumRef = new List<OpenXmlElement>() {
+            new Run(
+                new Text("Figure ") { Space = SpaceProcessingModeValues.Preserve }
+            ),
+            new SimpleField(
+                new Run(
+                    new Text(AddFigureCaption(context).ToString(CultureInfo.InvariantCulture)))
+            ) { Instruction = " SEQ Figure \\* ARABIC " }
+        };
+
+
+        if (!childElements.Any())
+        {
+            return [new Paragraph(figNumRef) {
+                ParagraphProperties = new ParagraphProperties {
+                    ParagraphStyleId = context.DocumentStyle.GetParagraphStyle(context.DocumentStyle.DefaultStyles.CaptionStyle),
+                    KeepNext = DetermineKeepNext(node),
+                }
+            }];
+        }
+
+        //Add the figure number references to the start of the first paragraph.
+        if(childElements.FirstOrDefault() is Paragraph p)
+        {
+           var properties = p.GetFirstChild<ParagraphProperties>();
+           p.InsertAfter(new Run(
+              new Text(" ") { Space = SpaceProcessingModeValues.Preserve }
+           ), properties);
+           p.InsertAfter(figNumRef[1], properties);
+           p.InsertAfter(figNumRef[0], properties);
+        }
+        else
+        {
+            // The first child of the figure caption is a table or something.
+            // Just prepend a new paragraph with the figure number reference.
+            childElements =  [
+                new Paragraph(figNumRef),
+                ..childElements
+            ];
+        }
+
+        foreach (var paragraph in childElements.OfType<Paragraph>())
+        {
+            paragraph.ParagraphProperties ??= new ParagraphProperties();
+            paragraph.ParagraphProperties.ParagraphStyleId ??= context.DocumentStyle.GetParagraphStyle(context.DocumentStyle.DefaultStyles.CaptionStyle);
+            //Keep caption paragraphs together.
+            paragraph.ParagraphProperties.KeepNext = new KeepNext();
+        }
+
+        if(childElements.OfType<Paragraph>().LastOrDefault() is Paragraph lastPara)
+        {
+            lastPara.ParagraphProperties!.KeepNext = DetermineKeepNext(node);
+        }
+
+        return childElements;
+    }
+
+    /// <summary>
+    /// Add a new figure caption to the document.
+    /// </summary>
+    /// <returns>Returns the id of the new figure caption.</returns>
+    private static int AddFigureCaption(ParsingContext context)
+    {
+        var figCaptionRef = context.Properties<int?>("figCaptionRef");
+        if (!figCaptionRef.HasValue)
+        {
+            figCaptionRef = 0;
+            foreach (var p in context.MainPart.Document.Descendants<SimpleField>())
+            {
+                if (p.Instruction == " SEQ Figure \\* ARABIC ")
+                    figCaptionRef++;
+            }
+        }
+        figCaptionRef++;
+
+        context.Properties("figCaptionRef", figCaptionRef);
+        return figCaptionRef.Value;
+    }
+
+    /// <summary>
+    /// Determines whether the KeepNext property should apply this this caption.
+    /// </summary>
+    /// <returns>A new <see cref="KeepNext"/> or null.</returns>
+    private static KeepNext? DetermineKeepNext(IHtmlElement node)
+    {
+        // A caption at the end of a figure will have no next sibling.
+        if(node.NextElementSibling is null)
+        {
+            return null;
+        }
+        return new();
+    }
+}