Diffstat (limited to 'noncore/tools/clock/specification.html') (more/less context) (ignore whitespace changes)
-rw-r--r-- | noncore/tools/clock/specification.html | 145 |
1 files changed, 145 insertions, 0 deletions
diff --git a/noncore/tools/clock/specification.html b/noncore/tools/clock/specification.html new file mode 100644 index 0000000..5913277 --- a/dev/null +++ b/noncore/tools/clock/specification.html | |||
@@ -0,0 +1,145 @@ | |||
1 | <html> | ||
2 | <title> | ||
3 | Clock Specification | ||
4 | </title> | ||
5 | |||
6 | <body> | ||
7 | |||
8 | <h1>Clock Specification</h1> | ||
9 | |||
10 | |||
11 | <!-- | ||
12 | <h2>Specification goals</h2> | ||
13 | This specification: | ||
14 | <ol> | ||
15 | <li> Describes all of the end-user stories and interactions. | ||
16 | (eg. the user can view a slide show of images from a digital camera). | ||
17 | <li> Lists all features, derived from end-user stories, | ||
18 | in enough detail to allow the definition of | ||
19 | tests for all features. | ||
20 | <li> Defines contraints and limitations on the application. | ||
21 | (eg. can view image sizes as large as 1MB). | ||
22 | <li>Aides the developer on focusing on the most important aspects of | ||
23 | the application and ensuring all important elements are completed. | ||
24 | </ol> | ||
25 | --> | ||
26 | |||
27 | <a name=description> | ||
28 | </a> | ||
29 | <!-- A one-line description of what this application is and does. | ||
30 | This description is then duplicated in the .desktop Comment and | ||
31 | the .control file description. | ||
32 | |||
33 | (eg. The image viewer allows viewing and very minor editing of image files.) | ||
34 | --> | ||
35 | The clock shows the time, a stopwatch and allows a daily alarm to be set. | ||
36 | <!-- A one-paragraph description of what this application is and does. | ||
37 | This description is then duplicated in the .desktop Comment and | ||
38 | the .control file description. | ||
39 | |||
40 | (eg. The image viewer allows viewing and very minor editing | ||
41 | of image files. It assists format conversion, beaming logos | ||
42 | to phones, captioning, etc.) | ||
43 | --> | ||
44 | <p> | ||
45 | The clock provides three functions: 1. Displays the current date and time. | ||
46 | 2. Provides a stopwatch. 3. Allows a daily alarm to be set and enabled/disabled. | ||
47 | </p> | ||
48 | |||
49 | <p> | ||
50 | Status: BT | ||
51 | </p> | ||
52 | |||
53 | <a name=usecases> | ||
54 | <h2>Use Cases</h2> | ||
55 | </a> | ||
56 | <!-- Describe real-world stories. Implicit in these use cases is | ||
57 | "these things are easy to do". | ||
58 | (eg. | ||
59 | Roving News Reporter | ||
60 | |||
61 | The journalist/cameraman takes photos with a digital camera, | ||
62 | loads them into the PDAs via CF card, adjusts the contrast, | ||
63 | blacks-out a license plate, adds a copyright caption, and | ||
64 | emails the image and short story to Reuters. | ||
65 | ) | ||
66 | |||
67 | Note: TITLEs may be used as identifiers in bug reports. | ||
68 | --> | ||
69 | <ul> | ||
70 | <li><b>Viewing Date and Time</b> | ||
71 | <p>While the PDA is in its cradle, the office worker uses it as a | ||
72 | desktop clock. | ||
73 | <li><b>Jogger</b> | ||
74 | <p>A jogger runs around a 400m track 6 times. He starts the stopwatch as | ||
75 | he starts, and presses a button each time he rounds the track. He can | ||
76 | observe the precise time taken for each lap. | ||
77 | <li><b>Setting Daily Alarm</b> | ||
78 | <p>The traveller sets an alarm to wake him up at 5:30 each morning. | ||
79 | <p>(not yet implemented: The traveller never wants to be woken on Saturday, | ||
80 | Sunday, or Wednesday; the traveller can easily press a "Snooze" button | ||
81 | to get a little more rest, but the alarm will sound again; he never | ||
82 | misses getting woken) | ||
83 | </ul> | ||
84 | |||
85 | <a name=features> | ||
86 | <h2>Features</h2> | ||
87 | </a> | ||
88 | <!-- features are brief | ||
89 | |||
90 | (eg. | ||
91 | * Slide show: view multiple images in sequence | ||
92 | * Configurable delay between images. | ||
93 | * Hardware-button-controlled stepping between images. | ||
94 | * Big images: view larger-than-available-RAM images in some formats. | ||
95 | * Formats: view JPEG, PNG, GIF format images. | ||
96 | * Scribbling: draw black or white lines on images. | ||
97 | * Save: in JPEG, PNG formats. | ||
98 | ) | ||
99 | |||
100 | Note: TITLEs may be used as identifiers in bug reports. | ||
101 | --> | ||
102 | |||
103 | <ul> | ||
104 | <li>Clock: Display an analog clock, digital clock and the date in one view. | ||
105 | <li>Stopwatch: Display an analog and digital stopwatch timer. | ||
106 | The digital timer has a resolution of 1/100 second. | ||
107 | <ul> | ||
108 | <li>Start/Stop: The [Select] hardware button must Start/Stop the stopwatch. | ||
109 | </ul> | ||
110 | <li>Daily Alarm: Allows a daily alarm to be enabled/disabled and set. | ||
111 | <ul> | ||
112 | <li>Audible Alarm: When the alarm is activated an audible alarm must be | ||
113 | sounded. | ||
114 | <li>Visual Alarm: When the alarm is activated a dialog box must be shown | ||
115 | with the alarm details. | ||
116 | </ul> | ||
117 | </ul> | ||
118 | |||
119 | <a name=prerequisites> | ||
120 | <h2>Prerequisites</h2> | ||
121 | </a> | ||
122 | <!-- | ||
123 | Describes unresolved limitations that cannot | ||
124 | be shown within the features list. | ||
125 | |||
126 | Describes memory and other requirements quantitatively. | ||
127 | |||
128 | This is a short list, mainly intended as a "known bugs" | ||
129 | list for missing features. | ||
130 | |||
131 | (eg. | ||
132 | * Stylus: required for Scribbling. | ||
133 | * Memory: requires 250 bytes per event, plus content strings. | ||
134 | ) | ||
135 | |||
136 | Note: TITLEs may be used as identifiers in bug reports. | ||
137 | --> | ||
138 | |||
139 | <ul> | ||
140 | <li>Alarm Server: requires a working alarm server for daily alarm function. | ||
141 | <li>Audible Alarm: requires speaker/buzzer. | ||
142 | </ul> | ||
143 | |||
144 | </body> | ||
145 | </html> | ||