Papercuts & Feedback from Discord

[rowanc1]

This is a staging ground for launching other issues.

• Would be nice if SVGs were used as (AFAIU) <object> rather than <img>, so that e.g. links within can be clicked
• Hover-previews of links to other documents could be more useful, e.g. contents of first section/heading that's nonempty (I ended up directly linking to that subsection instead)
• if I make a ::::{grid} with two :::{card}s in it, it renders more nicely at some zoom levels if I explicitly specify ::::{grid} 2, even though there's two cards/columns in either case
• might be nice as an option to be able to have footnotes not present in the main document text at all, only as hover tooltips
• there's an outline_maxdepth site option (book theme), but anything above 3 has no (additional) effect
• when there are a lot of items in the RHS outline, the last few are cut off (not visible even when scrolled all the way down)
• there's a horizontal scrollbar on the page for no obvious reason (afaict, scrolls everything except the LHS ToC sidebar by a few tens of px left/right)
• the :linenos option for {code} affects indentation of the contained code -- i.e., lines starting from line 10+ are indented 1 column further than lines 1-9 due to the width of the line numbers themselves
• the :emphasize-lines: option only seems to have an effect if :linenos: is also enabled (but IMHO it seems independently useful)
• some way to influence the widths of table columns would be nice -- we have a bunch of "key-value" style tables with the name of a property in the first column and a description in the second; and the width of the first column (which always has the same contents) varies wildly per-table based on whether there are any long lines in the second column (in which case the first column takes only as much space as it needs; otherwise, ~half the table width)
• the :align: option in a :::{table} seems to have no effect (initially I thought it was being implicitly overridden by the per-column alignments inferred from markdown header syntax... but testing it out at https://mystmd.org/guide/tables, it doesn't seem to do anything for list-table or csv-table either)
• strong emphasis on literal text (asdf) has no effect (fwiw it seems it does in here :)

From: glaebhoerl on discord

[glaebhoerl]

TYVM! Would've gotten around to it eventually...

(Of the ones listed above, the 3-4 of them beginning from "when there are a lot of items in the RHS outline, the last few are cut off" seem the more significant ones to me.)

I ended up collecting a few more in the meantime:

Perceptible annoyance

• When mentioning filenames such as Test.java or path/to/archive.zip in normal text, they automatically get turned into links to domains. The only way to prevent this seems to be to backtick them. (IMHO, this seems like a misfeature; at least an option to disable it globally would be appreciated.) 🌎 Remove TLD of .java and .zip from linkify #1825

Small potential enhancements

• When an included image is displayed scaled down (due to e.g. excessive width), it would be helpful if clicking on it would open a lightbox to view it full size.
• It would be nice to have a :::literalinclude (or perhaps :::code in general) that's also at the same time a :::dropdown. I can nest the former in the latter, which does work, but results in nested boxes and dual titles (and the dropdown doesn't seem to work without a title... whereas the filename/title on the code block is the one which'd look nicer).
• {name} doesn't work when linking to a document (like [chapter {name}](foo.md)), but perhaps could
• The text of the automatic "Figure N" caption for figures could stand to be customizable somehow; e.g., in case the rest of the document is not in English. (This is possible for references to the figures, via numbering: figure: template: ... in frontmatter. But not, AFAICT, for the figures themselves.)

Unimportant issues noticed, "just FYI"

• Non-English characters (e.g. with accents/diacritics) in headings all get replaced by hyphens in the automatic anchors/IDs used for references. Not sure if this is fully deliberate.
• When clicking a section in the RHS outline, the main content scrolls to the right place, but sometimes a different section ends up getting the highlight within the outline itself. Clicking a second time restores consistency.
  • The highlight also sometimes "jumps" from one section to another when a hover preview tooltip is activated
  • (The progression of which sections get highlighted can be kinda chaotic when just scrolling through the document, as well)