Functional System Requirements
Horizon UI
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.
System Initialisation
Functional Requirements
UI.Early.LoadFirmware
If the User has specified to load firmware in the installation environment, the system shall install the linux-firmware package to the installation environment before eudev is started.
UI.Early.DetectGfx
The system shall detect all usable graphics adaptors present in the computer.
UI.Early.NoGfx
If there are no usable graphics adaptors present, the system shall display a message that installation cannot continue, and allow the User to login to a virtual TTY or reboot the computer.
UI.Early.MultiGfx
If multiple graphics adaptors are present, the system shall attempt to determine which graphics adaptor has a monitor attached. If the determiniation is that multiple graphics adaptors have monitors attached, or it is indeterminiate which adaptor has a monitor attached, then the system shall prompt the User to choose which graphics adaptor to use for installation.
Global UI Requirements
Functional Requirements
UI.Global.Cancel
The system shall display a Cancel button on every screen.
UI.Global.Cancel.Confirm
If the User chooses the Cancel button, the system shall confirm that the User wishes to cancel installation. The system shall additionally explain that no data has been modified yet, and that cancelling installation will cause the computer to reboot.
UI.Global.Cancel.Perform
If the User chooses to confirm cancellation of the installation, the system shall reboot the computer.
UI.Global.Back
The system shall display a Back button on every screen except the initial screen, which will move the User back to the previous screen.
UI.Global.Back.Save
If the User chooses to go back to a previous screen, the system shall save any changes the User has made to the current screen before moving back to the previous screen. The system shall then redisplay those changes when the current screen is shown again.
User Language Selection
Prerequisites
UI.Language.Prerequisites
The system must have more than one language translation available for use.
Functional Requirements
UI.Language.List
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".
UI.Language.Button
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.
UI.Language.Enable
When the User chooses a language from the list, the system shall enable the Next button to be clicked.
HorizonScript Keys
Script.Key.language
language — The locale identifier of the chosen language.
Initial Introduction
Functional Requirements
UI.Intro.Describe
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.
UI.Intro.Elements
The system shall describe the UI elements common to each screen, including the Help button, the Back/Next buttons, and the Cancel button.
UI.Intro.Tools
The system shall allow the User to start a tool from the following list before beginning the installation.
A terminal.
An external partition editor.
A lightweight Web browser.
Firmware Setup
Prerequisites
UI.Firmware.Prerequisites
The system must have firmware support compiled in.
Functional Requirements
UI.Firmware.Prompt
The system shall ask the User whether or not to load binary firmware, stressing that security-sensitive systems must not choose this option.
UI.Firmware.Load
If the User chooses to load binary firmware, the system shall add the APK Fission repository and the linux-firmware package to the installed environment.
HorizonScript Keys
Script.Key.firmware
firmware — Whether to load firmware.
Networking Setup
Prerequisites
UI.Network.Prerequisites
The system must have at least one non-loopback network interface detected by the kernel.
Functional Requirements
UI.Network.AddressType
The system shall ask the User whether they wish to use automatic addressing (DHCP), manual addressing, or disable network connectivity.
UI.Network.AddressType.MaybeNotDisable
The system shall not allow the User to disable network connectivity if any required repository is unavailable locally.
UI.Network.AddressType.Skip
If the User chooses to disable network connectivity, the system shall proceed to the System Metadata screen.
UI.Network.RuntimeEnv
If Horizon UI is running in a runtime environment instead of an installation environment, the system shall allow the User to add their network interface by device name before proceeding.
UI.Network.ChooseIface
If the computer has more than one network interface, the system shall prompt the User to choose which interface to use for installation.
UI.Network.Wireless
If the chosen network interface is a wireless network interface, the system shall display a Wireless Configuration screen.
UI.Network.Wireless.None
The system shall allow the User to disable wireless connectivity.
UI.Network.Wireless.None.Multi
If the User has chosen to disable wireless connectivity, and the computer has multiple network interfaces, the system shall start at UI.Network.ChooseIface again.
UI.Network.Wireless.None.Single
If the User has chosen to disable wireless connectivity, and the computer only has wireless networking, the system shall prompt the User to confirm they wish to continue without networking.
UI.Network.Wireless.APs
The system shall display a list of access points in range of the wireless interface for the User to select from.
UI.Network.Wireless.CustomAP
The system shall allow the User to input a custom access point name.
UI.Network.Wireless.Security
If the chosen access point uses authentication, the system shall prompt the User for the requisite credentials.
UI.Network.Wireless.CustomSecurity
If the User inputs a custom access point name, the system shall prompt the User for the type of security used (or none) and requisite credentials.
UI.Network.Wireless.Enable
The system shall enable the Next button when an access point is selected or input, and the requisite credentials (if any) have been input.
UI.Network.Wireless.Connect
When the User chooses Next, the system shall attempt to connect to the specified wireless network.
UI.Network.Wireless.Error
If an error occurs during wireless network connection, the system shall display a message explaning the error condition, and redisplay the Wireless Configuration screen.
UI.Network.Wireless.ConnectTimeOut
The system shall time out after waiting 15 seconds for the wireless network to connect, and consider a time out an error condition as specified in UI.Network.Wireless.Error.
UI.Network.Automatic
If the User selected automatic addressing, the system shall attempt to obtain an IPv4 address via DHCP and an IPv6 address via Router Advertisement and DHCPv6.
UI.Network.Automatic.TimeOut
If no IP address is obtained for v4 or v6 after 15 seconds, the system shall display a message that automatic configuration failed, and ask the User whether to retry the attempt, use manual addressing, or skip networking configuration.
UI.Network.WirelessPortal
If the computer has obtained an address automatically and is using a wireless network, the system shall test if the network is using a captive portal by attempting to download the file at http://detectportal.firefox.com and determining if the response is success.
UI.Network.WirelessPortal.Open
If the captive portal test determines a captive portal is in use, the system shall open a lightweight Web browser and attempt to navigate to http://www.adelielinux.org/.
UI.Network.WirelessPortal.Open.Message
The system shall display a message on the lightweight Web browser that instructs the user to close the Web browser when network connectivity is established in order to continue the installation.
UI.Network.Manual
If the User selected manual address, the system shall prompt the User for the following information:
Network information to collect from User for manual configuration
Information
Description
IPv4 host address
The address of this computer
IPv4 subnet mask
The subnet mask / prefix of the network
IPv4 default gateway
The router on the network
IPv4 DNS resolver
The DNS resolver to use on IPv4 networks; default to 9.9.9.9
IPv6 host address
The address of this computer
IPv6 network prefix
The prefix of the network
IPv6 default gateway
The router on the network
IPv6 DNS resolver
The DNS resolver to use on IPv6 networks; default to 2620:fe::fe
UI.Network.Manual.Test
The system shall allow the User to test their network configuration by attempting to connect to distfiles.adelielinux.org.
UI.Network.Manual.Enable
The system shall enable the Next button when either an IPv4 or IPv6 configuration is complete (address, subnet mask, gateway, DNS resolver).
HorizonScript Keys
Script.Key.network
network — Whether to enable network connectivity.
Script.Key.netaddress
netaddress — Connection information.
Script.Key.nameserver
nameserver — DNS resolver information.
Script.Key.netssid
netssid — Wireless networking information.
Package and Package Set Selection
Functional Requirements
UI.Packages.DisabledNetwork
If the User has chosen to disable the network, the system shall only display presets and packages available for installation locally.
UI.Packages.SimpleSel
The system shall allow the User to choose from one of the following four preset package sets, or to customise the packages installed.
UI.Packages.SimpleSel.Standard
The system shall allow the User to choose the Standard preset, which uses adelie-base-posix as an anchor package, and includes the firefox-esr, libreoffice, thunderbird, and vlc packages, and the kde and x11 metapackages.
UI.Packages.SimpleSel.Notebook
The system shall allow the User to choose the Notebook preset, which includes the Standard preset and additional power management tools (UPower, pm-utils).
UI.Packages.SimpleSel.Minimal
The system shall allow the User to choose the Minimal preset, which uses adelie-base as an anchor package, and includes the lxqt-desktop, featherpad, netsurf, xorg-apps, xorg-drivers, and xorg-server packages.
UI.Packages.SimpleSel.MinimalTUI
The system shall allow the User to choose the Minimal Non-Graphical preset, which uses adelie-base as an anchor package, and includes the elinks and tmux packages.
UI.Packages.SimpleSel.Custom
The system shall allow the User to choose to customise the packages installed on their computer.
UI.Packages.SimpleSel.Enable
The system shall enable the Next button when a selection is made.
UI.Packages.Custom
If the User chooses Custom from UI.Packages.SimpleSel, the system shall present the User with a list of packages and package sets and allow the User to choose any or all of the packages listed. The system shall display the disk space used by each selection, and the total required for installation.
UI.Packages.Custom.Packages
The system shall offer at least the following packages, with the following names, descriptions, and corresponding APK package names.
Custom packages offered on the Package Selection screen
Name
Description
APK name
Firefox Web browser
The most popular and powerful Web browser for Linux. Includes JavaScript and multimedia (audio/video) playback support.
firefox-esr
Netsurf Web browser
Lightweight Web browser. Does not include JavaScript support.
netsurf
Thunderbird Email
Read and compose email, and participate in newsgroups.
thunderbird
FeatherPad
Lightweight text editor.
featherpad
LibreOffice
Popular, extensible office suite.
libreoffice: libreoffice-base, libreoffice-calc, libreoffice-draw, libreoffice-impress, libreoffice-math, libreoffice-writer
VLC Media Player
Popular multimedia player, including support for a wide variety of audio and video types.
vlc
KDE Applications
A variety of applications including a word processor, media player, and many games.
kde
KDE Plasma
Modern desktop environment with graphical effect support.
plasma-desktop
LXQt Desktop Environment
Lightweight desktop environment using the Openbox window manager and Qt widgets.
lxqt-desktop
MATE Desktop Environment
Traditional desktop environment based on the GNOME 2 look and feel.
mate-complete
XFCE Desktop Environment
Desktop environment based on Gtk+.
xfce-desktop
Window Managers
Individual window managers that are not part of a desktop environment.
awesome, fluxbox, i3wm, icewm, openbox, spectrwm
UI.Packages.Size
If the User has selected a package set or packages that will use more disk space than the computer has, the system shall prompt the User to confirm the selection and warn that installation may not be successful.
HorizonScript Keys
Script.Key.pkginstall
pkginstall — A space-separated list of packages to install.
System Accounts Setup
Functional Requirements
UI.Accounts.RootPW
The system shall prompt the User to enter a password for the root user.
UI.Accounts.RootPW.Confirm
The system shall prompt the User to re-enter the root user password to confirm accuracy.
UI.Accounts.RootPW.Explain
The system shall explain to the User the important of keeping the root user's password secure, and written in a safe place, as it is used for system administration.
UI.Accounts.RootPW.Enable
The system shall enable the Next button when the root password and confirmation match and represent a valid password.
UI.Accounts.UserAcct
The system shall prompt the User to enter their name or alias to personalise their copy of Adélie Linux, and up to four others.
UI.Accounts.UserAcct.AcctName
The system shall prompt the User to enter an account name for their user account.
UI.Accounts.UserAcct.AcctName.Default
The system shall use the following algorithm to provide a default account name for the User:
If the User's name or alias contains no spaces, let the account name be the entire name or alias.
If the User's name or alias contains spaces, let the account name be the first character of each word that is not the last word, and the full last word.
Transform the account name to a Latinised, lower-case form, as described by (Insert Unicode reference here).
If the account name is longer than 32 characters, truncate the account name to 32 characters.
UI.Accounts.UserAcct.Icon
The system shall allow the User to choose a personal icon to be shown on the system login screen from a list of preset icons.
UI.Accounts.UserAcct.Password
The system shall prompt the User to enter a password for their personal account.
UI.Accounts.UserAcct.Password.Confirm
The system shall prompt the User to re-enter their personal password to confirm accuracy.
UI.Accounts.UserAcct.Enable
The system shall enable the Next button when the user name, account name are valid, and the password and confirm password fields match and represent a valid password.
UI.Accounts.UserAcct.Others
The system shall allow the User to add up to four more user accounts, with account name, personal name/alias, personal icon, and password entry using the same requirements as the primary user acconut.
UI.Accounts.UserAcct.Others.Wheel
For each account the User adds, the system shall ask the User if the user should be an administrator or not. The primary user account will always be an administrator.
HorizonScript Keys
Script.Key.rootpw
rootpw — The crypt(3)-formatted, SHA-512 hashed password for the root account.
Script.Key.username
username — The account name(s) given.
Script.Key.useralias
useralias — The user's name or alias.
Script.Key.userpw
userpw — The crypt(3)-formatted, SHA-512 hashed password for the account(s).
Script.Key.usericon
usericon — Path to the chosen icon for the account(s).
Script.Key.usergroups
usergroups — The groups to which the user account(s) will belong. "users,lp,audio,cdrom,cdrw,usb,video,games" for normal users; add ",disk,wheel" for administrators.
Save HorizonScript
Prerequisites
UI.Writeout.Prerequisites
The system must be running in a runtime environment, not an installation environment.
Functional Requirements
UI.Writeout.Explain
The system shall inform the User that the system has finished collecting information and is now ready to save the resultant HorizonScript.
UI.Writeout.Button
The system shall replace the "Next" button with a "Save" button using the same keyboard accelerator as Next.
UI.Writeout.Save
When the User chooses "Save", the system shall open a dialogue for the user to navigate to the directory in which they wish to save the HorizonScript, and the name of the file-on disk which shall default to installfile.
UI.Writeout.Close
If the HorizonScript file is saved successfully, the system shall exit.
UI.Writeout.Failure
If the HorizonScript file cannot be saved successfully, the system shall display a message indicating the error, and then redisplay the writeout screen.
Begin Installation
Functional Requirements
UI.Commit.Explain
The system shall explain to the User that the next step will be performing the installation.
UI.Commit.Explain.Disk
If the disk partitioning will cause existing data to be modified or destroyed, the system shall additionally explain to the User that proceeding will modify or destroy the data on the disk(s) partitioned.
UI.Commit.Explain.Info
The system shall display the major choices the User has made in the installation. The choices shown shall be determined later during the UX design phase and are intentionally omitted from this requirements specification.
UI.Commit.Buttons
The system shall remove the Cancel button, and the Next button shall be labelled Install.
Installation Completion
Functional Requirements
UI.Finish
The system shall display a screen congratulating the User on a successful installation of Adélie Linux.
UI.Finish.Save
The system shall allow the User to save the HorizonScript and log files related to this installation to a storage location.
UI.Finish.Save.Error
If an error occurs while saving the HorizonScript and log files, the system shall display a message explaining the error, and allow the User to choose a different storage location.
UI.Finish.RemoveMedia
The system shall prompt the User to remove any installation media used, including optical media.
UI.Finish.Buttons
The system shall only display a single button: Complete, which uses the same keyboard accelerator as the Next button. The Complete button shall cause the system to reboot.
UI.Finish.Automatic
If the system is using a HorizonScript loaded from a file or network location, then the system shall automatically reboot the computer in 15 seconds.
&runner;