Changes between Version 10 and Version 11 of BluePrintSearch


Ignore:
Timestamp:
03/01/11 10:15:29 (11 years ago)
Author:
Dominic König
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • BluePrintSearch

    v10 v11  
    1010  - ''coming soon''
    1111
     12== Use-Cases ==
     13
     14  - ''coming soon''
     15
    1216== Requirements ==
    1317
    14 === Search Methods ===
     18=== Functional Requirements ===
    1519
    1620  - ''tbd''
    1721
    18 === User Interface ===
     22=== Usability Requirements ===
    1923
    2024  - ''tbd''
    21 == Use-Cases ==
    2225
    23   - ''coming soon''
     26=== Performance Requirements ===
     27
     28  - ''tbd''
     29
     30=== Implementation Requirements ===
     31
     32  - ''tbd''
    2433
    2534== Design ==
     
    2938  - ''add mockups here''
    3039
     40== Implementation ==
     41
    3142=== Back-End ===
    32 === Introduction ===
     43
     44==== REST Interface ====
    3345
    3446The '''S3Find''' class implements the '''[wiki:S3XRC/S3Method S3Method]''' interface, and is connected to the {{{search}}} URL method in [wiki:S3XRC/RESTfulAPI/s3_rest_controller s3_rest_controller]:
     
    5264
    5365See the next paragraph for how to build and connect a custom '''S3Find''' instance for a resource.
    54 === Interactive search methods ===
     66
     67==== Configuring Interactive search methods ====
    5568
    5669For interactive search, a custom '''S3Find''' instance can be configured per resource, using instances of classes implementing the '''S3SearchWidget''' interface to create search forms.
     
    117130
    118131When calling the {{{search}}} method, the {{{simple}}} form will be opened first, while the {{{advanced}}} form is hidden (if only the advanced form is defined, then it will of course not be hidden). By clicking the ''Advanced Search'' link below the form, the user can switch to the {{{advanced}}} form, and vice versa. The forms are independent, i.e. the user can only submit one of them.
    119 == Implementation ==
    120132
    121133  - {{{modules/s3/s3find.py}}}
    122134
    123 === S3SearchWidgets ===
     135=== S3SearchWidgets ====
    124136
    125 ==== S3SearchSimpleWidget ====
     137===== S3SearchSimpleWidget =====
    126138
    127139  - ''tbd''
    128140
    129 ==== S3SearchMinMaxWidget ====
     141===== S3SearchMinMaxWidget =====
    130142
    131143  - ''tbd''
    132144
    133 ==== S3SearchSelectWidget ====
     145===== S3SearchSelectWidget =====
    134146
    135147  - ''tbd''
    136148
    137 ==== S3SearchLocationWidget ====
     149===== S3SearchLocationWidget =====
    138150
    139151  - ''tbd''
    140152
    141 === S3Find Subclasses ===
     153==== S3Find Subclasses ====
    142154
    143 ==== S3PersonSearch ====
     155===== S3PersonSearch =====
    144156
    145157  - ''tbd''
    146158
    147 ==== S3LocationSearch ====
     159===== S3LocationSearch =====
    148160
    149161  - ''tbd''