Search UI - Custom project

Provide MWS pages with the proper JS and CSS assets to achieve a working search page with the vendor's (Coveo) technology called Headless.

Sponsored by: Francis Gorman, Principal Publisher, ESDC

Latest status update

Intial creation of this documents

Examples

• Sample basic search page
• Sample advanced search page
• Sample contextual search page
• Exemple de page de résultats de la recherche (base)
• Exemple de page de résultats de la recherche (avancée)
• Exemple de page de résultats de la recherche (contextuelle)

Maintenance plan

• Next release (for v1.5) - Create demos/test that are illustrating all functionality. Like a demos that show all the possible configurable option.
• Next release (for v1.5.0 or v1.4.1) - Enforce the line ending for CSS build to be linux line ending, especially when generating the distribution files
• Next release or two (v1.5 +) - Start to add automated testing for the search-ui code functional aspect. This could be unit testing or functiona testing with pupetteer.

Todo and for future consideration

• Refactor the code to make it easier to understand it functional aspect
• Manage template centrally in a way that is applying change are intituitive and easierand make if easier to configure/update
• Remove the need for having a CSS file to be handled by GCWeb instead!
• Add missing pieces such as "error message", "no result" and "did you mean" into our reference implementation as an example
• Potentially come up with an easier way to test locally
• Add Expected output on test pages (HTML) and use Jekyll highlights
• Finish proper development of Suggestion box (type-ahead)
• **to validate, reported as completed** Add includes of JS (src) files in a baked in Jekyll variables instead of hardcoded
• Align search pages with new GCWeb template and/or define new GCWeb templates
• Ensure no section or heading or any element with semantic is added alone/empty on the page
• Improve the form code to not rely on an action that points to an anchor for a dynamically added element, which doesn't exist on the page prior to JS
• Create search template specific styles (.page-type-search), to get rid of overusage of .h3 class for example
• {"Leverage wb core features instead of reinving the wheel, such as for language of page and dates. For dates, native JS functions could be leveraged such as"=>"toLocaleDateString"}
• {"Improve caching of variable that are used multiple times in the script, such as"=>"window.location, then window.location.pathname"}
• Revisit how dates are handled for output formats (need an array of months?)
• Make IDs configurable for "suggestion", "result-list", "result-link", "query-summary", "pager"
• Revisit customEvent to potentially be scoped to the search-ui element instead of document
• Document customEvent
• Improve warning message when Headless doesn't load
• `numberOfPages: 9` and `automaticallyCorrectQuery: false` should be configurable through parameters
• Revisit the need to search for postscript and rich text documents (ps and rtf. Are they needed? What's the usecase?
• Revisit the "window.location.origin.startsWith( 'file://' )" condition
• **to validate, reported as completed** Investigate Pagination styles when testing from GitHub
• **to validate, reported as completed** Investigate #wb-land focus on Advanced search