Coverage report: /home/samppa/personal/opiskelu/ohtuprojekti/pulsu/trunk/help.lisp

KindCoveredAll%
expression22100.0
branch00nil
Key
Not instrumented
Conditionalized out
Executed
Not executed
 
Both branches taken
One branch taken
Neither branch taken
1
 (in-package :puls.ui)
2
 
3
 (defpage (error-page :uri "/error") (message)
4
   (htm
5
    "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">"
6
    (:html
7
     :xmlns "http://www.w3.org/1999/xhtml"
8
     :xml\:lang "fi"
9
     :lang "fi"
10
     (:head
11
      (:meta :http-equiv "Content-Type"
12
             :content    "text/html;charset=iso-8859-1")
13
      (:title "Help")
14
      (:link :href "static/headerstyle.css" 
15
             :rel "stylesheet" 
16
             :type "text/css")
17
      (:link :href "static/helpstyle.css" 
18
             :rel "stylesheet" 
19
             :type "text/css")
20
      (:link :href "static/indexstyle.css" 
21
             :rel "stylesheet" 
22
             :type "text/css"))
23
     (:body :class "layout"
24
            (header)
25
            (:div :id "main_content" 
26
                  (:h2 "Help")
27
                  (:p (str message)))))))
28
 
29
 (defpage (help-page :uri "/help") ()
30
   (puls.controller::authenticate-user)  
31
   (htm
32
    "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">"
33
    (:html
34
     :xmlns "http://www.w3.org/1999/xhtml"
35
     :xml\:lang "fi"
36
     :lang "fi"
37
     (:head
38
      (:meta :http-equiv "Content-Type"
39
             :content    "text/html;charset=iso-8859-1")
40
      (:title "Help")
41
      (:link :href "static/headerstyle.css" 
42
             :rel "stylesheet" 
43
             :type "text/css")
44
      (:link :href "static/helpstyle.css" 
45
             :rel "stylesheet" 
46
             :type "text/css")
47
      (:link :href "static/indexstyle.css" 
48
             :rel "stylesheet" 
49
             :type "text/css"))
50
     (:body :class "layout"
51
            (header)
52
            (:div :id "main_content" 
53
                  (htm (:h2 "Help"))
54
                  "<div id=\"help\">
55
 <h2></a>Table of contents</h2>
56
 
57
 <p>1. Introduction</p>
58
 
59
 <p>2. Glossary</p>
60
 
61
 <p>3. User interface</p>
62
 
63
 <p>3.1 Unified cases</p>
64
 
65
 <p>3.1.1 Browsing unified cases</p>
66
 
67
 <p>3.1.2 Verified and unverified cases</p>
68
 
69
 <p>3.1.3 Searchbar</p>
70
 
71
 <p>3.1.4 Pager</p>
72
 
73
 <p>3.2 Document page</p>
74
 
75
 <p>3.2.1 Document text</p>
76
 
77
 <p>3.2.2 All cases of the unifies case or the document</p>
78
 
79
 <p>3.2.3 Modifying attributes of the case</p>
80
 
81
 <p>3.3 Plain case</p>
82
 
83
 <p>3.4 Map</p>
84
 
85
 <h2>1. Introduction</h2>
86
 
87
 <p>This is the user manual of the software engineering group PULSU that is taking part to software engineering course on fall 2008.</p>
88
 
89
 <h2>2. Glossary</h2>
90
 
91
 <table><tbody>
92
 <tr>
93
 <td> Document  </td>
94
 <td> Document which has been found from internet. Individual document may contain many cases.  </td>
95
 </tr>
96
 <tr>
97
 <td> Case  </td>
98
 
99
 <td> Fact, which has been collected from document by the system. </td>
100
 </tr>
101
 <tr>
102
 <td> Unified case  </td>
103
 <td> Group of cases which have similar attributes.  </td>
104
 </tr>
105
 <tr>
106
 <td> Plain cases  </td>
107
 
108
 <td> Cases without any grouping.  </td>
109
 </tr>
110
 <tr>
111
 <td> Attribute  </td>
112
 <td> Disease, country, time, total, status etc. Disease: Tells the name of disease in this case. Country: Tells the name of country in this case. 
113
 Time: Tells when this case happened. Total: Tells how many people have got disease. Status: Tells the current situation of disease.  </td>
114
 </tr>
115
 
116
 </tbody></table>
117
 
118
 <h2>3. User interface</h2>
119
 
120
 <p></p>
121
 
122
 <h4>3.1 Unified cases</h4>
123
 
124
 
125
 <h5>3.1.1 Browsing unified cases</h5>
126
 
127
 <p>There is a list of 25 newest unified cases in the Unified cases page. About every unified case is shown disease and country as well as a title of the document of the newest case. By clicking the title you get to the Document page of the case. On the left side of the unified cases, which have more than one case grouped together, there is a number, that shows how many cases belong to it and a triangle button. By clicking it you can bring out all cases of the unified case. By clicking it again the other cases are hidden. The list also hides itself automatically, if you click the triangle button of some other unified case. On top of the page is a \"i\" button which brings out and hides the sentences from where triggers of cases were found.</p>
128
 
129
 <h5>3.1.2 Verified and unverified cases</h5>
130
 
131
 <p>In front of verified cases are checked boxes and in front of unverified cases empty boxes. If all cases of the unified case are verified, then there is also a checked box in front of unified case. Whereas if one or more case of unified case are unverified, then in front of unified case is a empty box.</p>
132
 
133
 <h5>3.1.3 Searchbar</h5>
134
 
135
 <p>On top of the page is a simple search bar where you can write search parameters to find for example, cases which deal with certain disease. When needed, you can also click \"Advanced search\" link and make a more specific search by using filters. Up to five filters can be used simultaneously in which case you they are OR-searches. This means that you can search unified cases which fulfill at least all conditions of one filter, but not necessarily all filters. Besides search bar and filters, you can choose from the dropdown menu, whether all, verified or unverified instances of the unified cases or plain cases are shown. The chosen filter stays in use while you change from page to another, so it's possible to do a filter in Newest cases view and see those same cases on Map view, just by clicking the desired view. You can reset those filters by clicking the \"Clear filters\" button.</p>
136
 
137
 <h5>3.1.4 Pager</h5>
138
 
139
 <p>On top and bottom of the page is pager. If you click, for example, number 2, you get next 25 newest unified case. Numbering is continued until 30. All numbers aren't shown simultaneously, because shown numbers depend on what is the number of your current page.
140
 </p>
141
 
142
 <h4>3.2 Document page</h4>
143
 
144
 
145
 <h5>3.2.1 Document text</h5>
146
 
147
 <p>In the middle of page is the document from where the case was found. This case is highlighted in bold on the document text and its triggers is colored.</p>
148
 
149
 <h5>3.2.2 All cases of the unifies case or the document</h5>
150
 
151
 <p>All cases of the unified case or the document are listed to left side of the page, and in front of these are checkboxes. Above these cases is a link to cases of the document or the unified case depending on which ones are currently shown. By clicking it the list of unified cases changes to list of document cases or vice versa. By clicking cases you can easily read all cases which belong to the unified case or the document. There is also the currently shown case, but instead of a link it's highlighted in bold.</p>
152
 
153
 <h5></a>3.2.3 Modifying attributes of the case</h5>
154
 
155
 <p>On the right side of page are the attributes of the case. If you think that the values of the attributes are correct you can verify the case by clicking \"Accept case\" button. If they aren't you can first correct them and then click above-mentioned button.</p>
156
 
157
 <p>If you want to modify some value of the attributes you click pen button. When the pen button is clicked, value of the fixed text field changes to dropdown and the suitable values to this attribute found from the document are shown. If neither of these options are correct you can click the pen button again and the dropdown will change to a text field, where you can write the correct value. By clicking button once again, field changes back to fixed text field. You can drag pieces of text from the document by highlighting the desired text from the document with your mouse and dragging it in to the textfield. This is recommended, because there is smaller chance of typos.&nbsp; Below the attributes you can see how many attribute values are going to be changed and to how many cases these changes will affect.</p>
158
 
159
 <p>If you want to modify many cases simultaneously you can mark checkboxes of these cases from left side of the page. Then changing value of attribute will affect to all these cases.</p>
160
 
161
 <h5>3.2.4 Creating new case or rejecting false case.</h5>
162
 
163
 <p>You can also remove a case from the system by clicking \"Reject case\" button or create a new case to currently shown document by clicking \"New case\" button and the values of attributes changes to dropdowns or text field depending on type of the attribute. Lastly you can accept the values by clicking \"Make new case\" button and the new case is saved.</p>
164
 
165
 <p>By clicking \"Back to list\" link you get back to same page where you came to the Document page.</p>
166
 
167
 <h4>3.3 Plain case</h4>
168
 
169
 <p>In the Cases page, there is a list of 25 newest cases without any grouping. Otherwise the page is similar to Unified cases page.
170
 </p>
171
 
172
 <h4></a>3.4 Map</h4>
173
 
174
 <p>There is a map in the Map page where cases are shown. You can use simple searchbar and filters also in this page. By clicking the map icons, you can get extra information.</p>
175
 
176
 </div>
177
 ")))))