Repository navigation
Add a help button to every window and Term Info query row - #1800
Merged
Merged
Conversation
Each "Query for" row, graph link and Circuit Browser link in the Term
Info panel now ends with a gold "?" that opens the matching section of
the website docs in a new tab. The Queries Reference page carries one
{#QueryName} anchor per VFBquery query, so the query name already in the
row's data-instancepath is the anchor; graphs and the Circuit Browser
link to fixed anchors on their own pages.
Done client-side on the server-rendered HTML so it works for both the
VFBquery and legacy term-info processors without a uk.ac.vfb.geppetto
release. Only anchors carrying a data-instancepath are touched, so the
existing click hookup (which selects on that attribute) is unaffected.
helpLinks.js is now the single source of truth for in-app help: every "?" in the UI resolves its docs URL there, keyed by the FlexLayout component name for tab windows and by feature name for the rest. - Every tab window (Term Info, 3D Viewer, Slice Viewer, Term Context, Circuit Browser, Template ROI Browser, Layers) gets a "?" in its header, left of the minimise button, linking to that tab's page under /docs/website-features/. - The query builder and query results, which geppetto-client renders, get the same button injected next to their close cross; a MutationObserver re-adds it whenever those containers remount. - The Term Info query-row links from the previous commit now go through the same module and share the .vfb-help style. Template ROI Browser and Layers had no docs page; both are added in the matching VFB2 change.
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
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.
Every window now carries a gold
?that opens the matching page under/docs/website-features/in a new tab, and every row of the Term Info query panel gets one linking to that query's section of the Queries Reference.components/configuration/VFBMain/helpLinks.jsis the single map from feature → docs URL. Tab windows are keyed by their FlexLayoutcomponentname; the query tool by feature; Term Info rows by VFBquery query name (the Queries Reference has a{#QueryName}anchor per query) or a fixed anchor.onRenderTabSet, left of the minimise icon, following the selected tab.data-instancepathare touched; the existing click hookup is unaffected.Docs side: VirtualFlyBrain/VFB2 branch
docs/query-help-anchorsadds the anchors and the two missing pages (Template ROI Browser, Layers). Every key in the map resolves once that merges.To test on dev: each tab header shows a
?and it opens the right page; open any neuron (e.g. DNg03_L) and check each query row has a?on the right landing on its section; shift-click on a query label still stacks; open the query builder and results and check the?position beside the cross (the offsets inVFBMain.lessare the one thing not verified visually). Not covered yet: the Spotlight search bar and the Term Info button bar.