Changes between Version 20 and Version 21 of BluePrint/TextSearch


Ignore:
Timestamp:
04/20/13 16:42:28 (8 years ago)
Author:
Vishrut Mehta
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • BluePrint/TextSearch

    v20 v21  
    33
    44== Introduction ==
     5
    56The Blueprint outlines the development of two functionalities for Sahana Eden. They are:
    67=== Full-text Search ===
     8
    79*    It will provides users to search for text in uploaded documents.
    810
    911=== Global Search ===
     12
    1013*    It will provide users to search for text over multiple resources (eg. Organization, Hospital, etc.).
    1114
    1215== Stakeholders ==
     16
    1317*    The End Users[[BR]]
    1418Agencies like:
     
    2226
    2327== User Stories ==
    24 For Full-Text Search:
     28
     29'''For Full-Text Search:'''
    2530[[BR]]
    2631*    The user will have to go to Document module and Search option. Then he has to type the text(or the specified query format) to search in all the uploaded documents.
     
    3035== Requirements ==
    3136=== Functional ===
    32 For Full Text Search:[[BR]]
     37'''For Full Text Search:'''[[BR]]
    3338*    Proper understanding and the work model of S3Search(depricated) and S3Filter is required.
    3439
     
    4146*    Extend the functionality of S3Filter by introducing an addition feature (which is a text field) to search for text through documents.
    4247
    43 *
     48*    A user interface for displaying the search result.
    4449 
    4550=== Non-functional ===
    4651=== Standards ===
    4752=== System Constraints ===
    48 * The user should have PyLucene installed in there machine.
    49 * Also, while starting the web2py server, the Lucence deamon should also start.
    50 * In case of failure, the search query related to full-text search will not be functional.
     53
     54*    The user should have PyLucene installed in there machine.
     55
     56*    Also, while starting the web2py server, the Lucence deamon should also start.
     57
     58*    In case of failure, the search query related to full-text search will not be functional.
     59
    5160== Use-Cases ==
     61
    5262[[Image(search.png)]]
     63
    5364== Design ==
    5465
    5566=== Workflows ===
     67
     68'''For Full-Text Search:'''
     69*    The workflow will be according to the use case described above. First the user should need to analyze whether he wants to search through all the uploaded documents or any resource specific document.[[BR]]
     70UnRelated Search:
     71*    The user should go the the Document -> Search.
     72
     73*    Type the following query(string) he wants to search for.
     74
     75*    The output will be the response of the Lucene Daemon running in the background.
     76
     77*    T
    5678
    5779=== Site Map ===