Show the help a specification carries instead of hiding it in a title - #223
Merged
Conversation
Guidance was attached as native `title` attributes, which stay invisible until hovered for about a second, never appear on touch, and on some machines do not render at all -- so help written into a profile never reached the person filling it in. Every title becomes a focusable "?" beside its label, with the bubble on body because each panel clips its overflow and cut the old one off at the section edge. The entity editor's four fields and the field form's five section headings had no help text at all; they do now.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Guidance in the builder was attached as native
titleattributes. A native tooltip stays invisible until hovered for about a second, never appears on touch, and on some machines does not render at all — so help written into a profile was reaching nobody. Reported from a machine where no native tooltip renders anywhere.What changed
static/js/help-markers.jsconverts everytitlein the builder into a small focusable "?" beside its label. It removes thetitleafterwards so a browser that does render native tooltips does not show a second copy, and re-runs onhtmx:afterSwapso a partial loaded later is covered without knowing about any of this.The bubble is appended to
body. Every panel in the builder clips its overflow, which cut the first attempt off at the edge of the section its marker belonged to.Skipped deliberately: controls with their own hover behaviour (button, a, input, select), which keep their native title rather than gaining a focusable child in the way of the thing they label.
Help text that did not exist
The entity editor's four fields — Name, Description, Ontology Term, SEEK role — carried no help at all, and neither did the field form's five section headings (Basic, Markers, Type Settings, Constraints, Advanced). Both now explain themselves, including the distinction between an entity's ontology term and a field's, and the fact that SEEK role re-types a node without moving it in the hierarchy.
Note
This is still hand-written help in two templates, which is how a fork silently lost all of it once before. Deriving the markers from the specification's own field documentation would mean no element can be missed and the text cannot drift — worth doing as a follow-up.