summaryrefslogtreecommitdiff
path: root/devel/requirements/3_functional.xml
blob: 0ef810f54c417b6280b2cbacb34fdec194a94d2d (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
<?xml version="1.0" encoding="utf-8"?>
<chapter label="3" id="functional">
    <title>Functional System Requirements</title>
    <section id="ui">
        <title>Horizon UI</title>
        <para>The Horizon UI is the wizard-style user interface component of Project Horizon.  The system takes the input of the user and creates a HorizonScript.  The resultant HorizonScript is either executed on the running system when started in an installation environment, or saved for later use when started in a runtime environment.</para>
        <section id="ui_language">
            <title>User Language Selection</title>
            <section id="ui_language_meta">
                <title>Description / Priority</title>
                <para>A User must determine what natural language they are most comfortable with using for installing Adélie Linux.  The system shall allow the User to select their preferred natural language from a list of the languages to which the system has been translated.  Priority: Medium.</para>
            </section>
            <section id="ui_language_req">
                <title>Functional Requirements</title>
                <formalpara id="UI.Language.List">
                    <title>UI.Language.List</title>
                    <para>The system shall present the User with a list of natural languages, in the form of: "Install Adélie using English", "Installer Adélie en français".</para>
                </formalpara>
                <formalpara id="UI.Language.Button">
                    <title>UI.Language.Button</title>
                    <para>For this screen only, the system shall present the "Next" button as a single right-facing arrow.  The system shall not present the Cancel button on this screen.</para>
                </formalpara>
                <formalpara id="UI.Language.Enable">
                    <title>UI.Language.Enable</title>
                    <para>When the User chooses a language from the list, the system shall enable the Next button to be clicked.</para>
                </formalpara>
            </section>
            <section id="ui_language_key">
                <title>HorizonScript Keys</title>
                <formalpara id="Script.Key.language">
                    <title>Script.Key.language</title>
                    <para><varname>language</varname> &mdash; the locale identifier of the language chosen</para>
                </formalpara>
            </section>
        </section>
        <section id="ui_introduction">
            <title>Initial Introduction</title>
            <section id="ui_introduction_meta">
                <title>Description / Priority</title>
                <para>The system shall provide the User with an overview of the installation process, and introduce common UI elements.  A User may choose to run a tool or proceed with the installation.</para>
            </section>
            <section id="ui_introduction_req">
                <title>Functional Requirements</title>
                <formalpara id="UI.Intro.Describe">
                    <title>UI.Intro.Describe</title>
                    <para>The system shall present the User with a greeting message including a high-level overview of the installation process.  The system shall reassure the user that the installation process will not modify any data until the final step.</para>
                </formalpara>
                <formalpara id="UI.Intro.Elements">
                    <title>UI.Intro.Elements</title>
                    <para>The system shall describe the UI elements common to each screen, including the Help button, the Back/Next buttons, and the Cancel button.</para>
                </formalpara>
                <formalpara id="UI.Intro.Tools">
                    <title>UI.Intro.Tools</title>
                    <para>The system shall allow the User to start a tool from the following list before beginning the installation.
                        <orderedlist id="UIT">
                            <listitem id="UIT-1"><para>A terminal.</para></listitem>
                            <listitem id="UIT-2"><para>An external partition editor.</para></listitem>
                            <listitem id="UIT-3"><para>A lightweight Web browser.</para></listitem>
                        </orderedlist>
                    </para>
                </formalpara>
            </section>
        </section>
        <section id="ui_input">
            <title>Input Device Configuration</title>
            <section id="ui_input_meta">
                <title>Description / Priority</title>
                <para/>
            </section>
            <section id="ui_input_req">
                <title>Functional Requirements</title>
                <formalpara>
                    <title/>
                    <para/>
                </formalpara>
            </section>
        </section>
        <section id="ui_partition">
            <title>Disk Partitioning Setup</title>
            <section id="ui_partition_meta">
                <title>Description / Priority</title>
                <para/>
            </section>
            <section id="ui_partition_req">
                <title>Functional Requirements</title>
                <formalpara>
                    <title/>
                    <para/>
                </formalpara>
            </section>
        </section>
        <section id="ui_firmware">
            <title>Firmware Setup</title>
            <section id="ui_firmware_meta">
                <title>Description / Priority</title>
                <para/>
            </section>
            <section id="ui_firmware_req">
                <title>Functional Requirements</title>
                <formalpara>
                    <title/>
                    <para/>
                </formalpara>
            </section>
        </section>
        <section id="ui_network">
            <title>Networking Setup</title>
            <section id="ui_network_meta">
                <title>Description / Priority</title>
                <para/>
            </section>
            <section id="ui_network_req">
                <title>Functional Requirements</title>
                <formalpara>
                    <title/>
                    <para/>
                </formalpara>
            </section>
        </section>
        <section id="ui_sysmeta">
            <title>System Metadata Setup</title>
            <section id="ui_sysmeta_meta">
                <title>Description / Priority</title>
                <para/>
            </section>
            <section id="ui_sysmeta_req">
                <title>Functional Requirements</title>
                <formalpara>
                    <title/>
                    <para/>
                </formalpara>
            </section>
        </section>
        <section id="ui_packages">
            <title>Package and Package Set Selection</title>
            <section id="ui_packages_meta">
                <title>Description / Priority</title>
                <para/>
            </section>
            <section id="ui_packages_req">
                <title>Functional Requirements</title>
                <formalpara>
                    <title/>
                    <para/>
                </formalpara>
            </section>
        </section>
        <section id="ui_boot">
            <title>Boot Setup</title>
            <section id="ui_boot_meta">
                <title>Description / Priority</title>
                <para/>
            </section>
            <section id="ui_boot_req">
                <title>Functional Requirements</title>
                <formalpara>
                    <title/>
                    <para/>
                </formalpara>
            </section>
        </section>
        <section id="ui_accounts">
            <title>System Accounts Setup</title>
            <section id="ui_accounts_meta">
                <title>Description / Priority</title>
                <para/>
            </section>
            <section id="ui_accounts_req">
                <title>Functional Requirements</title>
                <formalpara>
                    <title/>
                    <para/>
                </formalpara>
            </section>
        </section>
        <section id="ui_writeout">
            <title>Save HorizonScript</title>
            <section id="ui_writeout_meta">
                <title>Description / Priority</title>
                <para/>
            </section>
            <section id="ui_writeout_req">
                <title>Functional Requirements</title>
                <formalpara>
                    <title/>
                    <para/>
                </formalpara>
            </section>
        </section>
        <section id="ui_commit">
            <title>Begin Installation</title>
            <section id="ui_commit_meta">
                <title>Description / Priority</title>
                <para/>
            </section>
            <section id="ui_commit_req">
                <title>Functional Requirements</title>
                <formalpara>
                    <title/>
                    <para/>
                </formalpara>
            </section>
        </section>
        <section id="ui_perform">
            <title>Perform Installation</title>
            <section id="ui_perform_meta">
                <title>Description / Priority</title>
                <para/>
            </section>
            <section id="ui_perform_req">
                <title>Functional Requirements</title>
                <formalpara>
                    <title/>
                    <para/>
                </formalpara>
            </section>
        </section>
        <section id="ui_finish">
            <title>Installation Completion</title>
            <section id="ui_finish_meta">
                <title>Description / Priority</title>
                <para/>
            </section>
            <section id="ui_finish_req">
                <title>Functional Requirements</title>
                <formalpara>
                    <title/>
                    <para/>
                </formalpara>
            </section>
        </section>
    </section>
    <section id="runner">
        <title>Horizon Runner</title>
        <para>The Horizon Runner is the component of Project Horizon that configures a computer to match an input HorizonScript.</para>
        <section id="runner_locate">
            <title>Locate HorizonScript</title>
            <section id="runner_locate_meta">
                <title>Description / Priority</title>
                <para/>
            </section>
            <section id="runner_locate_req">
                <title>Functional Requirements</title>
                <formalpara>
                    <title/>
                    <para/>
                </formalpara>
            </section>
        </section>
        <section id="runner_net">
            <title>Network Configuration</title>
            <section id="runner_net_meta">
                <title>Description / Priority</title>
                <para/>
            </section>
            <section id="runner_net_req">
                <title>Functional Requirements</title>
                <formalpara>
                    <title/>
                    <para/>
                </formalpara>
            </section>
        </section>
        <section id="runner_execute">
            <title>Execute HorizonScript</title>
            <section id="runner_execute_meta">
                <title>Description / Priority</title>
                <para/>
            </section>
            <section id="runner_execute_req">
                <title>Functional Requirements</title>
                <formalpara>
                    <title/>
                    <para/>
                </formalpara>
            </section>
        </section>
    </section>
</chapter>