SAP-archive / BUILD_User_Assistance

Here's the files for the GH-page for BUILD.
2 stars 2 forks source link

Suggestion (Help Site): Keywords in search are highlighted in the search results #20

Open crystalngai opened 8 years ago

crystalngai commented 8 years ago

I noticed with most search functions I use, the keywords I search for are automatically highlighted in search results. This is useful so the reader can see the context of where the keyword was used, and also see where in the topic it appears.

The Help Site currently does not have this function. Maybe it would be a good idea to implement it?

I searched for "inspiring" because I know it appears in Sophia's topic. In the search results, I can see which topic it appears in, but it doesn't show me the instance that word is used: inspiring

It would be nice to have this section brought up in a preview for the search results: inspiring 2

brian-murray35 commented 8 years ago

@mhlibchuk Nice idea. I've mailed Sean aswell.

ghost commented 8 years ago

@mhlibchuk Can we also add more keywords that aren't specifically in the text? like if someone is searching create page but it's add page, is there a way to add more meta data?

mhlibchuk commented 8 years ago

The current solution (pure javascript that runs on the client) displays the short description for each topic that appears on the results page.

Given the limitations of the solution, it might be a challenge to implement either suggestion (as much as I like them). I can take a look.

brian-murray35 commented 8 years ago

@mhlibchuk, @Sdeano Hi Michael, This is a 'nice-to-have', but not crucial, and dependent on your availability.

brian-murray35 commented 8 years ago

@Sdeano You've done some research on this, can you comment?