Improved Alignment

Author: nleanba

Marginalia.pdf

@@ -170,7 +170,7 @@
   let clearance = _config.get().clearance
   let extends = _note_extends_left.final().at(page_num, default: ())
   let offsets_down = ()
-  let cur = 0pt
+  let cur = _config.get().top
   for note in extends {
     // 8pt spacing between nodes
     if cur <= note.natural {
@@ -193,7 +193,7 @@
       max = note.natural + offsets_down.at(index) - clearance
     } else if note.fix {
       offsets_final_rev.push(0pt)
-      max = note.natural - clearance
+      max = calc.min(note.natural - clearance, max)
     } else {
       offsets_final_rev.push(max - note.natural - note.height)
       max = max - note.height - clearance
@@ -208,7 +208,7 @@
   let clearance = _config.get().clearance
   let extends = _note_extends_right.final().at(page_num, default: ())
   let offsets_down = ()
-  let cur = 0pt
+  let cur = _config.get().top
   for note in extends {
     // 8pt spacing between nodes
     if cur <= note.natural {
@@ -231,7 +231,7 @@
       max = note.natural + offsets_down.at(index) - clearance
     } else if note.fix {
       offsets_final_rev.push(0pt)
-      max = note.natural - clearance
+      max = calc.min(note.natural - clearance, max)
     } else {
       offsets_final_rev.push(max - note.natural - note.height)
       max = max - note.height - clearance
@@ -249,14 +249,15 @@
     let anchor = here().position()
     let pagewidth = page.width
     let page = here().page()
-    let lineheight = measure(v(par.leading)).height
-
-    let natural_position = anchor.y + dy - lineheight
 
     let width = get-left().width
     let notebox = box(width: width, body)
     let height = measure(notebox).height
 
+    let lineheight = measure([X]).height
+    lineheight = calc.min(lineheight, height)
+    let natural_position = anchor.y + dy - lineheight
+
     let current = _note_extends_left.get().at(str(page), default: ())
     let index = current.len()
 
@@ -287,14 +288,15 @@
     let anchor = here().position()
     let pagewidth = page.width
     let page = here().page()
-    let lineheight = measure(v(par.leading)).height
-
-    let natural_position = anchor.y + dy - lineheight
 
     let width = get-right().width
     let notebox = box(width: width, body)
     let height = measure(notebox).height
 
+    let lineheight = measure([X]).height
+    lineheight = calc.min(lineheight, height)
+    let natural_position = anchor.y + dy - lineheight
+
     let current = _note_extends_right.get().at(str(page), default: ())
     let index = current.len()
 
@@ -326,15 +328,17 @@
 /// - dy (length): Vertical offset of the note.
 /// - body (content):
 #let note(numbered: true, reverse: false, dy: 0pt, body) = {
-  set text(size: 0.8em, style: "italic", weight: "regular")
   if numbered {
     notecounter.step()
     let body = context if _config.get().flush-numbers {
+      set par(spacing: 0.55em, leading: 0.4em, hanging-indent: 0pt)
+      set text(size: 0.8em, weight: "regular")
       notecounter.display(_config.get().numbering)
       h(1.5pt)
       body
     } else {
-      set par(spacing: 0.55em, leading: 0.4em)
+      set par(spacing: 0.55em, leading: 0.4em, hanging-indent: 0pt)
+      set text(size: 0.8em, weight: "regular")
       box(
         width: 0pt,
         {
@@ -367,6 +371,11 @@
     })
   } else {
     h(0pt, weak: true)
+    let body = {
+      set par(spacing: 0.55em, leading: 0.4em, hanging-indent: 0pt)
+      set text(size: 0.8em, weight: "regular")
+      body
+    }
     box(context {
       if reverse or (_config.get().book and calc.even(here().page())) {
         _note_left(dy: dy, body)
@@ -442,7 +451,7 @@
     } else {
       get-right().width
     }
-    let height = measure(width: width, content).height + gap.to-absolute()
+    let height = measure(width: width, content).height + measure(text(size: 0.8em, weight: "regular", v(gap))).height
     if numbered {
       h(1.5pt, weak: true)
       notecounter.display(_config.get().numbering)

lib.typ

@@ -3,7 +3,7 @@
 #let config = (
   inner: ( far: 16mm, width: 20mm, sep: 8mm ),
   outer: ( far: 16mm, width: 40mm, sep: 8mm ),
-  top: 32mm + 1em, bottom: 16mm,
+  top: 32mm + 11pt, bottom: 16mm,
   book: true,
   // clearance: 30pt,
   // flush-numbers: false,
@@ -136,13 +136,20 @@ By default, the #link(label("marginalianote()"))[```typst #note[...]```] command
   This is a note.
 
   They can contain any content, and will wrap within the note column.
+  // #note(dy: 11pt)[Sometimes, they can even contain other notes! (But not always, and I don't know what gives.)]
 ].
 By giving the argument ```typc reverse: true```, we obtain a note on the left/inner margin.#note(reverse: true)[Reversed.]
 If ```typc config.book = true```, the side will of course be adjusted automatically.
 
-If~#note[Note 1] we~#note[Note 2] place~#note[Note 3] multiple~#note[Note 4] notes~#note[Note 5] in~#note(dy:15pt)[This note was given ```typc 15pt``` dy, but it was shifted more than that to avoid Notes 1--5.] one~#note(reverse: true, dy:15pt)[This note was given ```typc 15pt``` dy.] line,#note(dy:110pt)[This note was given ```typc 110pt``` dy.] they automatically adjust their positions.
+If~#note[Note 1] we~#note[Note 2] place~#note[Note 3] multiple~#note[Note 4] notes~#note[Note 5] in~#note(dy:15pt)[This note was given ```typc 15pt``` dy, but it was shifted more than that to avoid Notes 1--5.] one~#note(reverse: true, dy:15pt)[This note was given ```typc 15pt``` dy.] line,#note(dy:10cm)[This note was given ```typc 10cm``` dy.] they automatically adjust their positions.
 Additionally, a ```typc dy``` argument can be passed to shift their initial position by that amount vertically. They may still get shifted around.
 
+Notes will shift downwards to avoid previous notes, containing wideblocks, and the top page margin. Notes will shift upwards to avoid later notes and wideblocks, and the bottom page margin. However, if there is not enough space between two wideblocks or between wideblocks and the margins, there will be collisions.
+
+Currently, notes (and wideblocks) are not reordered,
+#note[This note lands below the previous one!]
+so two ```typ #note```s are placed in the same order vertically as they appear in the markup, even if the first is shifted with a `dy` such that the other would fit above it.
+
 == Markers
 The margin notes are decorated with little symbols, which by default hang into the gap. If this is not desired, set the configuration option ```typc flush-numbers: true```.
 Setting the argument ```typc numbered: false```, we obtain notes without icon/number.#note(numbered: false)[Like this.]
@@ -167,6 +174,8 @@ or per heading:
 // #note[
 //   Vertical offsets in this document:
 //   Right:\
+//   #context marginalia._note_extends_right.get().at("1") \
+//   #context marginalia._note_extends_right.final().at("1") \
 //   #context marginalia._note_offset_right("1") \
 //   #context marginalia._note_offset_right("2") \
 //   #context marginalia._note_offset_right("3") \
@@ -192,7 +201,8 @@ or per heading:
   The command
   ```typst #wideblock[...]```
   can be used to wrap content in a wide block which spans into the margin-note-column.
-  It is a bit cluttered, but is possible to use notes in wide blocks:#note[Voila.]#note(reverse: true)[Wow!].
+  It is possible to use notes in a wide block:#note[Voila.]#note(reverse: true)[Wow!].
+  They will automatically shift downwards to avoid colliding with the wideblock.
 ]
 
 #wideblock(reverse: true)[
@@ -201,7 +211,7 @@ or per heading:
 
 #wideblock(double: true)[
   ```typst #wideblock(double: true)[...]```: The `double` option makes it extend both ways.
-  Note that setting both `reverse: true` and `double: true` will panic.
+  Note that setting both `reverse: true` and `double: true` is disallowed and will panic.
 ]
 
 = Figures
@@ -221,6 +231,12 @@ It accepts all arguments `figure` takes (except `placement` and `scope`), plus a
 
 Additionally, the `dy` argument now takes a relative length, where ```typc 100%``` is the height of the figure content + gap, but without the caption.
 By default, figures have a `dy` of ```typc 0pt - 100%```, which results in the caption being aligned horizontally to the text.
+#marginalia.notefigure(
+  dy: 0pt,
+  rect(width: 100%, fill: gradient.linear(..color.map.crest)),
+  numbered: true,
+  caption: [Aligned to top of figure with `dy: 0pt`.],
+)
 
 A label can be attached to the figure using the `label` argument.// C.f.~@markedfigure.
 
@@ -243,22 +259,35 @@ For larger figures, use the following set and show rules:
   rect(width: 100%, fill: gradient.linear(..color.map.inferno)),
   caption: [A figure.],
 )
+
+For wide figures, simply place a figure in a wideblock.
+The Caption gets placed beneath the figure automatically, courtesy of regular wide-block-avoidance.
+#block[
+  #set text(size: 0.84em)
+  ```typ
+  #wideblock[#figure(
+    image(...),
+    caption: [A figure in a wide block.]
+  )]
+  ```
+]
+// #pagebreak(weak: true)
 #wideblock[
   #figure(
     rect(width: 100%, fill: gradient.linear(..color.map.cividis)),
-    caption: [A figure in a wideblock.],
+    caption: [A figure in a wide block.],
   )
 ]
 #wideblock(reverse: true)[
   #figure(
-    rect(width: 100%, fill: gradient.linear(..color.map.icefire)),
-    caption: [A figure in a wideblock.],
+    rect(width: 100%, height: 5em, fill: gradient.linear(..color.map.icefire)),
+    caption: [A figure in a reversed wide block.],
   )
 ]
 #wideblock(double: true)[
   #figure(
     rect(width: 100%, fill: gradient.linear(..color.map.spectral)),
-    caption: [A figure in a wideblock.],
+    caption: [A figure in a double-wide block.],
   )
 ]