[backport: 1.4] Better linebreaks (#15658)

compiler/docgen.nim

@@ -867,19 +867,13 @@ proc genItem(d: PDoc, n, nameNode: PNode, k: TSymKind, docFlags: DocFlags) =
         xmltree.escape(getPlainDocstring(e).docstringSummary))
 
   d.toc[k].add(ropeFormatNamedVars(d.conf, getConfigVar(d.conf, "doc.item.toc"),
-    ["name", "header", "desc", "itemID", "header_plain", "itemSym",
+    ["name", "header_plain", "itemSymOrIDEnc"],
-      "itemSymOrID", "itemSymEnc", "itemSymOrIDEnc", "attype"],
+    [nameRope, plainNameRope, symbolOrIdEncRope]))
-    [rope(getName(d, nameNode, d.splitAfter)), result, comm,
-      itemIDRope, plainNameRope, plainSymbolRope, symbolOrIdRope,
-      plainSymbolEncRope, symbolOrIdEncRope, attype]))
 
   d.tocTable[k].mgetOrPut(cleanPlainSymbol, nil).add(ropeFormatNamedVars(
     d.conf, getConfigVar(d.conf, "doc.item.tocTable"),
-    ["name", "header", "desc", "itemID", "header_plain", "itemSym",
+    ["name", "header_plain", "itemSymOrID", "itemSymOrIDEnc"],
-     "itemSymOrID", "itemSymEnc", "itemSymOrIDEnc", "attype"],
+    [nameRope, plainNameRope, rope(symbolOrId.replace(",", ",<wbr>")), symbolOrIdEncRope]))
-    [rope(getName(d, nameNode, d.splitAfter)), result, comm,
-     itemIDRope, plainNameRope, plainSymbolRope,
-     symbolOrIdRope, plainSymbolEncRope, symbolOrIdEncRope, attype]))
 
   # Ironically for types the complexSymbol is *cleaner* than the plainName
   # because it doesn't include object fields or documentation comments. So we

config/nimdoc.cfg

@@ -57,13 +57,13 @@ $seeSrc
 # See doc.item for available substitution variables.
 doc.item.toc = """
   <li><a class="reference" href="#$itemSymOrIDEnc"
-    title="$header_plain">$name<span class="attachedType">$attype</span></a></li>
+    title="$header_plain">$name</a></li>
 """
 
 # This is used for TOC items which are grouped by the same name (e.g. procs).
 doc.item.tocTable = """
   <li><a class="reference" href="#$itemSymOrIDEnc"
-    title="$header_plain">$itemSymOrID<span class="attachedType">$attype</span></a></li>
+    title="$header_plain">$itemSymOrID</a></li>
 """
 
 

doc/nimdoc.css

