Summary
- This module will implement the search functionality in slidewiki platform, i.e. the users will be able to search slidewiki content & semantics. Content search will cover most of slidewiki entities like decks, slides, comments, questions, tests, users, institutions, etc.
- A simple search box for keywords as well as advanced search fields will be provided so that user can set specific criteria to his searches.
- Filters will also be provided in the results page in order for the user to manage the results better.
Background and goals
Assumptions
Requirements
| # | Title | User Story | Importance | Notes | JIRA |
|---|---|---|---|---|---|
| 1 | Relevance | If one searches with "Semantic Data Web Lecture Series" the whole expression should be queried first, then parts of it and finally the words themselves. | Must Have | ||
| 2 | Auto fill | Auto fill should be created in such a way that it will propose the options of existing presentations or decks. For instance, if the user types “Open E”, auto fill should provide “Open Education” rather than “Open Edit”. Therefore, instead of searching for every type of auto filling, it should scan the database to match the existing ones. | Must Have |
| |
| 3 | Result language sorting | Results should be viewed in different languages | |||
| 4 | Tag cloud | Tag cloud was taking up too much space in the old platform. A possible solution is that it should be hidden and appear only when called. | |||
| 5 | Search Functionality | Basic Search Box: user inserts keywords and gets results Advanced search: Apart from the basic search box, filter fields are also provided to the user so that search criteria are applied in the initial query | Must Have | ||
| 6 | Facets in results | Facets will be provided in the results page, so that results can be further filtered | Must Have | ||
| 7 | |||||
| 8 |
User interaction and design
Search results UI
UI proposed following discussion in SWIK-707 . Mock up below proposes:
- all search entries are marked up as H3 to provide structure to the content
- icons are labelled with aria-label
1 entry per deck.- the one with the most recent modification
Below deck title
- deck description
- date of the last modification of the deck, preceded by "deck" (covers off inaccessibility of the icon)
- followed by owner OR by "user" to show who last modified it
On pressing "Other versions" button, user sees other version of the deck. This could include versions in different languages.
1 entry per slide - the one with the most recent modification
Below the slide title:
- snippet of slide content
- date of the last modification of the deck, preceded by "slide" (covers off inaccessibility of the icon)
- followed by owner OR by "user" to show who last modified it
On pressing "Other versions" button, user sees other deck title containing the slide.
.
The other UI approach to look at is links below the entry that opens a different set of search results as per Google Scholar:
Description of fields/input/elements + validation + test scenarios
Questions
Below is a list of questions to be addressed as a result of this requirements document:
| Question | Asked by | Outcome |
|---|---|---|
Not Doing
| Feature | Status |
|---|---|
Source material for user/stakeholder feedback
Requirements (/user stories) from pilot roadmap:
Evaluation at UniBonn :
Project Partners feedback: