requirements: initial layout

7 files changed, 415 insertions, 0 deletions

diff --git a/devel/requirements/1_introduction.xml b/devel/requirements/1_introduction.xml
new file mode 100644
index 0000000..1131070
--- /dev/null
+++ b/devel/requirements/1_introduction.xml
@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="utf-8"?>
+<chapter label="1" id="introduction">
+    <title>Introduction</title>
+    <para/>
+    <section id="purpose">
+        <title>Purpose</title>
+        <para/>
+    </section>
+    <section id="conventions">
+        <title>Document Conventions</title>
+        <para/>
+    </section>
+    <section id="audience">
+        <title>Intended Audience</title>
+        <para/>
+    </section>
+    <section id="scope">
+        <title>Project Scope</title>
+        <para/>
+    </section>
+    <section id="references">
+        <title>References</title>
+        <para/>
+    </section>
+</chapter>
diff --git a/devel/requirements/2_description.xml b/devel/requirements/2_description.xml
new file mode 100644
index 0000000..b17cbe2
--- /dev/null
+++ b/devel/requirements/2_description.xml
@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="utf-8"?>
+<chapter label="2" id="description">
+    <title>Overall Description</title>
+    <para/>
+    <section id="perspective">
+        <title>Project Perspective</title>
+        <para/>
+    </section>
+    <section id="features">
+        <title>Project Features</title>
+        <para/>
+    </section>
+    <section id="users">
+        <title>User Classes and Characteristics</title>
+        <para/>
+    </section>
+    <section id="environment">
+        <title>Operating Enviornment</title>
+        <para/>
+    </section>
+    <section id="constraints">
+        <title>Implementation Constraints</title>
+        <para/>
+    </section>
+    <section id="documentation">
+        <title>User Documentation</title>
+        <para/>
+    </section>
+    <section id="assumptions">
+        <title>Assumptions</title>
+        <para/>
+    </section>
+    <section id="dependencies">
+        <title>Project Dependencies</title>
+        <para/>
+    </section>
+</chapter>
diff --git a/devel/requirements/3_functional.xml b/devel/requirements/3_functional.xml
new file mode 100644
index 0000000..f656430
--- /dev/null
+++ b/devel/requirements/3_functional.xml
@@ -0,0 +1,253 @@
+<?xml version="1.0" encoding="utf-8"?>
+<chapter label="3" id="functional">
+    <title>Functional System Requirements</title>
+    <para/>
+    <section id="ui">
+        <title>Horizon UI</title>
+        <para/>
+        <section id="ui_language">
+            <title>User Language Selection</title>
+            <para/>
+            <section id="ui_language_meta">
+                <title>Description / Priority</title>
+                <para/>
+            </section>
+            <section id="ui_language_req">
+                <title>Functional Requirements</title>
+                <formalpara>
+                    <title/>
+                    <para/>
+                </formalpara>
+            </section>
+        </section>
+        <section id="ui_introduction">
+            <title>Initial Introduction</title>
+            <para/>
+            <section id="ui_introduction_meta">
+                <title>Description / Priority</title>
+                <para/>
+            </section>
+            <section id="ui_introduction_req">
+                <title>Functional Requirements</title>
+                <formalpara>
+                    <title/>
+                    <para/>
+                </formalpara>
+            </section>
+        </section>
+        <section id="ui_input">
+            <title>Input Device Configuration</title>
+            <para/>
+            <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>
+            <para/>
+            <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_network">
+            <title>Networking Setup</title>
+            <para/>
+            <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>
+            <para/>
+            <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>
+            <para/>
+            <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>
+            <para/>
+            <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>
+            <para/>
+            <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>
+            <para/>
+            <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>
+            <para/>
+            <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>
+            <para/>
+            <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>
+            <para/>
+            <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/>
+        <section id="runner_locate">
+            <title>Locate HorizonScript</title>
+            <para/>
+            <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>
+            <para/>
+            <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>
+            <para/>
+            <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>
diff --git a/devel/requirements/4_interface.xml b/devel/requirements/4_interface.xml
new file mode 100644
index 0000000..2dae28d
--- /dev/null
+++ b/devel/requirements/4_interface.xml
@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="utf-8"?>
+<chapter label="4" id="interface">
+    <title>External Interface Requirements</title>
+    <para/>
+    <section id="ui_design">
+        <title>User Interfaces</title>
+        <para/>
+    </section>
+    <section id="hardware">
+        <title>Hardware Interfaces</title>
+        <para/>
+    </section>
+    <section id="software">
+        <title>External Software Interfaces</title>
+        <para/>
+    </section>
+    <section id="comms">
+        <title>External Communication Interfaces</title>
+        <para/>
+    </section>
+    <section id="ui_runner">
+        <title>UI to Runner Interface</title>
+        <para/>
+    </section>
+</chapter>
diff --git a/devel/requirements/5_nonfunctional.xml b/devel/requirements/5_nonfunctional.xml
new file mode 100644
index 0000000..dbeb401
--- /dev/null
+++ b/devel/requirements/5_nonfunctional.xml
@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="utf-8"?>
+<chapter label="5" id="nonfunctional">
+    <title>Non-functional Requirements</title>
+    <para/>
+    <section id="performance">
+        <title>Performance Requirements</title>
+        <para/>
+    </section>
+    <section id="safety">
+        <title>Safety Requirements</title>
+        <para/>
+    </section>
+    <section id="security">
+        <title>Security Requirements</title>
+        <para/>
+    </section>
+    <section id="sqa">
+        <title>Software Quality Attributes</title>
+        <para/>
+    </section>
+</chapter>
diff --git a/devel/requirements/6_other.xml b/devel/requirements/6_other.xml
new file mode 100644
index 0000000..c24ed51
--- /dev/null
+++ b/devel/requirements/6_other.xml
@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="utf-8"?>
+<chapter label="6" id="other">
+    <title>Other Requirements</title>
+    <para/>
+    <section id="logging">
+        <title>Logging Requirements</title>
+        <para/>
+    </section>
+    <section id="i18n">
+        <title>Internationalisation Requirements</title>
+        <para/>
+    </section>
+</chapter>
diff --git a/devel/requirements/requirements.xml b/devel/requirements/requirements.xml
new file mode 100644
index 0000000..cfad194
--- /dev/null
+++ b/devel/requirements/requirements.xml
@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+               "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+               <!ENTITY chap1 SYSTEM "1_introduction.xml">
+               <!ENTITY chap2 SYSTEM "2_description.xml">
+               <!ENTITY chap3 SYSTEM "3_functional.xml">
+               <!ENTITY chap4 SYSTEM "4_interface.xml">
+               <!ENTITY chap5 SYSTEM "5_nonfunctional.xml">
+               <!ENTITY chap6 SYSTEM "6_other.xml">
+]>
+<book>
+    <bookinfo>
+        <title>Project Horizon: Requirements</title>
+        <authorgroup>
+            <author><firstname>A.</firstname><surname>Wilcox</surname><affiliation><orgname>Adélie Linux</orgname></affiliation></author>
+            <author><firstname>Tambra</firstname><surname>Wilcox</surname><affiliation><orgname>Adélie Linux</orgname></affiliation></author>
+            <author><firstname>Elizabeth</firstname><surname>Myers</surname><affiliation><orgname>The Interlinked Foundation</orgname></affiliation></author>
+            <author><firstname>Jeremy</firstname><surname>Rand</surname><affiliation><orgname>Namecoin</orgname></affiliation></author>
+            <author><firstname>Lee</firstname><surname>Starnes</surname></author>
+            <author><firstname>Max</firstname><surname>Rees</surname></author>
+            <author><firstname>Samuel</firstname><surname>Holland</surname></author>
+        </authorgroup>
+        <edition>Requirements for Horizon 1.0: Draft</edition>
+        <pubdate>2019</pubdate>
+        <copyright>
+            <year>2019</year>
+            <holder>Adélie Linux</holder>
+        </copyright>
+        <legalnotice>
+            <para>Development documentation for Project Horizon is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.</para>
+            <para>You should have received a copy of the license along with this work. If not, see <ulink url="https://creativecommons.org/licenses/by-nc-sa/4.0/"><citetitle>the Creative Commons Web site</citetitle></ulink>.</para>
+        </legalnotice>
+        <abstract><para>This document describes the functional and non-functional software requirements for Project Horizon, the installation system for Adélie Linux.</para></abstract>
+    </bookinfo>
+    &chap1;
+    &chap2;
+    &chap3;
+    &chap4;
+    &chap5;
+    &chap6;
+</book>