RobotLocomotion / drake

Model-based design and verification for robotics.
https://drake.mit.edu
Other
3.32k stars 1.26k forks source link

[website] Go To Name search improvements #17398

Open EvelynDixon-TRI opened 2 years ago

EvelynDixon-TRI commented 2 years ago

API documentation can use improvements to the style and results box for the Go To search.

the styling of hyperlinks from the "Go To Name" search box. They are "blue" as opposed to the new "red" color. The alignment and color of the overlay box should be situated so that it doesn't cover the search string and has a better color match. The image attached shows all 3 of these concerns: the hyperlink in the box with the search results is expected to be red, the background & text colors between the results box and page should match better and finally the search string is covered.

When scrolling to the end of the browser window while reviewing the C++ documentation, once you hit the footer area the search forms disappear. This seemed to be problematic for someone who is perusing the documentation as you need to scroll all the way up (or hit the home key) to get the search back. The visual is jumpy. Jumpy Search form recording

There is a box that falls out of the window browser no matter the size. Its content is not readable. This happens only in the search form "Go to name...". Go to name recording

EvelynDixon-TRI commented 2 years ago

Attachments GoTo styling

https://user-images.githubusercontent.com/94084729/173714607-fb662ef6-8b0e-4fe6-85b4-2e094935f685.mp4

https://user-images.githubusercontent.com/94084729/173715293-34ac71a2-2598-4e91-a970-018601da26cd.mp4

EvelynDixon-TRI commented 2 years ago

Note that EchoCharlie has shared possible fixes with Jeremy for these issues.

jwnimmer-tri commented 2 years ago

Here's the file I received: Update 1.1.zip

And the exposition I was given:

Here's some updated files for doxygen, search.css, search.js and the extra css,

  • Search.css - simple color and space changes.
  • Search.js - positioning change of search window
  • Extra css - Added styling for search results, adjusted to overall style

For the extra css file, all that's needs to be added there is this... at the end of that file.

/* Search Results  */

.memtitle {
    background: none;
    border: 0;
}

.memproto, dl.reflist dt {
    background: #efefef;
    border: 1px solid #efefef;
    box-shadow: none;
    text-shadow: none;
}

.memdoc, dl.reflist dd {
    border: 1px solid #efefef;
    background-image: none;
    box-shadow: none;
}
jwnimmer-tri commented 2 years ago

I need to go figure out what all of these files are, and how to patch in these changes. In the first half hour I spent on this before I hit my timebox, I wasn't able to figure out what was supposed to go where on which pages.