Page-nav items behaving oddly if inline includes are combined with spans

[damithc]

v3.0.3

Expected: page-nav should detect the current topic in view e.g., (from V2)

Actual:

Example:
https://se-education.org/se-book/designFundamentals/index.html

[ang-zeyu]

👀

to add, it seems page specific:
e.g. not ok here https://se-education.org/se-book/designFundamentals/index.html
but ok here https://se-education.org/se-book/about/usage.html (I think our docs as well)

[damithc]

to add, it seems page specific:

Yes, I noticed that too, later. Probably something to do with the headings being inside panel components in those pages.

There's a chance that this was like that in V2 too.

[damithc]

An update:

The relevant source code is in https://raw.githubusercontent.com/se-edu/se-book/master/_markbind/boilerplates/container-inParent-asPanel.md

<panel type="seamless" expanded>
  <span slot="header" class="card-title"><markdown>## <include src="text.md#title" inline /></markdown></span>
  <include src="text.md#body" />
</panel>

Strangely, if I add some chars between ## and <include ..., it starts working again.

<panel type="seamless" expanded>
  <span slot="header" class="card-title"><markdown>## topic: <include src="text.md#title" inline /></markdown></span>
  <include src="text.md#body" />
</panel>

[damithc]

This problem cropped up in another place, albeit in a slightly different form:

See https://nus-cs2103-ay2122s1.github.io/website/schedule/week3/project.html

Note how the pageNav items appear out of order.

I managed to narrow down the problem to the following sample code.

<frontmatter>
pageNav: 4
pageNavTitle: "Sample page"
</frontmatter>

# Shows

## <span class="text-danger">1</span> Rick and Morty

## <span class="text-danger">2</span> <include src="topic2.md#name" inline trim/>

## <span class="text-danger">x</span> <include src="topic2.md#name" inline trim/>

## y <span class="text-danger">4</span> <include src="topic2.md#name" inline trim/>

Note how one pageNav item appears out of order.

What I observed:

• It happens when a heading has an inline include, combined with a <span>, and doesn't contain anything else. Note how adding a simple x in front prevents the problem. However, putting a symbol instead e.g., . doesn't work.
• Furthermore, it happens only if the span content is a number i.e., x will not cause the problem but 2 will.

[damithc]

Raising severity as the new symptom is more noticeable to the reader.

[damithc]

Given the strange behavior involving numbers/symbols, I wonder if a regular expression is behind it all 🤔

[damithc]

Let's try to fix this before the semester starts. In the worst case, I can use the hack of adding some text in front, but not ideal.

[ang-zeyu]

Thanks for the examples, I published a fix for the first part of the issue (pagenav not working without some "pretext"). It might fix the second part as well @damithc

[damithc]

Thanks for the fix @ang-zeyu
The second (and more severe) problem seems to be fixed now. Great!

The first problem seems to remain though.

[ang-zeyu]

🎉