spec icon indicating copy to clipboard operation
spec copied to clipboard

Markup inside the PDF's validation section in the table of content

Open verbessern opened this issue 1 year ago • 5 comments

As the title states, there is some markup in the TOC, like for example in Validation->Types->Function Types there is a single child node named "[t1n] [syntax/types:syntax-functype] [t2m]". This is sins quite a while, and is in many different proposals, including the wasm v3 draft. I think it is a markup spill.

verbessern avatar Sep 23 '24 11:09 verbessern

Hm, I don't quite get what you mean. I'm not seeing anything unusual, e.g. in the online PDF. Can you provide a screen shot?

rossberg avatar Sep 24 '24 09:09 rossberg

In the outline of the document (table of content) if you browse the tree, some children are with this text. For example Outline->Validation->Types->Block Type has 2 children, the first one is [syntax/modules:syntax-typeidx]typeidx, as it probably has to be just typeidx.

verbessern avatar Sep 24 '24 09:09 verbessern

That is not in the pages themselves, but in the table of content of the document (usually available for navigation in the GUI of the PDF viewers).

verbessern avatar Sep 24 '24 09:09 verbessern

I see, yes, I can observe that.

Unfortunately, this appears to be a Sphinx limitation, which I'm not sure can be fixed or worked around. Are you sure it ever was different? The source hasn't changed in that regard since the first spec release.

rossberg avatar Sep 24 '24 10:09 rossberg

I do not know when it appeared, but the first specs had no such depth TOC nesting, so it had no such issue. Version 2 however has, as well as the v3. I'm not familiar with this program Sphinx, but I would assume that these level 4 sections need a name, maybe only for the TOC, that is not displayed as a text in the page.

verbessern avatar Sep 24 '24 12:09 verbessern