The second of two marginnotes in a Hebrew document is superimposed on the main text

Question

A demonstration of the problem via a minimal working example

I saved the following LaTeX code in ~/Test.tex.

\documentclass{article}
\usepackage[bidi=basic,hebrew,provide=*,layout=graphics]{babel}
\babelfont{rm}[Renderer=HarfBuzz]{FreeSans}
\usepackage{marginnote}
\usepackage{xcolor}
\begin{document}
מכל אלה שהתהלכתי אתם פעם בעיר מולדתי יקרה לי ביחוד%
\marginnote{\textcolor{blue}{%
שלום רב שובך, ציפורה נחמדת, מארצות החום אל חלוני.%
}} %LTR
בת שכננו מינה, אשר קראו לה גם בשם הגנאי ה’ברודה',%
\marginnote{\textcolor{red}{%
אל קולך כי ערב מה-נפשי כלתה בחורף בעוזבך מעוני.
}}% LTR
והיא נערה מנומרת בכתמי שמש שלא חוננה אמנם ביופי, אבל הן כבר ידוע המשפט של כלי החרס אשר בהם ישומר היין הטוב, וראינו גם אשר דברי אלהים חיים נכתבים על גויל פשוט.
\end{document}

The code creates a document of class article, sets its main (and only) language to Hebrew, and, in the document's body, writes a paragraph of Hebrew text, in which two marginnotes of Hebrew text are embedded in two locations. The text of the first marginnote is colored blue, whereas that of the second one is colored red.

Before compiling the code, I took preemptive steps to avoid a known issue concerning marginnotes in Hebrew documents, by implementing a variation on David Carlisle's hack: I made a local copy of marginnote.sty (originally in /usr/local/texlive/2022/texmf-dist/tex/latex/marginnote/), and replaced its line no. 363 with: \rlap{\kern-2.7\marginparwidth%.^{see footnote}

I then executed the following commands in the Terminal.

> cd ~
> lualatex Test
> lualatex Test

The compilation completed successfully with no warnings in ~/Test.log; in particular, no warnings suggesting to rerun the compilation.

As a result of the compilation, the file ~/Test.pdf was created. When this file was opened in a PDF viewer, it displayed as follows. (I screenshot only the relevant part of the display.)

As can be seen, the first (blue) marginnote is positioned correctly in the margin, but the second (red) marginnote is superimposed on the main text.

---

Questions

1. Why is the second margin note superimposed on the main text?
2. What can I do to fix the position of the second (and any other) margin note, while preserving the now correct position of the first margin note?

---

Footnote

It was Udi Fogiel, in a comment to a previous post of mine now deleted (due to being a duplicate of this question), who made me aware of the hack, and suggested the variation necessary to adapt it to the babel+lualatex combo that I use.

Answer 1

This here seems to be the correct values. Attention! It doesn't handle reversemarginpar, and twoside hasn't been tested yet.

\documentclass{article}
\usepackage[bidi=basic,hebrew,provide=*,layout=graphics]{babel}
\babelfont{rm}[Renderer=HarfBuzz]{FreeSans}
\usepackage{marginnote}
\usepackage{xcolor,xpatch}
\makeatletter
\patchcmd\@mn@@@marginnote{\kern-\dimexpr\@mn@currxpos}{\kern\dimexpr\@mn@currxpos}{}{\fail}
\patchcmd\@mn@@@marginnote{\kern\oddsidemargin}{\kern-\oddsidemargin}{}{\fail}
\patchcmd\@mn@@@marginnote{\kern\oddsidemargin}{\kern-\oddsidemargin}{}{\fail}
\patchcmd\@mn@@@marginnote{\kern\evensidemargin}{\kern-\evensidemargin}{}{\fail}
\patchcmd\@mn@@@marginnote{\kern 1in}{\kern-1in}{}{\fail}
\patchcmd\@mn@@@marginnote{\kern\marginnotetextwidth}{}{}{\fail}
\makeatother


\begin{document}
מכל אלה שהתהלכתי אתם פעם בעיר מולדתי יקרה לי ביחוד%
\marginnote{\textcolor{blue}{%
שלום רב שובך, ציפורה נחמדת, מארצות החום אל חלוני.%
}} %LTR
בת שכננו מינה, אשר קראו לה גם בשם הגנאי ה’ברודה',%
\marginnote{\textcolor{red}{%
אל קולך כי ערב מה-נפשי כלתה בחורף בעוזבך מעוני.
}}% LTR
והיא נערה מנומרת בכתמי שמש שלא חוננה אמנם ביופי, אבל הן כבר ידוע המשפט של כלי החרס אשר בהם 
ישומר היין הטוב, וראינו גם אשר דברי אלהים חיים נכתבים על גויל פשוט. 
',%
\marginnote{\textcolor{green}{%
אל קולך כי ערב מה-נפשי כלתה בחורף בעוזבך מעוני.
}}% LTR
והיא נערה מנומרת בכתמי שמש שלא חוננה אמנם ביופי, אבל הן כבר ידוע המשפט של כלי החרס אשר בהם 
ישומר היין הטוב, וראינו גם אשר דברי אלהים חיים נכתבים על גויל פשוט. 
\end{document}

Answer 2

Interestingly, marginnote takes into account RTL texts, but this feature is activated only when bidi is loaded. Apparently, it can be cheated in the following way:

