docs(viewer): document full table search semantics with a screenshot #5

Merged
allan merged 3 commits from docs/full-table-search into main 2026-09-17 09:49:12 +00:00
Collaborator

What

The Full Table Search section of the Viewer page only said that a search box exists. It now documents the behaviour users actually hit, with a screenshot of the search in action.

Text

  • The search covers every column at once, so you do not need to know which column holds the value.
  • Character search (default) is a case sensitive CONTAINS match - Smith finds Smithson and smith finds Goldsmith, but smith will not find Smithson.
  • Numeric search (the Numeric toggle) is an exact match - 42 will not find 420 or 4210.
  • An applied filter scopes the search to the filtered rows.
  • The result set is capped by DC_MAXOBS_WEBVIEW (linked to the options page); the row count next to the table name is the match count, which can exceed the rows displayed.
  • A search with no matches shows the "No data found with given conditions" panel rather than an empty grid.

Screenshot

docs/img/full-table-search.png - the viewer with a search for siphonophore returning 3 rows, captured at 1920x900 from a mocked instance via the Cypress suite in the dc repo. All nine columns are on screen, so the NOTES column that actually holds the match is shown rather than clipped off the right edge. The demo table is fictional survey data; nothing customer-specific is in the image.

Notes

  • The existing YouTube embed in that section is left as-is. A fresh recording of the current build is in progress on the dc side - once it is hosted the embed can be swapped for it.
  • No new page, so mkdocs.yml is untouched; the image sits alongside the other page images in docs/img/.
## What The **Full Table Search** section of the Viewer page only said that a search box exists. It now documents the behaviour users actually hit, with a screenshot of the search in action. ### Text - The search covers **every** column at once, so you do not need to know which column holds the value. - Character search (default) is a case sensitive CONTAINS match - `Smith` finds `Smithson` and `smith` finds `Goldsmith`, but `smith` will not find `Smithson`. - Numeric search (the Numeric toggle) is an exact match - `42` will not find `420` or `4210`. - An applied filter scopes the search to the filtered rows. - The result set is capped by `DC_MAXOBS_WEBVIEW` (linked to the options page); the row count next to the table name is the match count, which can exceed the rows displayed. - A search with no matches shows the "No data found with given conditions" panel rather than an empty grid. ### Screenshot `docs/img/full-table-search.png` - the viewer with a search for `siphonophore` returning 3 rows, captured at 1920x900 from a mocked instance via the Cypress suite in the `dc` repo. All nine columns are on screen, so the NOTES column that actually holds the match is shown rather than clipped off the right edge. The demo table is fictional survey data; nothing customer-specific is in the image. ## Notes - The existing YouTube embed in that section is left as-is. A fresh recording of the current build is in progress on the `dc` side - once it is hosted the embed can be swapped for it. - No new page, so `mkdocs.yml` is untouched; the image sits alongside the other page images in `docs/img/`.
hermes added 1 commit 2026-09-16 00:52:31 +00:00
The "Full Table Search" section said only that a search box exists. It now
states the behaviour that users actually hit:

- the search covers every column at once, character columns by case sensitive
  CONTAINS and numeric columns by exact match
- the Numeric toggle switches to exact numeric matching
- an applied filter scopes the search
- results are capped by DC_MAXOBS_WEBVIEW (linked to the options page), and the
  row count next to the table name reports the match count
- a search with no matches shows the "No data found with given conditions"
  panel

Adds a screenshot of the search in action (docs/img/full-table-search.png),
captured from a running instance via the Cypress suite in the dc repo.
hermes added 1 commit 2026-09-16 23:38:17 +00:00
The screenshot showed the siphonophore search returning 3 rows, but the
NOTES column - the only column the value appears in - was clipped off the
right edge, so the image did not show why those rows matched.

Re-captured at 1920x900 (all nine columns on screen, no clipping) from the
mocked instance, with the capture gated on an assertion that the matched
cell is inside the grid viewport.
hermes added 1 commit 2026-09-16 23:42:39 +00:00
The example claimed `smith` finds `Smithson`, which only holds for a case
insensitive match. The search is a case sensitive CONTAINS match - DC passes
the search value straight to %mp_searchdata, which uses the SAS `?` operator -
so `smith` finds `Goldsmith` (a lowercase substring) and not `Smithson`.
allan approved these changes 2026-09-17 09:48:55 +00:00
allan merged commit cd47d0e442 into main 2026-09-17 09:49:12 +00:00
allan deleted branch docs/full-table-search 2026-09-17 09:49:12 +00:00
Sign in to join this conversation.
No Reviewers
No labels
2 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: dc/docs.datacontroller.io#5