@@ -155,7 +155,6 @@ body {
 
 .three.columns {
   width: 22%;
-  line-break: anywhere;
 }
 
 .nine.columns {

nimdoc/test_out_index_dot_html/expected/index.html

@@ -96,7 +96,7 @@ function main() {
   <ul class="simple simple-toc-section">
       <ul class="simple nested-toc-section">foo
       <li><a class="reference" href="#foo"
-    title="foo()">foo<span class="attachedType"></span></a></li>
+    title="foo()">foo</a></li>
 
   </ul>
 

nimdoc/testproject/expected/subdir/subdir_b/utils.html

@@ -101,7 +101,7 @@ function main() {
   <ul class="simple simple-toc-section">
       <li><a class="reference" href="#SomeType"
     title="SomeType = enum
-  enumValueA, enumValueB, enumValueC"><wbr />Some<wbr />Type<span class="attachedType"></span></a></li>
+  enumValueA, enumValueB, enumValueC">SomeType</a></li>
 
   </ul>
 </li>
@@ -110,7 +110,7 @@ function main() {
   <ul class="simple simple-toc-section">
       <ul class="simple nested-toc-section">someType
       <li><a class="reference" href="#someType_2"
-    title="someType(): SomeType">someType_2<span class="attachedType">SomeType</span></a></li>
+    title="someType(): SomeType">someType_2</a></li>
 
   </ul>
 
@@ -120,11 +120,11 @@ function main() {
   <a class="reference reference-toplevel" href="#18" id="68">Templates</a>
   <ul class="simple simple-toc-section">
       <li><a class="reference" href="#aEnum.t"
-    title="aEnum(): untyped"><wbr />a<wbr />Enum<span class="attachedType"></span></a></li>
+    title="aEnum(): untyped">aEnum</a></li>
   <li><a class="reference" href="#bEnum.t"
-    title="bEnum(): untyped"><wbr />b<wbr />Enum<span class="attachedType"></span></a></li>
+    title="bEnum(): untyped">bEnum</a></li>
   <li><a class="reference" href="#fromUtilsGen.t"
-    title="fromUtilsGen(): untyped"><wbr />from<wbr />Utils<wbr />Gen<span class="attachedType"></span></a></li>
+    title="fromUtilsGen(): untyped">fromUtilsGen</a></li>
 
   </ul>
 </li>

nimdoc/testproject/expected/testproject.html

@@ -102,13 +102,13 @@ function main() {
   <ul class="simple simple-toc-section">
       <li><a class="reference" href="#A"
     title="A {.inject.} = enum
-  aA"><wbr />A<span class="attachedType"></span></a></li>
+  aA">A</a></li>
   <li><a class="reference" href="#B"
     title="B {.inject.} = enum
-  bB"><wbr />B<span class="attachedType"></span></a></li>
+  bB">B</a></li>
   <li><a class="reference" href="#Foo"
     title="Foo = enum
-  enumValueA2"><wbr />Foo<span class="attachedType"></span></a></li>
+  enumValueA2">Foo</a></li>
 
   </ul>
 </li>
@@ -116,7 +116,7 @@ function main() {
   <a class="reference reference-toplevel" href="#8" id="58">Vars</a>
   <ul class="simple simple-toc-section">
       <li><a class="reference" href="#aVariable"
-    title="aVariable: array[1, int]"><wbr />a<wbr />Variable<span class="attachedType"></span></a></li>
+    title="aVariable: array[1, int]">aVariable</a></li>
 
   </ul>
 </li>
@@ -124,13 +124,13 @@ function main() {
   <a class="reference reference-toplevel" href="#10" id="60">Consts</a>
   <ul class="simple simple-toc-section">
       <li><a class="reference" href="#C_A"
-    title="C_A = 0x7FF0000000000000&apos;f64"><wbr />C_<wbr />A<span class="attachedType"></span></a></li>
+    title="C_A = 0x7FF0000000000000&apos;f64">C_A</a></li>
   <li><a class="reference" href="#C_B"
-    title="C_B = 0o377&apos;i8"><wbr />C_<wbr />B<span class="attachedType"></span></a></li>
+    title="C_B = 0o377&apos;i8">C_B</a></li>
   <li><a class="reference" href="#C_C"
-    title="C_C = 0o277&apos;i8"><wbr />C_<wbr />C<span class="attachedType"></span></a></li>
+    title="C_C = 0o277&apos;i8">C_C</a></li>
   <li><a class="reference" href="#C_D"
-    title="C_D = 0o177777&apos;i16"><wbr />C_<wbr />D<span class="attachedType"></span></a></li>
+    title="C_D = 0o177777&apos;i16">C_D</a></li>
 
   </ul>
 </li>
@@ -139,149 +139,149 @@ function main() {
   <ul class="simple simple-toc-section">
       <ul class="simple nested-toc-section">z10
       <li><a class="reference" href="#z10"
-    title="z10()">z10<span class="attachedType"></span></a></li>
+    title="z10()">z10</a></li>
 
   </ul>
   <ul class="simple nested-toc-section">tripleStrLitTest
       <li><a class="reference" href="#tripleStrLitTest"
-    title="tripleStrLitTest()">tripleStrLitTest<span class="attachedType"></span></a></li>
+    title="tripleStrLitTest()">tripleStrLitTest</a></li>
 
   </ul>
   <ul class="simple nested-toc-section">z17
       <li><a class="reference" href="#z17"
-    title="z17()">z17<span class="attachedType"></span></a></li>
+    title="z17()">z17</a></li>
 
   </ul>
   <ul class="simple nested-toc-section">asyncFun3
       <li><a class="reference" href="#asyncFun3"
-    title="asyncFun3(): owned(Future[void])">asyncFun3<span class="attachedType"></span></a></li>
+    title="asyncFun3(): owned(Future[void])">asyncFun3</a></li>
 
   </ul>
   <ul class="simple nested-toc-section">z2
       <li><a class="reference" href="#z2"
-    title="z2()">z2<span class="attachedType"></span></a></li>
+    title="z2()">z2</a></li>
 
   </ul>
   <ul class="simple nested-toc-section">bar
       <li><a class="reference" href="#bar%2CT%2CT"
-    title="bar[T](a, b: T): T">bar,T,T<span class="attachedType"></span></a></li>
+    title="bar[T](a, b: T): T">bar,<wbr>T,<wbr>T</a></li>
 
   </ul>
   <ul class="simple nested-toc-section">fromUtils3
       <li><a class="reference" href="#fromUtils3"
-    title="fromUtils3()">fromUtils3<span class="attachedType"></span></a></li>
+    title="fromUtils3()">fromUtils3</a></li>
 
   </ul>
   <ul class="simple nested-toc-section">isValid
       <li><a class="reference" href="#isValid%2CT"
-    title="isValid[T](x: T): bool">isValid,T<span class="attachedType"></span></a></li>
+    title="isValid[T](x: T): bool">isValid,<wbr>T</a></li>
 
   </ul>
   <ul class="simple nested-toc-section">z6
       <li><a class="reference" href="#z6"
-    title="z6(): int">z6<span class="attachedType"></span></a></li>
+    title="z6(): int">z6</a></li>
 
   </ul>
   <ul class="simple nested-toc-section">low
       <li><a class="reference" href="#low%2CT"
-    title="low[T: Ordinal | enum | range](x: T): T">low,T<span class="attachedType"></span></a></li>
+    title="low[T: Ordinal | enum | range](x: T): T">low,<wbr>T</a></li>
 
   </ul>
   <ul class="simple nested-toc-section">p1
       <li><a class="reference" href="#p1"
-    title="p1()">p1<span class="attachedType"></span></a></li>
+    title="p1()">p1</a></li>
 
   </ul>
   <ul class="simple nested-toc-section">z11
       <li><a class="reference" href="#z11"
-    title="z11()">z11<span class="attachedType"></span></a></li>
+    title="z11()">z11</a></li>
 
   </ul>
   <ul class="simple nested-toc-section">buzz
       <li><a class="reference" href="#buzz%2CT%2CT"
-    title="buzz[T](a, b: T): T">buzz,T,T<span class="attachedType"></span></a></li>
+    title="buzz[T](a, b: T): T">buzz,<wbr>T,<wbr>T</a></li>
 
   </ul>
   <ul class="simple nested-toc-section">low2
       <li><a class="reference" href="#low2%2CT"
-    title="low2[T: Ordinal | enum | range](x: T): T">low2,T<span class="attachedType"></span></a></li>
+    title="low2[T: Ordinal | enum | range](x: T): T">low2,<wbr>T</a></li>
 
   </ul>
   <ul class="simple nested-toc-section">z7
       <li><a class="reference" href="#z7"
-    title="z7(): int">z7<span class="attachedType"></span></a></li>
+    title="z7(): int">z7</a></li>
 
   </ul>
   <ul class="simple nested-toc-section">z13
       <li><a class="reference" href="#z13"
-    title="z13()">z13<span class="attachedType"></span></a></li>
+    title="z13()">z13</a></li>
 
   </ul>
   <ul class="simple nested-toc-section">baz
       <li><a class="reference" href="#baz%2CT%2CT"
-    title="baz[T](a, b: T): T">baz,T,T<span class="attachedType"></span></a></li>
+    title="baz[T](a, b: T): T">baz,<wbr>T,<wbr>T</a></li>
   <li><a class="reference" href="#baz"
-    title="baz()">baz<span class="attachedType"></span></a></li>
+    title="baz()">baz</a></li>
 
   </ul>
   <ul class="simple nested-toc-section">addfBug14485
       <li><a class="reference" href="#addfBug14485"
-    title="addfBug14485()">addfBug14485<span class="attachedType"></span></a></li>
+    title="addfBug14485()">addfBug14485</a></li>
 
   </ul>
   <ul class="simple nested-toc-section">c_printf
       <li><a class="reference" href="#c_printf%2Ccstring"
-    title="c_printf(frmt: cstring): cint">c_printf,cstring<span class="attachedType"></span></a></li>
+    title="c_printf(frmt: cstring): cint">c_printf,<wbr>cstring</a></li>
 
   </ul>
   <ul class="simple nested-toc-section">z12
       <li><a class="reference" href="#z12"
-    title="z12(): int">z12<span class="attachedType"></span></a></li>
+    title="z12(): int">z12</a></li>
 
   </ul>
   <ul class="simple nested-toc-section">z3
       <li><a class="reference" href="#z3"
-    title="z3()">z3<span class="attachedType"></span></a></li>
+    title="z3()">z3</a></li>
 
   </ul>
   <ul class="simple nested-toc-section">z9
       <li><a class="reference" href="#z9"
-    title="z9()">z9<span class="attachedType"></span></a></li>
+    title="z9()">z9</a></li>
 
   </ul>
   <ul class="simple nested-toc-section">z4
       <li><a class="reference" href="#z4"
-    title="z4()">z4<span class="attachedType"></span></a></li>
+    title="z4()">z4</a></li>
 
   </ul>
   <ul class="simple nested-toc-section">z8
       <li><a class="reference" href="#z8"
-    title="z8(): int">z8<span class="attachedType"></span></a></li>
+    title="z8(): int">z8</a></li>
 
   </ul>
   <ul class="simple nested-toc-section">z1
       <li><a class="reference" href="#z1"
-    title="z1(): Foo">z1<span class="attachedType">Foo</span></a></li>
+    title="z1(): Foo">z1</a></li>
 
   </ul>
   <ul class="simple nested-toc-section">z5
       <li><a class="reference" href="#z5"
-    title="z5(): int">z5<span class="attachedType"></span></a></li>
+    title="z5(): int">z5</a></li>
 
   </ul>
   <ul class="simple nested-toc-section">asyncFun2
       <li><a class="reference" href="#asyncFun2"
-    title="asyncFun2(): owned(Future[void])">asyncFun2<span class="attachedType"></span></a></li>
+    title="asyncFun2(): owned(Future[void])">asyncFun2</a></li>
 
   </ul>
   <ul class="simple nested-toc-section">c_nonexistant
       <li><a class="reference" href="#c_nonexistant%2Ccstring"
-    title="c_nonexistant(frmt: cstring): cint">c_nonexistant,cstring<span class="attachedType"></span></a></li>
+    title="c_nonexistant(frmt: cstring): cint">c_nonexistant,<wbr>cstring</a></li>
 
   </ul>
   <ul class="simple nested-toc-section">asyncFun1
       <li><a class="reference" href="#asyncFun1"
-    title="asyncFun1(): Future[int]">asyncFun1<span class="attachedType"></span></a></li>
+    title="asyncFun1(): Future[int]">asyncFun1</a></li>
 
   </ul>
 
@@ -292,7 +292,7 @@ function main() {
   <ul class="simple simple-toc-section">
       <ul class="simple nested-toc-section">someFunc
       <li><a class="reference" href="#someFunc"
-    title="someFunc()">someFunc<span class="attachedType"></span></a></li>
+    title="someFunc()">someFunc</a></li>
 
   </ul>
 
@@ -302,11 +302,11 @@ function main() {
   <a class="reference reference-toplevel" href="#14" id="64">Methods</a>
   <ul class="simple simple-toc-section">
       <li><a class="reference" href="#method1.e%2CMoo"
-    title="method1(self: Moo)"><wbr />method1<span class="attachedType"></span></a></li>
+    title="method1(self: Moo)">method1</a></li>
   <li><a class="reference" href="#method2.e%2CMoo"
-    title="method2(self: Moo): int"><wbr />method2<span class="attachedType"></span></a></li>
+    title="method2(self: Moo): int">method2</a></li>
   <li><a class="reference" href="#method3.e%2CMoo"
-    title="method3(self: Moo): int"><wbr />method3<span class="attachedType"></span></a></li>
+    title="method3(self: Moo): int">method3</a></li>
 
   </ul>
 </li>
@@ -314,11 +314,11 @@ function main() {
   <a class="reference reference-toplevel" href="#15" id="65">Iterators</a>
   <ul class="simple simple-toc-section">
       <li><a class="reference" href="#fromUtils1.i"
-    title="fromUtils1(): int"><wbr />from<wbr />Utils1<span class="attachedType"></span></a></li>
+    title="fromUtils1(): int">fromUtils1</a></li>
   <li><a class="reference" href="#iter1.i%2Cint"
-    title="iter1(n: int): int"><wbr />iter1<span class="attachedType"></span></a></li>
+    title="iter1(n: int): int">iter1</a></li>
   <li><a class="reference" href="#iter2.i%2Cint"
-    title="iter2(n: int): int"><wbr />iter2<span class="attachedType"></span></a></li>
+    title="iter2(n: int): int">iter2</a></li>
 
   </ul>
 </li>
@@ -326,11 +326,11 @@ function main() {
   <a class="reference reference-toplevel" href="#17" id="67">Macros</a>
   <ul class="simple simple-toc-section">
       <li><a class="reference" href="#bar.m"
-    title="bar(): untyped"><wbr />bar<span class="attachedType"></span></a></li>
+    title="bar(): untyped">bar</a></li>
   <li><a class="reference" href="#z16.m"
-    title="z16()"><wbr />z16<span class="attachedType"></span></a></li>
+    title="z16()">z16</a></li>
   <li><a class="reference" href="#z18.m"
-    title="z18(): int"><wbr />z18<span class="attachedType"></span></a></li>
+    title="z18(): int">z18</a></li>
 
   </ul>
 </li>
@@ -338,19 +338,19 @@ function main() {
   <a class="reference reference-toplevel" href="#18" id="68">Templates</a>
   <ul class="simple simple-toc-section">
       <li><a class="reference" href="#fromUtils2.t"
-    title="fromUtils2()"><wbr />from<wbr />Utils2<span class="attachedType"></span></a></li>
+    title="fromUtils2()">fromUtils2</a></li>
   <li><a class="reference" href="#z6t.t"
-    title="z6t(): int"><wbr />z6t<span class="attachedType"></span></a></li>
+    title="z6t(): int">z6t</a></li>
   <li><a class="reference" href="#foo.t%2CSomeType%2CSomeType"
-    title="foo(a, b: SomeType)"><wbr />foo<span class="attachedType"></span></a></li>
+    title="foo(a, b: SomeType)">foo</a></li>
   <li><a class="reference" href="#myfn.t"
-    title="myfn()"><wbr />myfn<span class="attachedType"></span></a></li>
+    title="myfn()">myfn</a></li>
   <li><a class="reference" href="#z14.t"
-    title="z14()"><wbr />z14<span class="attachedType"></span></a></li>
+    title="z14()">z14</a></li>
   <li><a class="reference" href="#z15.t"
-    title="z15()"><wbr />z15<span class="attachedType"></span></a></li>
+    title="z15()">z15</a></li>
   <li><a class="reference" href="#testNimDocTrailingExample.t"
-    title="testNimDocTrailingExample()"><wbr />test<wbr />Nim<wbr />Doc<wbr />Trailing<wbr />Example<span class="attachedType"></span></a></li>
+    title="testNimDocTrailingExample()">testNimDocTrailingExample</a></li>
 
   </ul>
 </li>