diff --git a/Directory.Build.props b/Directory.Build.props index a5e00870..be7f02c7 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -2,7 +2,7 @@ Copyright 2009-$([System.DateTime]::Today.Year) Olivier Nizet enable - latest + preview enable 4.2.0 diff --git a/src/Html2OpenXml/Expressions/BlockElementExpression.cs b/src/Html2OpenXml/Expressions/BlockElementExpression.cs index a46a4d64..fc9558ee 100644 --- a/src/Html2OpenXml/Expressions/BlockElementExpression.cs +++ b/src/Html2OpenXml/Expressions/BlockElementExpression.cs @@ -22,6 +22,8 @@ namespace HtmlToOpenXml.Expressions; /// class BlockElementExpression: PhrasingElementExpression { + // 100% A4 page width expressed in Pct + internal const string FullPageWidthPct = "5000"; private readonly OpenXmlLeafElement[]? defaultStyleProperties; protected readonly ParagraphProperties paraProperties = new(); protected TableProperties? tableProperties; @@ -89,25 +91,8 @@ protected override IEnumerable Interpret ( ParsingContext context, IEnumerable childNodes) { return ComposeChildren(context, childNodes, paraProperties, - (runs) => { - if (styleAttributes.RequiresPageBreakBefore()) - { - runs.Add( - new Run( - new Break() { Type = BreakValues.Page }) - ); - runs.Add(new Run( - new LastRenderedPageBreak()) - ); - } - }, - (runs) => { - if (styleAttributes.RequiresPageBreakAfter()) - { - runs.Add(new Run( - new Break() { Type = BreakValues.Page })); - } - }); + prefixRuns: CreatePageBreakBeforeRuns(), + suffiRuns: CreatePageBreakAfterRuns()); } public override void CascadeStyles(OpenXmlElement element) @@ -301,18 +286,19 @@ protected override void ComposeStyles (ParsingContext context) /// The child parsing context. /// The list of child nodes. /// The parent paragraph properties to apply. - /// Optionally insert new runs at the beginning of the processing. - /// Optionally insert new runs at the end of the processing. + /// Prepend runs at the beginning of the processing (optional). + /// Append runs at the end of the processing (optional). internal static IEnumerable ComposeChildren(ParsingContext context, IEnumerable childNodes, ParagraphProperties paragraphProperties, - Action>? preAction = null, - Action>? postAction = null) + IEnumerable? prefixRuns = null, + IEnumerable? suffiRuns = null) { var runs = new List(); var flowElements = new List(); - preAction?.Invoke(runs); + if (prefixRuns != null) + runs.AddRange(prefixRuns); OpenXmlElement? previousElement = null; foreach (var child in childNodes) @@ -346,7 +332,8 @@ internal static IEnumerable ComposeChildren(ParsingContext conte } } - postAction?.Invoke(runs); + if (suffiRuns != null) + runs.AddRange(suffiRuns); if (runs.Count > 0) flowElements.Add(CreateParagraph(context, runs, paragraphProperties)); @@ -379,7 +366,6 @@ private static Paragraph CreateParagraph(ParsingContext context, IList /// Group all the paragraph inside a framed table. /// @@ -393,7 +379,10 @@ protected Table CreateFrame(IEnumerable childElements) TableProperties tableProperties; Table framedTable = new( tableProperties = new TableProperties { - TableWidth = new() { Type = TableWidthUnitValues.Pct, Width = "5000" } // 100% + TableWidth = new() { + Type = TableWidthUnitValues.Pct, + Width = FullPageWidthPct + } }, new TableGrid( new GridColumn() { Width = "9442" }), @@ -442,4 +431,25 @@ protected static int IncrementBookmarkId(ParsingContext context) context.Properties("bookmarkRef", bookmarkRef); return bookmarkRef.Value; } + + private IEnumerable CreatePageBreakBeforeRuns() + { + if (!styleAttributes.RequiresPageBreakBefore()) + yield break; + + yield return new Run( + new Break() { Type = BreakValues.Page }); + + yield return new Run( + new LastRenderedPageBreak()); + } + + private IEnumerable CreatePageBreakAfterRuns() + { + if (!styleAttributes.RequiresPageBreakAfter()) + yield break; + + yield return new Run( + new Break() { Type = BreakValues.Page }); + } } diff --git a/src/Html2OpenXml/Expressions/Numbering/ListContext.cs b/src/Html2OpenXml/Expressions/Numbering/ListContext.cs new file mode 100644 index 00000000..b28f3841 --- /dev/null +++ b/src/Html2OpenXml/Expressions/Numbering/ListContext.cs @@ -0,0 +1,28 @@ +/* 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 AngleSharp.Dom; + +namespace HtmlToOpenXml.Expressions; + +/// +/// Represents the current numbering state while traversing nested HTML lists. +/// +readonly record struct ListContext(string Name, int AbsNumId, int InstanceId, + int Level, DirectionMode? Dir, long MarginLeftDxa) +{ + public ListContext NextLevel(DirectionMode? dir, long extraMargin) + => this with { + Level = Level+1, + Dir = dir ?? Dir, + MarginLeftDxa = MarginLeftDxa + extraMargin + }; +} \ No newline at end of file diff --git a/src/Html2OpenXml/Expressions/Numbering/ListExpression.cs b/src/Html2OpenXml/Expressions/Numbering/ListExpression.cs index 636f312e..6cb94878 100644 --- a/src/Html2OpenXml/Expressions/Numbering/ListExpression.cs +++ b/src/Html2OpenXml/Expressions/Numbering/ListExpression.cs @@ -22,22 +22,22 @@ namespace HtmlToOpenXml.Expressions; /// sealed class ListExpression(IHtmlElement node) : NumberingExpressionBase(node) { - readonly record struct ListContext(string Name, int AbsNumId, int InstanceId, int Level, DirectionMode? Dir); - private readonly bool isOrderedTag = node.NodeName.Equals("ol", StringComparison.OrdinalIgnoreCase); - private long leftIndentation; - private int startValue = 1; - - - // https://www.w3schools.com/cssref/playdemo.php?filename=playcss_list-style-type + // https://developer.mozilla.org/en-US/docs/Web/CSS/Reference/Properties/list-style-type // https://answers.microsoft.com/en-us/msoffice/forum/all/custom-list-number-style/21a54399-4404-4c37-8843-2ccaaf827485 // Image bullet: http://officeopenxml.com/WPnumbering-imagesAsSymbol.php private static readonly HashSet supportedListTypes = - ["disc", "decimal", "square", "circle", "dash", + [with(StringComparer.OrdinalIgnoreCase), "disc", "decimal", "square", "circle", "dash", "lower-alpha", "upper-alpha", "lower-latin", "upper-latin", "lower-greek", "upper-greek", "lower-roman", "upper-roman", "decimal-tiered" /* not W3C compliant */]; + private const string StandaloneParagraphMarker = "list-marker"; private ParagraphStyleId? listParagraphStyleId; + private readonly bool isOrderedTag = node.NodeName.Equals("ol", StringComparison.OrdinalIgnoreCase); + private long listMarginLeftDxa; + private int startValue = 1, leftIndentation; + private bool isNestedList; + public override IEnumerable Interpret(ParsingContext context) @@ -46,16 +46,17 @@ public override IEnumerable Interpret(ParsingContext context) var liNodes = node.Children.Where(n => n.LocalName.Equals("li", StringComparison.OrdinalIgnoreCase)); if (!liNodes.Any()) return []; - if (renderAsFramed) + if (isOrderedTag && int.TryParse(node.GetAttribute("start"), out int val) && val > 1) + startValue = val; + + var margin = styleAttributes.GetMargin(); + if (margin.Left.IsFixed && margin.Left.Value != 0) { - return [CreateFrame(InterpretListItems(context, liNodes))]; + listMarginLeftDxa = margin.Left.ValueInDxa; + paraProperties.Indentation = null; // clear to prevent cascading on children } - return InterpretListItems(context, liNodes); - } - private IEnumerable InterpretListItems(ParsingContext context, IEnumerable liNodes) - { // W3C requires that nested list stands below a `li` element but some editors // don't care to respect the standard. Let's reparent those lists var nestedList = node.Children.Where(n => @@ -69,172 +70,204 @@ private IEnumerable InterpretListItems(ParsingContext context, I var listContext = context.Properties("listContext"); var parentContext = listContext; + + var numberingContext = context.CreateChild(this, isStyleScoped: !isNestedList); + var liParagraphs = InterpretListItems(numberingContext, listContext, liNodes).ToList(); + + // restore parent context + context.Properties("listContext", parentContext); + + // this marker is used to process only once any potential standalone para. + // we remove this as DivId requires a proper registration in WebSettings.DivIds + if (parentContext.Level == 0) + { + foreach (var p in liParagraphs.OfType().Where(p => p.ParagraphProperties?.DivId is not null)) + p.ParagraphProperties!.DivId!.Remove(); + } + + if (renderAsFramed) + { + return [CreateFrame(liParagraphs)]; + } + + return liParagraphs; + } + + private IEnumerable InterpretListItems(ParsingContext context, ListContext listContext, IEnumerable liNodes) + { var listStyle = GetListName(node, listContext.Name); - if (isOrderedTag && int.TryParse(node.GetAttribute("start"), out int val)) - startValue = val; - bool listMarginOnNumberingInstance = false; - if (listContext.InstanceId == 0 || listContext.Name != listStyle || leftIndentation > 0 || startValue != 1 ) + + if (listContext.InstanceId == 0 || listContext.Name != listStyle || startValue != 1) { var abstractNumId = GetOrCreateListTemplate(context, listStyle); - listContext = ConcretiseInstance(context, abstractNumId, listStyle, listContext.Level, leftIndentation); + listContext = ConcretiseInstance(context, abstractNumId, listStyle, listContext.Level, + listContext.MarginLeftDxa + listMarginLeftDxa); + leftIndentation = (int) (listContext.Level * LevelIndent + listMarginLeftDxa); listParagraphStyleId = GetStyleIdForListItem(context.DocumentStyle, node, defaultIfEmpty: false); - listMarginOnNumberingInstance = leftIndentation > 0; } else { - var dir = node.GetTextDirection(); - listContext = new ListContext(listContext.Name, listContext.AbsNumId, - listContext.InstanceId, listContext.Level + 1, dir ?? listContext.Dir); + listContext = listContext.NextLevel(node.GetTextDirection(), listMarginLeftDxa); + leftIndentation = listContext.Level * LevelIndent; } context.Properties("listContext", listContext); - var numberingContext = context.CreateChild(this, isStyleScoped: true); + isNestedList = listContext.Level > 1; - // +1 because index starts on 1 and not 0 - var level = Math.Min(listContext.Level, MaxLevel+1); foreach (IHtmlElement liNode in liNodes.Cast()) { var expression = new BlockElementExpression(liNode); - var childElements = expression.Interpret(numberingContext); + var childElements = expression.Interpret(context); if (!childElements.Any()) continue; // table must be aligned to the list item var tables = childElements.OfType(); - var tableIndentation = level * Indentation; - foreach (var table in tables) - { - var tableProperties = table.GetFirstChild(); - if (tableProperties == null) - table.PrependChild(tableProperties = new()); - - tableProperties.TableIndentation ??= new() { Width = tableIndentation * 2 }; - // ensure to restrain the table width to the list item - if (tableProperties.TableWidth?.Type?.Value == TableWidthUnitValues.Pct - && tableProperties.TableWidth?.Width?.Value == "5000") - { - tableProperties.TableWidth.Width = (5000 - tableIndentation).ToString(); - } - } + AdjustTableIndent(tables); // ensure to filter out any non-paragraph like any nested table var paragraphs = childElements.OfType(); var listItemStyleId = GetStyleIdForListItem(context.DocumentStyle, liNode); - if (paragraphs.Any()) - { - var p = paragraphs.First(); - p.ParagraphProperties ??= new(); - p.ParagraphProperties.ParagraphStyleId = listItemStyleId; - p.ParagraphProperties!.NumberingProperties ??= new NumberingProperties { - NumberingLevelReference = new() { Val = level - 1 }, - NumberingId = new() { Val = listContext.InstanceId } - }; - if (listContext.Dir.HasValue) { - p.ParagraphProperties.BiDi = new() { - Val = OnOffValue.FromBoolean(listContext.Dir == DirectionMode.Rtl) - }; - } - } - - // any standalone paragraphs must be aligned (indented) along its current level - foreach (var p in paragraphs.Skip(1)) + var firstPara = paragraphs.FirstOrDefault(); + if (firstPara != null) { - // if this is a list item paragraph, skip it - if (p.ParagraphProperties?.NumberingProperties is not null) - continue; + AdjustListItemParagraphIndent(firstPara, listContext, listItemStyleId); - p.ParagraphProperties ??= new(); - p.ParagraphProperties.ParagraphStyleId ??= (ParagraphStyleId?) listItemStyleId!.CloneNode(true); - SetListItemElementParagraphIndentationLeft(p.ParagraphProperties, level, leftIndentation); + // any standalone paragraphs must be aligned (indented) along its current level + AdjustStandaloneParagraphIndent(paragraphs.Skip(1), listItemStyleId); } foreach (var child in childElements) yield return child; } + } - context.Properties("listContext", parentContext); + private void AdjustTableIndent(IEnumerable
tables) + { + foreach (var table in tables) + { + var tableProperties = table.GetFirstChild(); + if (tableProperties == null) + table.PrependChild(tableProperties = new()); + + tableProperties.TableIndentation ??= new() { Width = leftIndentation }; + // ensure to restrain the table width to the list item + if (tableProperties.TableWidth?.Type?.Value == TableWidthUnitValues.Pct + && tableProperties.TableWidth?.Width?.Value == FullPageWidthPct) + { + tableProperties.TableWidth.Width = (5000 - leftIndentation).ToString(); + } + } + } + + private void AdjustListItemParagraphIndent(Paragraph p, ListContext listContext, ParagraphStyleId? listItemStyleId) + { + p.ParagraphProperties ??= new(); + p.ParagraphProperties.ParagraphStyleId = listItemStyleId; + p.ParagraphProperties.NumberingProperties ??= new NumberingProperties { + NumberingLevelReference = new() { Val = listContext.Level - 1 }, + NumberingId = new() { Val = listContext.InstanceId } + }; + + if (listContext.Dir.HasValue) + { + p.ParagraphProperties.BiDi = new() { + Val = OnOffValue.FromBoolean(listContext.Dir == DirectionMode.Rtl) + }; + } + + // if this
  • paragraph contains its own padding, this add to hanging + // if the container list contains its own padding, this add to left indent + var liExtraMargin = ParseIndentationLeft(p.ParagraphProperties); // parsed paragraph left indentation (if any) + if (liExtraMargin > 0 || listMarginLeftDxa > 0) + { + p.ParagraphProperties.Indentation ??= new(); + p.ParagraphProperties.Indentation.Hanging = (Hanging + liExtraMargin).ToString(CultureInfo.InvariantCulture); + p.ParagraphProperties.Indentation.Left = leftIndentation.ToString(CultureInfo.InvariantCulture); + } + } + + private void AdjustStandaloneParagraphIndent(IEnumerable paragraphs, ParagraphStyleId? listItemStyleId) + { + foreach (var p in paragraphs) + { + // if this is a list item paragraph, skip it + if (p.ParagraphProperties?.NumberingProperties is not null) + { + continue; + } + + p.ParagraphProperties ??= new(); + + // this iteration could encounter nested paragraphs. We detect when this is DivId + if (p.ParagraphProperties.DivId != null) + continue; + + p.ParagraphProperties.DivId = new DivId() { Val = StandaloneParagraphMarker }; + p.ParagraphProperties.ParagraphStyleId ??= (ParagraphStyleId?) listItemStyleId!.CloneNode(true); + + // if this paragraph contains its own padding, this add to left indent + var liExtraMargin = ParseIndentationLeft(p.ParagraphProperties); // parsed paragraph left indentation (if any) + + p.ParagraphProperties.Indentation ??= new(); + p.ParagraphProperties.Indentation.Hanging = "0"; + p.ParagraphProperties.Indentation.Left = (leftIndentation + liExtraMargin).ToString(CultureInfo.InvariantCulture); + } } /// /// Create a new instance of a list template. /// - private ListContext ConcretiseInstance(ParsingContext context, int abstractNumId, string listStyle, int currentLevel, long listMarginLeft) + private ListContext ConcretiseInstance(ParsingContext context, int abstractNumId, string listStyle, + int currentLevel, long listMarginLeftDxa) { ListContext listContext; var instanceId = GetListInstance(abstractNumId); - int overrideLevelIndex = 0; - var isOrderedTag = node.NodeName.Equals("ol", StringComparison.OrdinalIgnoreCase); var dir = node.GetTextDirection(); + var newLevel = Math.Min(currentLevel + 1, MaxLevel); // be sure to restart to 1 any nested ordered list if (currentLevel > 0 && isOrderedTag) { instanceId = IncrementInstanceId(context, abstractNumId, isReusable: false); - overrideLevelIndex = currentLevel; - listContext = new ListContext(listStyle, abstractNumId, instanceId.Value, currentLevel + 1, dir); + listContext = new ListContext(listStyle, abstractNumId, instanceId.Value, newLevel, dir, listMarginLeftDxa); } - else if (!instanceId.HasValue || !context.Converter.ContinueNumbering || listMarginLeft > 0) + else if (!instanceId.HasValue || !context.Converter.ContinueNumbering) { // create a new instance of that list template - bool isReusable = context.Converter.ContinueNumbering && listMarginLeft <= 0; + bool isReusable = context.Converter.ContinueNumbering; instanceId = IncrementInstanceId(context, abstractNumId, isReusable: isReusable); - listContext = new ListContext(listStyle, abstractNumId, instanceId.Value, currentLevel + 1, dir); + listContext = new ListContext(listStyle, abstractNumId, instanceId.Value, newLevel, dir, listMarginLeftDxa); } else // if the previous element is the same list style, - // we must restart the ordering to 0 + // we must restart the ordering to 1 if (node.IsPrecededByListElement(out var precedingElement) - && GetListName(precedingElement!) == listStyle) + && GetListName(precedingElement) == listStyle) { instanceId = IncrementInstanceId(context, abstractNumId, isReusable: false); - listContext = new ListContext(listStyle, abstractNumId, instanceId.Value, 1, dir); + listContext = new ListContext(listStyle, abstractNumId, instanceId.Value, 1, dir, listMarginLeftDxa); } else { - return new ListContext(listStyle, abstractNumId, instanceId.Value, currentLevel + 1, dir); + return new ListContext(listStyle, abstractNumId, instanceId.Value, newLevel, dir, listMarginLeftDxa); } var numbering = context.MainPart.NumberingDefinitionsPart!.Numbering!; - var levelOverride = CreateLevelOverride(numbering, abstractNumId, listContext.Level, startValue, listMarginLeft); numbering.Append( new NumberingInstance( new AbstractNumId() { Val = abstractNumId }, - levelOverride + new LevelOverride( + new StartOverrideNumberingValue() { Val = startValue } + ) { LevelIndex = newLevel - 1 } ) { NumberID = instanceId.Value }); return listContext; } - /// - /// Builds the list instance level-override (start value and optional indent from list margin-left). - /// - private static LevelOverride CreateLevelOverride(Numbering numbering, int abstractNumId, int listLevel, int startValue, long listMarginLeftDxa) - { - int ilvl = Math.Max(0, Math.Min(listLevel, MaxLevel + 1) - 1); - var levelOverride = new LevelOverride( - new StartOverrideNumberingValue() { Val = startValue } - ) { LevelIndex = ilvl }; - - if (listMarginLeftDxa <= 0) - return levelOverride; - - long leftDxa = listLevel * Indentation * 2L + listMarginLeftDxa; - var abstractNum = numbering.Elements().First(a => a.AbstractNumberId!.Value == abstractNumId); - var templateLevel = abstractNum.Elements().First(l => l.LevelIndex!.Value == ilvl); - var overrideLevel = (Level)templateLevel.CloneNode(true); - overrideLevel.PreviousParagraphProperties ??= new PreviousParagraphProperties(); - overrideLevel.PreviousParagraphProperties.Indentation = new Indentation { - Left = leftDxa.ToString(CultureInfo.InvariantCulture), - Hanging = Indentation.ToString() - }; - levelOverride.Append(overrideLevel); - - return levelOverride; - } - /// /// Resolve the list style to determine which NumberList style to apply. /// @@ -298,9 +331,6 @@ private static string GetListName(IElement listNode, string? parentName = null) /// private ParagraphStyleId? GetStyleIdForListItem(WordDocumentStyle documentStyle, IHtmlElement liNode, bool defaultIfEmpty = true) { - if (listParagraphStyleId != null) - return (ParagraphStyleId) listParagraphStyleId.Clone(); - foreach(var clsName in liNode.ClassList) { var styleId = documentStyle.GetStyle(clsName, StyleValues.Paragraph, ignoreCase: true); @@ -308,6 +338,9 @@ private static string GetListName(IElement listNode, string? parentName = null) return new ParagraphStyleId { Val = styleId }; } + if (listParagraphStyleId != null) + return (ParagraphStyleId) listParagraphStyleId.Clone(); + if (!defaultIfEmpty) return null; return documentStyle.GetParagraphStyle(documentStyle.DefaultStyles.ListParagraphStyle); } @@ -320,30 +353,10 @@ private static bool IsCascadingStyle(string styleName) return styleName == "decimal-tiered"; } - protected override void ComposeStyles(ParsingContext context) - { - base.ComposeStyles(context); - var margin = styleAttributes.GetMargin(); - if (!margin.IsEmpty && margin.Left.IsFixed && margin.Left.Value > 0) - leftIndentation = margin.Left.ValueInDxa; - } - - /// - /// Align non-numbered paragraphs with the listnode (level + list margin + li margin). - /// - private static void SetListItemElementParagraphIndentationLeft(ParagraphProperties pPr, int level, long listMarginLeftDxa) - { - long levelLeftDxa = level * Indentation * 2; - long liExtraDxa = ParseIndentationLeft(pPr); // parsed paragraph left indentation (if any) - long total = levelLeftDxa + listMarginLeftDxa + liExtraDxa; - - pPr.Indentation ??= new Indentation(); - pPr.Indentation.Left = total.ToString(CultureInfo.InvariantCulture); - } - private static long ParseIndentationLeft(ParagraphProperties? pPr) { - if (pPr?.Indentation?.Left?.Value is { } left && long.TryParse(left, NumberStyles.Integer, CultureInfo.InvariantCulture, out var dxa)) + if (pPr?.Indentation?.Left?.Value is { } left + && long.TryParse(left, NumberStyles.Integer, CultureInfo.InvariantCulture, out var dxa)) return dxa; return 0; } diff --git a/src/Html2OpenXml/Expressions/Numbering/NumberingExpressionBase.cs b/src/Html2OpenXml/Expressions/Numbering/NumberingExpressionBase.cs index 74944b28..ea5912fe 100644 --- a/src/Html2OpenXml/Expressions/Numbering/NumberingExpressionBase.cs +++ b/src/Html2OpenXml/Expressions/Numbering/NumberingExpressionBase.cs @@ -25,7 +25,9 @@ abstract class NumberingExpressionBase(IHtmlElement node) : BlockElementExpressi { /// Hard-coded value from Word public const int MaxLevel = 8; - protected const int Indentation = 360; + internal const int LevelIndent = 720; + internal const int Hanging = 360; + internal const string HangingStr = "360"; public const string HeadingNumberingName = "decimal-heading-multi"; private static readonly IReadOnlyDictionary predefinedNumberingLists = InitKnownLists(); /// Contains the list of templated list along with the AbstractNumbId @@ -49,22 +51,15 @@ protected int GetOrCreateListTemplate(ParsingContext context, string listName) } Numbering numberingPart = context.MainPart.NumberingDefinitionsPart!.Numbering!; - AbstractNum abstractNum; // at this stage, we have sanitized the list style so it's safe to grab them from the predefined template lists - if (predefinedNumberingLists.TryGetValue(listName, out var predefined)) - { + abstractNum = predefinedNumberingLists.TryGetValue(listName, out var predefined)? // If it's a predefined style, we clone it as usual - abstractNum = (AbstractNum)predefined.CloneNode(true); - } - else - { + (AbstractNum)predefined.CloneNode(true) : // If not found in predefined lists, listName contains a custom bullet character (e.g., "-") - abstractNum = CreateCustomBulletAbstractNum(listName); - } - - abstractNum = (AbstractNum) abstractNum.CloneNode(true); + CreateCustomBulletAbstractNum(listName); + abstractNum.AbstractNumberId = IncrementAbstractNumId(context, numberingPart); var level1 = abstractNum.GetFirstChild()!; @@ -180,14 +175,18 @@ protected int IncrementInstanceId(ParsingContext context, int abstractNumId, boo } /// - /// Discover the list of existing templates and instances, already registred in the document. + /// Discover the list of existing templates and instances, already registered in the document. /// private void InitNumberingIds(ParsingContext context) { if (isInitialized) return; knownAbsNumIds = context.Properties>("knownAbsNumIds"); knownInstanceIds = context.Properties>("knownInstanceIds"); - if (knownAbsNumIds != null && knownInstanceIds != null) return; + if (knownAbsNumIds != null && knownInstanceIds != null) + { + isInitialized = true; + return; + } knownAbsNumIds = []; knownInstanceIds = []; @@ -239,8 +238,8 @@ private static AbstractNum CreateCustomBulletAbstractNum(string customSymbol) LevelJustification = new() { Val = LevelJustificationValues.Left }, PreviousParagraphProperties = new() { Indentation = new() { - Left = ((lvlIndex + 1) * Indentation * 2).ToString(), - Hanging = Indentation.ToString() + Left = ((lvlIndex + 1) * LevelIndent).ToString(), + Hanging = HangingStr } } }); @@ -288,8 +287,8 @@ private static IReadOnlyDictionary InitKnownLists() LevelJustification = new() { Val = LevelJustificationValues.Left }, PreviousParagraphProperties = new() { Indentation = new() { - Left = ((lvlIndex + 1) * Indentation * 2).ToString(), - Hanging = Indentation.ToString() + Left = ((lvlIndex + 1) * LevelIndent).ToString(), + Hanging = HangingStr } }, NumberingSymbolRunProperties = useSymbol? new () { @@ -320,7 +319,7 @@ private static IReadOnlyDictionary InitKnownLists() LevelIndex = lvlIndex, LevelText = new() { Val = lvlText.ToString() }, PreviousParagraphProperties = new() { - Indentation = new() { Left = "0", Hanging = Indentation.ToString() } + Indentation = new() { Left = "0", Hanging = HangingStr } } }); } diff --git a/src/Html2OpenXml/Utilities/AngleSharpExtensions.cs b/src/Html2OpenXml/Utilities/AngleSharpExtensions.cs index 05ed18b4..711eb959 100644 --- a/src/Html2OpenXml/Utilities/AngleSharpExtensions.cs +++ b/src/Html2OpenXml/Utilities/AngleSharpExtensions.cs @@ -52,7 +52,7 @@ public static bool IsTopAnchor(this IHtmlAnchorElement element) /// /// Gets whether the given child is preceded by any list element (ol or ul). /// - public static bool IsPrecededByListElement(this INode child, out IElement? precedingElement) + public static bool IsPrecededByListElement(this INode child, [NotNullWhen(true)] out IElement? precedingElement) { precedingElement = null; diff --git a/test/HtmlToOpenXml.Tests/NumberingTests.cs b/test/HtmlToOpenXml.Tests/NumberingTests.cs index 75ab3a29..a820e357 100644 --- a/test/HtmlToOpenXml.Tests/NumberingTests.cs +++ b/test/HtmlToOpenXml.Tests/NumberingTests.cs @@ -1,6 +1,7 @@ using NUnit.Framework; using DocumentFormat.OpenXml.Wordprocessing; using DocumentFormat.OpenXml.Packaging; +using HtmlToOpenXml.Expressions; namespace HtmlToOpenXml.Tests { @@ -389,6 +390,29 @@ public void OverrideStartNumber_WithOl_ShouldSucceed() Is.EqualTo(startLevel)); } + [Test(Description = "Allow to specify another start value for the first item of a nested `ol` list")] + public void OverrideStartNumber_WithNestedOl_ShouldSucceed() + { + const short startLevel = 3; + var elements = converter.Parse($""" +
      +
    1. One +
      1. Three
      +
    2. +
    + """); + Assert.That(elements, Has.Count.EqualTo(2)); + Assert.That(elements, Has.All.TypeOf()); + + var instances = mainPart.NumberingDefinitionsPart?.Numbering? + .Elements(); + Assert.That(instances, Has.Exactly(2).Items); + Assert.That(instances.First().GetFirstChild()?.StartOverrideNumberingValue?.Val?.Value, + Is.EqualTo(startLevel + 1)); + Assert.That(instances.Last().GetFirstChild()?.StartOverrideNumberingValue?.Val?.Value, + Is.EqualTo(startLevel)); + } + [Test(Description = "Allow to specify another start value for the first item of a `ul` list")] public void OverrideStartNumber_WithUl_ShouldBeIgnored() { @@ -566,8 +590,8 @@ public void NestedNumberList_ReturnsIncrementalIndentation() { var level = levels.ElementAt(i); var ident = level.PreviousParagraphProperties?.Indentation; - Assert.That(ident?.Hanging?.Value, Is.EqualTo("360")); - Assert.That(Convert.ToInt32(ident?.Left?.Value), Is.EqualTo((i + 1) * 2 * 360)); + Assert.That(ident?.Hanging?.Value, Is.EqualTo(NumberingExpressionBase.HangingStr)); + Assert.That(Convert.ToInt32(ident?.Left?.Value), Is.EqualTo((i + 1) * NumberingExpressionBase.LevelIndent)); TestContext.Out.WriteLine($"{i}. {ident?.Left?.Value}"); } } @@ -617,7 +641,7 @@ public void NestedParagraph_ReturnsIndentedItems() var elements = converter.Parse(@"
    • Paragraph text

      -

      Paragraph text

      +

      Paragraph text bis

    "); @@ -637,7 +661,7 @@ public void NestedParagraph_ReturnsIndentedItems() Has.All.EqualTo("ListParagraph"), "All paragraphs use the same paragraph style"); Assert.That(elements.Last().GetFirstChild()?.Indentation?.Left?.Value, - Is.EqualTo("720"), + Is.EqualTo(NumberingExpressionBase.LevelIndent.ToString()), "Last standalone paragraph is aligned with the level 1"); } } @@ -665,7 +689,7 @@ public void NestedTable_ReturnsAlignedTable() var tableProperties = table.GetFirstChild(); Assert.That(tableProperties, Is.Not.Null); Assert.That(tableProperties.TableIndentation, Is.Not.Null); - Assert.That(tableProperties.TableIndentation.Width?.Value, Is.EqualTo(720 * (i+1))); + Assert.That(tableProperties.TableIndentation.Width?.Value, Is.EqualTo(NumberingExpressionBase.LevelIndent * (i+1))); Assert.That(tableProperties.TableWidth, Is.Not.Null); Assert.That(tableProperties.TableWidth.Type?.Value, Is.EqualTo(TableWidthUnitValues.Pct)); Assert.That(tableProperties.TableWidth.Width?.HasValue, Is.True); @@ -673,11 +697,12 @@ public void NestedTable_ReturnsAlignedTable() } } - [Test] - public async Task LowerGreekList_ReturnsListWithGreekNumbering() + [TestCase("lower-greek", nameof(NumberFormatValues.LowerLetter))] + [TestCase("upper-greek", nameof(NumberFormatValues.UpperLetter))] + public async Task GreekList_ReturnsListWithGreekNumbering(string listStyle, string numberFormat) { - await converter.ParseBody(@" -
      + await converter.ParseBody($@" +
      1. Item 1
      2. Item 2
      " @@ -690,41 +715,17 @@ await converter.ParseBody(@" var absNum = numbering.Elements().SingleOrDefault(); Assert.That(absNum, Is.Not.Null); - Assert.That(absNum.AbstractNumDefinitionName?.Val?.Value, Is.EqualTo("lower-greek")); + Assert.That(absNum.AbstractNumDefinitionName?.Val?.Value, Is.EqualTo(listStyle)); var level = absNum.Elements().First(); using (Assert.EnterMultipleScope()) { - Assert.That(level.NumberingFormat?.Val?.Value, Is.EqualTo(NumberFormatValues.LowerLetter)); + Assert.That(((DocumentFormat.OpenXml.IEnumValue) level.NumberingFormat?.Val?.Value!).Value, Is.EqualTo(numberFormat).IgnoreCase); Assert.That(level.LevelText?.Val?.Value, Is.EqualTo("%1.")); } } - [Test] - public async Task UpperGreekList_ReturnsListWithGreekNumbering() - { - await converter.ParseBody(@" -
        -
      1. Item 1
      2. -
      " - ); - - var numbering = mainPart.NumberingDefinitionsPart!.Numbering!; - var absNum = numbering.Elements().SingleOrDefault(); - - Assert.That(absNum, Is.Not.Null); - Assert.That(absNum.AbstractNumDefinitionName?.Val?.Value, Is.EqualTo("upper-greek")); - - var level = absNum.Elements().First(); - - using (Assert.EnterMultipleScope()) - { - Assert.That(level.NumberingFormat?.Val?.Value, Is.EqualTo(NumberFormatValues.UpperLetter)); - Assert.That(level.LevelText?.Val?.Value, Is.EqualTo("%1.")); - } - } - [Test] public async Task CustomBulletList_ReturnsListWithCustomStyle() { @@ -757,9 +758,6 @@ public async Task CustomBulletList_ReturnsListWithCustomStyle() AssertThatOpenXmlDocumentIsValid(); } - /// Level-1 list indent plus 18pt <ol> margin-left. - private const string Level1ListIndent_AddedWith_18PtMargin_DXA_Value = "1080"; - [Test(Description = "List container margin-left must not create a separate abstractNum for the same list-style-type")] public void ListContainerMarginLeft_SharesAbstractNumAcrossDifferentMargins() { @@ -780,68 +778,71 @@ public void ListContainerMarginLeft_SharesAbstractNumAcrossDifferentMargins() Assert.That(instances, Has.Count.GreaterThanOrEqualTo(2)); } - [Test(Description = "Nested ol margin-left stacks with numbering level indent on each list")] - public void ListContainerMarginLeft_NestedList_AppliesLevelAndMargin() + [Test(Description = "Continuation paragraphs inside a margined list item align with the numbered line")] + public void ListContainerMarginLeft_MultiParagraphListItem_Aligned() { var elements = converter.Parse(@" -
        -
      1. Outer -
        1. Inner
        +
          +
        1. One

          +

          Two

        "); var paragraphs = elements.OfType().ToList(); Assert.That(paragraphs, Has.Count.EqualTo(2)); - - var outer = paragraphs.Single(p => - p.ParagraphProperties?.NumberingProperties?.NumberingLevelReference?.Val?.Value == 0); - var inner = paragraphs.Single(p => - p.ParagraphProperties?.NumberingProperties?.NumberingLevelReference?.Val?.Value == 1); - - var numbering = mainPart.NumberingDefinitionsPart!.Numbering!; - var outerNumId = outer.ParagraphProperties!.NumberingProperties!.NumberingId!.Val!.Value; - var innerNumId = inner.ParagraphProperties!.NumberingProperties!.NumberingId!.Val!.Value; + Assert.That(elements.Cast().Select(e => + e.ParagraphProperties?.Indentation), + Has.All.Not.Null, + "All paragraphs have an indentation marker"); using (Assert.EnterMultipleScope()) { - Assert.That(GetListInstanceLevelIndentLeft(numbering, outerNumId), Is.EqualTo(Level1ListIndent_AddedWith_18PtMargin_DXA_Value)); - Assert.That(GetListInstanceLevelIndentLeft(numbering, innerNumId, ilvl: 1), Is.EqualTo("1800")); + var indentation0 = elements[0].GetFirstChild()?.Indentation!; + var indentation1 = elements[1].GetFirstChild()?.Indentation!; + + Assert.That(paragraphs[0].ParagraphProperties?.NumberingProperties, Is.Not.Null); + Assert.That(paragraphs[1].ParagraphProperties?.NumberingProperties, Is.Null); + + Assert.That(indentation0.Hanging?.Value, Is.EqualTo(NumberingExpressionBase.HangingStr)); + Assert.That(indentation0.Left?.Value, Is.EqualTo("1120"), "720 (LevelIndent) + 400 (20pt)"); + Assert.That(indentation1.Hanging?.Value, Is.EqualTo("0")); + Assert.That(indentation1.Left?.Value, Is.EqualTo("1120"), "720 (LevelIndent) + 400 (20pt)"); } } - [Test(Description = "Continuation paragraphs inside a margined list item align with the numbered line")] - public void ListContainerMarginLeft_MultiParagraphListItem_Aligned() + [Test(Description = "Nested ol margin-left stacks with numbering level indent on each list")] + public void ListContainerMarginLeft_NestedList_AppliesLevelAndMargin() { var elements = converter.Parse(@" -
          -
        1. One

          Two

        2. +
            +
          1. Outer +
            1. Inner
            +
          "); var paragraphs = elements.OfType().ToList(); Assert.That(paragraphs, Has.Count.EqualTo(2)); + Assert.That(elements.Cast().Select(e => + e.ParagraphProperties?.Indentation), + Has.All.Not.Null, + "All paragraphs have an indentation marker"); using (Assert.EnterMultipleScope()) { - Assert.That(paragraphs[0].ParagraphProperties?.NumberingProperties, Is.Not.Null); - Assert.That(paragraphs[1].ParagraphProperties?.NumberingProperties, Is.Null); - Assert.That(paragraphs[1].ParagraphProperties?.Indentation?.Left?.Value, Is.EqualTo(Level1ListIndent_AddedWith_18PtMargin_DXA_Value)); + Assert.That(elements.Cast().Select(e => + e.ParagraphProperties?.NumberingProperties?.NumberingId?.Val?.Value), + Has.All.Not.Null, + "All paragraphs are linked to list instances"); + + var indentation0 = elements[0].GetFirstChild()?.Indentation!; + var indentation1 = elements[1].GetFirstChild()?.Indentation!; + Assert.That(indentation0.Hanging?.Value, Is.EqualTo(NumberingExpressionBase.HangingStr)); + Assert.That(indentation0.Left?.Value, Is.EqualTo("1120"), "720 (LevelIndent) + 400 (20pt)"); + Assert.That(indentation1.Hanging?.Value, Is.EqualTo(NumberingExpressionBase.HangingStr)); + Assert.That(indentation1.Left?.Value, Is.EqualTo("1440"), "2*720 (LevelIndent) + 400 (20pt)"); } } - [Test(Description = "Unordered lists apply ol margin-left the same way as ordered lists")] - public void ListContainerMarginLeft_AppliesToUnorderedList() - { - var elements = converter.Parse(@"
          • Bullet
          "); - var p = (Paragraph)elements.Single(); - var numId = p.ParagraphProperties!.NumberingProperties!.NumberingId!.Val!.Value; - var numbering = mainPart.NumberingDefinitionsPart!.Numbering!; - Assert.That(p.ParagraphProperties?.NumberingProperties, Is.Not.Null); - Assert.That(GetListInstanceLevelIndentLeft(numbering, numId), Is.EqualTo(Level1ListIndent_AddedWith_18PtMargin_DXA_Value)); - var overrideLevel = GetListInstanceLevelOverride(numbering, numId); - Assert.That(overrideLevel?.NumberingFormat?.Val?.Value, Is.EqualTo(NumberFormatValues.Bullet), - "Level override must clone the template level so bullet markers still render"); - } - [Test] public async Task ListContainer_Styling_CascadeToListItems() { @@ -862,25 +863,6 @@ public async Task ListContainer_Styling_CascadeToListItems() } } - private static string? GetListInstanceLevelIndentLeft(Numbering numbering, int numId, int ilvl = 0) - { - return GetListInstanceLevelOverride(numbering, numId, ilvl)?.PreviousParagraphProperties?.Indentation?.Left?.Value; - } - - private static Level? GetListInstanceLevelOverride(Numbering numbering, int numId, int ilvl = 0) - { - var instance = numbering.Elements().Single(i => i.NumberID!.Value == numId); - foreach (var levelOverride in instance.Elements()) - { - foreach (var level in levelOverride.Elements()) - { - if (level.LevelIndex?.Value == ilvl) - return level; - } - } - return null; - } - /// /// A nested ul type attribute must use its own bullet, not the parent marker /// @@ -917,31 +899,35 @@ public async Task UnorderedList_CssListStyleType_OverridesTypeAttribute() AssertThatOpenXmlDocumentIsValid(); } - [Test(Description = "Nested ordered list start value is reflected in the marker value")] - public async Task NestedOrderedList_StartValue_IsAddedToMarkerValue() - { - await converter.ParseBody(@"
          1. One
            1. Ten
          "); - - var paragraphs = mainPart.Document!.Body!.Elements().ToList(); - Assert.That(GetListMarkerNumberingValue(paragraphs.Last()), Is.EqualTo("10")); - AssertThatOpenXmlDocumentIsValid(); - } - [Test(Description = "Paragraph margin-left inside a list item must be applied independently of the list item indentation")] - public async Task ListItemWithMultipleParagraphs_AppliesIndependentParagraphIndentation() + public async Task ListContainerAndParagraphs_AppliesExtraMargin() { - await converter.ParseBody(@"
          1. First

            Last

          "); - var paragraphs = mainPart.Document?.Body!.Elements().ToList(); - var firstParagraph = paragraphs?.First(); - var lastParagraph = paragraphs?.Last(); + var elements = converter.Parse(""" +
            +
          1. +

            First

            +

            Last

            +
          2. +
          + """); + + var paragraphs = elements.OfType().ToList(); + Assert.That(paragraphs, Has.Count.EqualTo(2)); + Assert.That(elements.Cast().Select(e => + e.ParagraphProperties?.Indentation), + Has.All.Not.Null, + "All paragraphs have an indentation marker"); - var firstParaIndent = firstParagraph?.ParagraphProperties?.Indentation?.Left?.Value; - var lastParaIndent = lastParagraph?.ParagraphProperties?.Indentation?.Left?.Value; + using (Assert.EnterMultipleScope()) + { + var indentation0 = elements[0].GetFirstChild()?.Indentation!; + var indentation1 = elements[1].GetFirstChild()?.Indentation!; - Assert.That(firstParaIndent, Is.Null, "The first paragraph should not have direct indentation because indentation is assigned through the list levelOverride instance."); - Assert.That(lastParaIndent, Is.Not.Null); - // i.e. level indentation + paragraph indentation + list left indentation = 720+360+360 = 1440 - Assert.That(lastParaIndent, Is.EqualTo("1440"), "The last paragraph must have its own additional indentation from its margin-left. qith value equal to 360 dxa"); + Assert.That(indentation0.Hanging?.Value, Is.EqualTo(NumberingExpressionBase.HangingStr)); + Assert.That(indentation0.Left?.Value, Is.EqualTo("1120"), "720 (LevelIndent) + 400 (20pt)"); + Assert.That(indentation1.Hanging?.Value, Is.EqualTo("0")); + Assert.That(indentation1.Left?.Value, Is.EqualTo("1520"), "720 (LevelIndent) + 400 (20pt) + 400 (20pt)"); + } } private string? GetBulletText(Paragraph paragraph) @@ -954,15 +940,5 @@ public async Task ListItemWithMultipleParagraphs_AppliesIndependentParagraphInde var abstractNum = numbering.Elements().Single(a => a.AbstractNumberId?.Value == instance.AbstractNumId!.Val!.Value); return abstractNum.Elements().First(l => l.LevelIndex?.Value == level).LevelText?.Val?.Value; } - - private string? GetListMarkerNumberingValue(Paragraph paragraph) - { - var numberingProperties = paragraph.ParagraphProperties?.NumberingProperties; - var numId = numberingProperties?.NumberingId?.Val?.Value; - var level = numberingProperties?.NumberingLevelReference?.Val?.Value; - var numbering = mainPart.NumberingDefinitionsPart!.Numbering!; - var instance = numbering.Elements().Single(i => i.NumberID?.Value == numId); - return instance.GetFirstChild()?.GetFirstChild()?.Val; - } } } diff --git a/test/HtmlToOpenXml.Tests/TableTests.cs b/test/HtmlToOpenXml.Tests/TableTests.cs index 92366e63..292c8a5c 100644 --- a/test/HtmlToOpenXml.Tests/TableTests.cs +++ b/test/HtmlToOpenXml.Tests/TableTests.cs @@ -713,10 +713,10 @@ public void CellBorders_ShouldNotPropagate_OnRuns() Assert.That(runs.First().RunProperties?.Border, Is.Null); } - [TestCase("100%", "pct", "5000")] + [TestCase("100%", "pct", Expressions.BlockElementExpression.FullPageWidthPct)] [TestCase("auto", "auto", "0")] [TestCase("120px", "dxa", "1800")] - [TestCase("", "pct", "5000", Description = "Defaults to 100%")] + [TestCase("", "pct", Expressions.BlockElementExpression.FullPageWidthPct, Description = "Defaults to 100%")] public void Width_ReturnsRefineTableWidth(string width, string expectedUnit, string expectedValue) { var elements = converter.Parse(@$"