Support:Search Requirements: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
m (Adding note that this list is not finalized.)
(Made some changes)
Line 3: Line 3:


# Doesn't kill the server
# Doesn't kill the server
# Only articles in a particular category or categories should be displayed as search results (at the moment, only things "Knowledge Base"). Without this, we'll show articles that aren't ready or aren't accessible to people.[https://bugzilla.mozilla.org/show_bug.cgi?id=401163]
# Category/tag based searches (only articles in a particular category and/or with the specified tags should be matched [https://bugzilla.mozilla.org/show_bug.cgi?id=401163])
#* Does it depend on the user (e.g. show Staging copies to contributors?)
#* Does it depend on the user (e.g. show Staging copies to contributors?)
# Should only look at the content and title of the page and not other features of the page. Right now, searching for "Bookmarks" shows all articles because "Bookmarks" appears in the tag cloud.
#** Yes, but the important thing is that the search engine accepts searches based on category/tags. Then we can use different search queries depending on user groups. (djst)
# Should only look at the content, title, and tags of the article and not other features of the page. Right now, searching for "Bookmarks" shows all articles because "Bookmarks" appears in the tag cloud.
# "Notice" new or changed content within 24 hours.
# "Notice" new or changed content within 24 hours.
# Do not return multiple results for the same article:
# Do not return multiple results for the same article:
Line 13: Line 14:
# Handle localization
# Handle localization
#* How?
#* How?
#** The locale should be detected (and possible to override).
#** When a search is performed, only the selected/detected locale should be searched. However, many locales will have incomplete translations, which means it would also list content not localized (using the same locale fallback mechanism as defined in [https://bugzilla.mozilla.org/show_bug.cgi?id=398353])
#** In summary, a search should return all results for the current locale + any remaining articles in the fallback locales, but it should never list the same article twice, even if it exists for two locales.
# Be able to weight articles
# Be able to weight articles
#* Based on their tags
#* Based on their tags
#* Based on their poll results
#* Based on their poll results
#* Based on their page hit count
# Handle tiki formatting correctly
# Handle tiki formatting correctly
#* Properly handle the use of it in search (search for "code" should not return all pages that use the code tag)
#* Properly handle the use of it in search (search for "code" should not return all pages that use the code tag)
#* Don't display source in search results
#* Don't display wiki source in search results
#** Parse it?
#** Ignore it?
# Show statistics on the article
# Show statistics on the article
#* Popularity
#* Show popularity and poll results in search results
#* Poll results
# "More like this"?
# "More like this"?
#* I personally don't see the benefit (djst)

Revision as of 12:57, 4 December 2007

THIS DOCUMENT IS A DRAFT OF OUR SEARCH ENGINE REQUIREMENTS FOR SUMO. IT IS NOT YET FINAL.


  1. Doesn't kill the server
  2. Category/tag based searches (only articles in a particular category and/or with the specified tags should be matched [1])
    • Does it depend on the user (e.g. show Staging copies to contributors?)
      • Yes, but the important thing is that the search engine accepts searches based on category/tags. Then we can use different search queries depending on user groups. (djst)
  3. Should only look at the content, title, and tags of the article and not other features of the page. Right now, searching for "Bookmarks" shows all articles because "Bookmarks" appears in the tag cloud.
  4. "Notice" new or changed content within 24 hours.
  5. Do not return multiple results for the same article:
    • Different capitalization [2]
    • Different request parameters
  6. Some formatting issues [3]
  7. Handle localization
    • How?
      • The locale should be detected (and possible to override).
      • When a search is performed, only the selected/detected locale should be searched. However, many locales will have incomplete translations, which means it would also list content not localized (using the same locale fallback mechanism as defined in [4])
      • In summary, a search should return all results for the current locale + any remaining articles in the fallback locales, but it should never list the same article twice, even if it exists for two locales.
  8. Be able to weight articles
    • Based on their tags
    • Based on their poll results
    • Based on their page hit count
  9. Handle tiki formatting correctly
    • Properly handle the use of it in search (search for "code" should not return all pages that use the code tag)
    • Don't display wiki source in search results
  10. Show statistics on the article
    • Show popularity and poll results in search results
  11. "More like this"?
    • I personally don't see the benefit (djst)