\documentclass{article}
\usepackage[bidi=basic,hebrew,provide=*,layout=graphics]{babel}
\babelfont{rm}[Renderer=HarfBuzz]{FreeSans}

\makeatletter
\newif\if@RTL  \@RTLtrue  % Pretend that `bidi` has been loaded 
\makeatother

\usepackage{marginnote}
\usepackage{xcolor}

\begin{document}
מכל אלה שהתהלכתי אתם פעם בעיר מולדתי יקרה לי ביחוד%
\marginnote{\textcolor{blue}{%
שלום רב שובך, ציפורה נחמדת, מארצות החום אל חלוני.%
}} %LTR
בת שכננו מינה, אשר קראו לה גם בשם הגנאי ה’ברודה',%
\marginnote{\textcolor{red}{%
אל קולך כי ערב מה-נפשי כלתה בחורף בעוזבך מעוני.
}}% LTR
והיא נערה מנומרת בכתמי שמש שלא חוננה אמנם ביופי, אבל הן כבר ידוע המשפט של כלי החרס אשר בהם ישומר היין הטוב, וראינו גם אשר דברי אלהים חיים נכתבים על גויל פשוט.
\end{document}

Answer 3

Add the following piece of code after loading the marginnote package to (hopefully) correct marginnote's \@mn@if@RTL which is supposed to test whether the current text flow is RTL or not.

\usepackage{ifthen}
\makeatletter
\renewcommand*{\@mn@if@RTL}%
{%
   \ifthenelse%
   {\equal{\the\textdir}{\detokenize{TRT}}}%
   {\@firstoftwo}%
   {\@secondoftwo}%
}
\makeatother

The geometry package should also be loaded if there are margin notes in LTR text, I don't know why, but otherwise the horizontal alignment of the marginnotes is a little off.

This solution relies on the LuaTeX engine's register \textdir, so can be used only with LuaTeX.

---

An example with both text and math in document whose language is set to Hebrew via babel.

\documentclass[12pt]{article}

\usepackage[showframe]{geometry}

\usepackage[bidi=basic,hebrew,provide=*]{babel}
\babelfont{rm}{FreeSans}

\usepackage{lipsum}

\usepackage{marginnote}

% marginnote fix begin
\usepackage{ifthen}
\makeatletter
\renewcommand*{\@mn@if@RTL}%
{%
   \ifthenelse%
   {\equal{\the\textdir}{\detokenize{TRT}}}%
   {\@firstoftwo}%
   {\@secondoftwo}%
}
\makeatother
% marginnote fix end
\begin{document}
\lipsum[1-1][1-1] \marginnote{Margin note in text mode}
\lipsum[1-1][2-8]
\reversemarginpar
\[
x + y = z\marginnote{Margin note in math mode}
\]
\end{document}

---

The example of the original post:

\documentclass{article}
% \usepackage[pass]{geometry}
\usepackage[bidi=basic,hebrew,provide=*,layout=graphics]{babel}
\babelfont{rm}[Renderer=HarfBuzz]{FreeSans}
\usepackage{marginnote}
\usepackage{xcolor}

% marginnote fix begin
\usepackage{ifthen}
\makeatletter
\renewcommand*{\@mn@if@RTL}%
{%
   \ifthenelse%
   {\equal{\the\textdir}{\detokenize{TRT}}}%
   {\@firstoftwo}%
   {\@secondoftwo}%
}
\makeatother
% marginnote fix end
\begin{document}
מכל אלה שהתהלכתי אתם פעם בעיר מולדתי יקרה לי ביחוד%
\marginnote{\textcolor{blue}{%
שלום רב שובך, ציפורה נחמדת, מארצות החום אל חלוני.%
}} %LTR
בת שכננו מינה, אשר קראו לה גם בשם הגנאי ה’ברודה',%
\marginnote{\textcolor{red}{%
אל קולך כי ערב מה-נפשי כלתה בחורף בעוזבך מעוני.
}}% LTR
והיא נערה מנומרת בכתמי שמש שלא חוננה אמנם ביופי, אבל הן כבר ידוע המשפט של כלי החרס אשר בהם ישומר היין הטוב, וראינו גם אשר דברי אלהים חיים נכתבים על גויל פשוט.
\end{document}

In this case the loading of the geometry package is optional, because the text is entirely RTL.

---

Acknowledgments

1. Ulrike Fischer for telling me about the \textdir register.

2. David Carlisle for showing me how to query said register.

---

Remarks

This is not a perfect solution. There are cases in which despite the implementation of this solution, the margin notes are misplaced, for instance the following example in which the document's left and right margins are asymetrical.

\documentclass{article}
\usepackage[hmarginratio=1:3,showframe]{geometry}

\usepackage[bidi=basic, english, hebrew, provide=*]{babel}
\babelfont{rm}{FreeSans}

\usepackage{marginnote}

\usepackage{ifthen}
\makeatletter
\renewcommand*{\@mn@if@RTL}%
{%
   \ifthenelse%
   {\equal{\the\textdir}{\detokenize{TRT}}}%
   {\@firstoftwo}%
   {\@secondoftwo}%
}
\makeatother
\usepackage{lipsum}
\begin{document}
\reversemarginpar
\[%LTR
x + y = z\marginnote{math note}
\]
\normalmarginpar
word\marginpar{text note}
\end{document}