Browse Source

Break only long words in the Docs PDF renderer

pull/26216/head
maliming 2 months ago
parent
commit
ef0b3289c4
No known key found for this signature in database GPG Key ID: A646B9CB645ECEA4
  1. 7
      modules/docs/src/Volo.Docs.Domain/Volo/Docs/Projects/Pdf/DocsProjectPdfGeneratorOptions.cs
  2. 59
      modules/docs/src/Volo.Docs.Domain/Volo/Docs/Projects/Pdf/PdfSharpHtmlToPdfRenderer.cs
  3. 23
      modules/docs/test/Volo.Docs.Domain.Tests/Volo/Docs/Projects/Pdf/PdfSharpHtmlToPdfRenderer_Tests.cs

7
modules/docs/src/Volo.Docs.Domain/Volo/Docs/Projects/Pdf/DocsProjectPdfGeneratorOptions.cs

@ -60,8 +60,8 @@ public class DocsProjectPdfGeneratorOptions
HtmlStyle = @"
body { margin: 15px; line-height: 1.5; font-family: Arial, 'Liberation Sans', 'DejaVu Sans', sans-serif;}
a { text-decoration: none; word-break: break-all; overflow-wrap: break-word;}
li { word-break: break-all; overflow-wrap: break-word; }
a { text-decoration: none; overflow-wrap: break-word;}
li { overflow-wrap: break-word; }
.page {
page-break-after: always;
margin-bottom: 30px;
@ -77,7 +77,6 @@ public class DocsProjectPdfGeneratorOptions
background: #f8fafc;
white-space: pre-wrap;
word-wrap: break-word;
word-break: break-all;
}
pre code { padding: 0; border: none; }
code {
@ -88,6 +87,7 @@ public class DocsProjectPdfGeneratorOptions
}
pre {
position: relative;
word-break: break-all;
padding: 16px;
border-radius: 8px;
border: 1px solid #e2e8f0;
@ -104,7 +104,6 @@ public class DocsProjectPdfGeneratorOptions
th, td {
border: 1px solid #333;
padding: 6px 10px;
word-break: break-all;
overflow-wrap: break-word;
}";

59
modules/docs/src/Volo.Docs.Domain/Volo/Docs/Projects/Pdf/PdfSharpHtmlToPdfRenderer.cs

@ -54,6 +54,7 @@ public class PdfSharpHtmlToPdfRenderer : IHtmlToPdfRenderer, ITransientDependenc
htmlDocument.LoadHtml(html.Replace("\t", " "));
ReplaceUnsupportedImages(htmlDocument);
SplitMultiWordLinks(htmlDocument);
BreakLongWords(htmlDocument);
PreserveHtmlEntities(htmlDocument);
// HtmlRenderer ignores "page-break-after", so every document is laid out separately to start on a new page.
@ -156,6 +157,64 @@ public class PdfSharpHtmlToPdfRenderer : IHtmlToPdfRenderer, ITransientDependenc
}
}
protected virtual void BreakLongWords(HtmlDocument htmlDocument)
{
// HtmlRenderer does not support "overflow-wrap: break-word": a word wider than its line is clipped, and "word-break: break-all" breaks every word.
// So only the words that can not fit are allowed to break anywhere.
foreach (var textNode in htmlDocument.DocumentNode.Descendants().OfType<HtmlTextNode>().ToList())
{
if (textNode.ParentNode.Name is "style" or "script" or "title" || textNode.Ancestors("pre").Any())
{
continue;
}
var maxWordLength = GetMaxWordLength(textNode);
var parts = SplitWords(textNode.Text);
if (!parts.Any(part => IsLongWord(part, maxWordLength)))
{
continue;
}
foreach (var part in parts)
{
if (!IsLongWord(part, maxWordLength))
{
textNode.ParentNode.InsertBefore(htmlDocument.CreateTextNode(part), textNode);
continue;
}
var span = htmlDocument.CreateElement("span");
span.SetAttributeValue("style", "word-break: break-all");
span.AppendChild(htmlDocument.CreateTextNode(part));
textNode.ParentNode.InsertBefore(span, textNode);
}
textNode.Remove();
}
}
protected virtual int GetMaxWordLength(HtmlNode textNode)
{
// A line of the default style holds about 90 characters, but table columns are not equally wide and code uses a wider font.
var cell = textNode.Ancestors().FirstOrDefault(node => node.Name is "td" or "th");
if (cell == null)
{
return 40;
}
var columnCount = cell.ParentNode.ChildNodes
.Where(node => node.Name is "td" or "th")
.Sum(node => Math.Max(node.GetAttributeValue("colspan", 1), 1));
var maxLength = Math.Max(45 / columnCount, 6);
return textNode.Ancestors("code").Any() ? maxLength * 3 / 4 : maxLength;
}
private static bool IsLongWord(string text, int maxLength)
{
return !text.IsNullOrWhiteSpace() && HtmlEntity.DeEntitize(text).Length > maxLength;
}
protected virtual void PreserveHtmlEntities(HtmlDocument htmlDocument)
{
// HtmlRenderer splits "word-break: break-all" text into single characters before decoding it, so "&amp;" would be printed as is.

23
modules/docs/test/Volo.Docs.Domain.Tests/Volo/Docs/Projects/Pdf/PdfSharpHtmlToPdfRenderer_Tests.cs

@ -132,6 +132,24 @@ public class PdfSharpHtmlToPdfRenderer_Tests : DocsDomainTestBase
GetAnnotations(pdf, pdf.Pages[0]).Count.ShouldBe(60);
}
[Fact]
public void Should_Only_Let_Long_Words_Break_Anywhere()
{
var renderer = CreateTestRenderer();
var longWord = new string('a', 41);
renderer.BreakWords($"<p>Short words {longWord} end</p>")
.ShouldBe($"<p>Short words <span style=\"word-break: break-all\">{longWord}</span> end</p>");
renderer.BreakWords("<p>" + new string('a', 40) + "</p>").ShouldBe("<p>" + new string('a', 40) + "</p>");
renderer.BreakWords($"<pre><code>{longWord}</code></pre>").ShouldBe($"<pre><code>{longWord}</code></pre>");
renderer.BreakWords("<table><tr><td>Confirmation</td><td>IsEnabledForGetRequests</td><td>x</td></tr></table>")
.ShouldBe("<table><tr><td>Confirmation</td><td><span style=\"word-break: break-all\">IsEnabledForGetRequests</span></td><td>x</td></tr></table>");
renderer.BreakWords("<table><tr><td>x</td><td colspan='5'>Confirmation</td></tr></table>")
.ShouldBe("<table><tr><td>x</td><td colspan='5'><span style=\"word-break: break-all\">Confirmation</span></td></tr></table>");
renderer.BreakWords("<table><tr><td>AIManagement.Workspace</td><td><code>AIManagement.Workspace</code></td></tr></table>")
.ShouldBe("<table><tr><td>AIManagement.Workspace</td><td><code><span style=\"word-break: break-all\">AIManagement.Workspace</span></code></td></tr></table>");
}
[Fact]
public void Should_Split_Multi_Word_Links_Only()
{
@ -314,6 +332,11 @@ public class PdfSharpHtmlToPdfRenderer_Tests : DocsDomainTestBase
return Transform(html, SplitMultiWordLinks);
}
public string BreakWords(string html)
{
return Transform(html, BreakLongWords);
}
public string ReplaceImages(string html)
{
return Transform(html, ReplaceUnsupportedImages);

Loading…
Cancel
Save