datalad-handbook / book

Sources for the DataLad handbook
http://handbook.datalad.org
Other
146 stars 55 forks source link

Positioning of windows wits distracting #1089

Closed mih closed 11 months ago

mih commented 11 months ago

These boxes often directly precede command output displays. Example:

image

Visually, this looks as if the box is "unfolded" and the output IS the windows wit.

In the PDF version, the pattern "insert windows wit box BEFORE the content that it annotates" leads to substantial diversions. Example:

image

"this script" refers to a listing that follows two boxes (full-page length combined), with no particular emphasize that connects the text.

IMHO in-text boxes should be placed at semantic boundaries, not inside content that is directly connected.

This is a frequent pattern. The preceding text often even ends with a colon, but is followed by an in-text box, and not the content that belongs after the colon.

adswa commented 11 months ago

My thoughts are this:

The middle-ground would be to change the placement only in the print version, at the expense of another constant different between the printed version and the web version. I anticipate that this is annoying. But I believe we have a choice of the possible annoyances:

When forced to decide between the three, I'd opt for annoying us rather than any users.

mih commented 11 months ago

OK, sounds like a permanent diff is what is needed. Nothing to be done here anymore.