Added the welsh characters and support for multiple words in the UI Presentation

This commit is contained in:
osp1 2020-02-23 18:03:42 +00:00
parent 28d1b8d9a9
commit 4a5ee22c7a
22 changed files with 13 additions and 13 deletions

View file

@ -1,4 +1,4 @@
This is pdfTeX, Version 3.14159265-2.6-1.40.20 (TeX Live 2019/Arch Linux) (preloaded format=pdflatex 2020.2.3) 21 FEB 2020 00:21
This is pdfTeX, Version 3.14159265-2.6-1.40.20 (TeX Live 2019/Arch Linux) (preloaded format=pdflatex 2020.2.3) 23 FEB 2020 16:19
entering extended mode
restricted \write18 enabled.
%&-line parsing enabled.
@ -534,7 +534,7 @@ Here is how much of TeX's memory you used:
10034 multiletter control sequences out of 15000+600000
9500 words of font info for 33 fonts, out of 8000000 for 9000
1141 hyphenation exceptions out of 8191
33i,13n,38p,980b,415s stack positions out of 5000i,500n,10000p,200000b,80000s
33i,13n,38p,981b,415s stack positions out of 5000i,500n,10000p,200000b,80000s
</usr/share/texmf-dist/fonts/type1/public/amsfonts/cm/cmbx10.pfb></usr/share/
texmf-dist/fonts/type1/public/amsfonts/cm/cmbx12.pfb></usr/share/texmf-dist/fon
ts/type1/public/amsfonts/cm/cmr10.pfb></usr/share/texmf-dist/fonts/type1/public
@ -544,7 +544,7 @@ e/texmf-dist/fonts/type1/public/amsfonts/cm/cmsy10.pfb></usr/share/texmf-dist/f
onts/type1/public/amsfonts/cm/cmti10.pfb></usr/share/texmf-dist/fonts/type1/pub
lic/amsfonts/cm/cmti9.pfb>
Output written on /home/noble/.git/gp20/dev/20200218/osp1/UI-Spec-Documentation
/ui-spec.pdf (11 pages, 456222 bytes).
/ui-spec.pdf (11 pages, 456209 bytes).
PDF statistics:
276 PDF objects out of 1000 (max. 8388607)
232 compressed objects within 3 object streams

View file

@ -17,7 +17,7 @@
\subtitle{User Interface Specification}
\author{Oscar Pocock, Kain Bryan-Jones}
\shorttitle{Software Engineering Group Project 20 - User Interface Specification}
\version{0.3}
\version{0.4}
\status{For review}
\date{2020-02-20}
\configref{UISpecGroup20}
@ -99,15 +99,15 @@ This section highlights and describes the use cases of each user.
\subsection{Use Case Descriptions}
\textbf{Use Case 1 View dictionary}
\\
When a user wants to view the dictionary they must first click the 'Dictionary \icon{dictionary-icon}' option from the main menu\footnote{This might not be necessary, as the startup page is the Dictionary page.}. The user is then presented with a view of all the word stored in the loaded dictionary file, English words on the left and their Welsh equivalent on the right. English verbs will have 'to' before the word, feminine Welsh nouns will have '\{f\}' after the word, and masculine Welsh nouns will have '\{m\}' after the word. The user will have the option to mark or unmark certain words for the practice list by clicking on a word. Words marked as practise words will be highlighted. A button marked as \icon{order-icon} gives the user the ability to change the ordering of the words (see use case 9). They also have the ability to search for words (see use case 2).
When a user wants to view the dictionary they must first click the 'Dictionary \icon{dictionary-icon}' option from the main menu\footnote{This might not be necessary, as the startup page is the Dictionary page.}. The user is then presented with a view of all the words stored in the loaded dictionary file, English words on the left and their Welsh equivalent on the right. English verbs will have 'to' before the word, feminine Welsh nouns will have '\{f\}' after the word, and masculine Welsh nouns will have '\{m\}' after the word. The user will have the option to mark or unmark certain words for the practice list by clicking on a word. Words marked as practise words will be highlighted. A button marked as \icon{order-icon} gives the user the ability to change the ordering of the words (see use case 9). They also have the ability to search for words (see use case 2).
\\\\
\textbf{Use Case 2 Search for a word}
\\
When a user wants to search for a word they must first navigate to either the 'Dictionary \icon{dictionary-icon}' (see use case 1) or 'Practise List \icon{practise-icon}' (see use case 3) pages. Then they should click the textbox next to the 'Search:' text. When the user types in the box it starts to filter words in the dictionary only displaying the words that begin with the string of characters written in the textbox. The words that match are based on which language ordering is currently selected. If it is ordered by English the string in the textbox will match the beginning of the English words, when switched to order by Welsh the search string will match the start of the Welsh words. If the word is not present then no results will appear for that search. All the searches are live or in other words refreshed per character typed in the search textbox.
When a user wants to search for a word they must first navigate to either the 'Dictionary \icon{dictionary-icon}' (see use case 1) or 'Practise List \icon{practise-icon}' (see use case 3) pages. Then they should click the text box next to the 'Search:' text. When the user types in the box it starts to filter words in the dictionary only displaying the words that begin with the string of characters written in the text box. The words that match are based on which language ordering is currently selected. If it is ordered by English the string in the text box will match the beginning of the English words, when switched to order by Welsh the search string will match the start of the Welsh words. If the word is not present then no results will appear for that search. All the searches are live or in other words refreshed per character typed in the search text box.
\\\\
\textbf{Use Case 3 View practise list}
\\
When a user wants to view the practise list they must first click on the 'Practise List \icon{practise-icon}' option from menu. The user is then presented with a view of all the words they have marked as practise words, English words on the left and their Welsh equivalent on the right. English verbs will have 'to' before the word, feminine Welsh nouns will have '\{f\}' after the word, and masculine Welsh nouns will have '\{m\}' after the word. The user will have the option to remove certain words from the practise list by clicking on a word. A button marked as \icon{order-icon} gives the user the ability to change the ordering of the words (see use case 9). They also have the ability to search for words (see use case 2).
When a user wants to view the practise list they must first click on the 'Practise List \icon{practise-icon}' option from the menu. The user is then presented with a view of all the words they have marked as practise words, English words on the left and their Welsh equivalent on the right. English verbs will have 'to' before the word, feminine Welsh nouns will have '\{f\}' after the word, and masculine Welsh nouns will have '\{m\}' after the word. The user will have the option to remove certain words from the practise list by clicking on a word. A button marked as \icon{order-icon} gives the user the ability to change the ordering of the words (see use case 9). They also have the ability to search for words (see use case 2).
\\\\
\textbf{Use Case 4 Modify the practise list}
\\
@ -119,7 +119,7 @@ When a user wants to start a test they must first click on the 'Study \icon{stud
\\\\
\textbf{Use Case 5.1 Start 'Match The Meaning' test}
\\
When a user wants to start a 'Match The Word' test they must first navigate to the 'Study \icon{study-icon}' page (see use case 5 on how to navigate there) and then click the 'Match The Meaning' box. The user is then presented with 8 words (4 pairs), half-English half-Welsh. It is the users job to match the correct translations by ordering the words so that the correct pairs are presented side by side. On the top right of the page it shows the user how many right and wrong answers they have in that specific test.
When a user wants to start a 'Match The Word' test they must first navigate to the 'Study \icon{study-icon}' page (see use case 5 on how to navigate there) and then click the 'Match The Meaning' box. The user is then presented with 8 words (4 pairs), half of which are in English and half of which are the Welsh counterparts. It is the user's job to match the correct translations by ordering the words so that the correct pairs are presented side by side. On the top right of the page it shows the user how many right and wrong answers they have in that specific test.
\\\\
\textbf{Use Case 5.2 Start '6 Meanings' test}
\\
@ -127,7 +127,7 @@ When a user wants to start a '6 Meanings' test they must first navigate to the '
\\\\
\textbf{Use Case 5.3 Start 'Translation ' test}
\\
When a user wants to start a 'Translation' test they must first navigate to the 'Study \icon{study-icon}' page (see use case 5 on how to navigate there) and then click the 'Translation' box. The user is then presented with a large word in either Welsh or English and a textbox in which they need to type in the translation. On the top right of the page it shows the user how many right and wrong answers they have in that specific test.
When a user wants to start a 'Translation' test they must first navigate to the 'Study \icon{study-icon}' page (see use case 5 on how to navigate there) and then click the 'Translation' box. The user is then presented with a large word in either Welsh or English and a text box in which they need to type in the translation. On the top right of the page it shows the user how many right and wrong answers they have in that specific test.
\\\\
\textbf{Use Case 6 View flashcards}
\\
@ -139,11 +139,11 @@ When a user wants to load in a new dictionary they must first click on the 'Load
\\\\
\textbf{Use Case 8 Add a new word}
\\
When a user wants to add a new word to the dictionary they must first click on the 'Add \icon{add-icon}' option from the menu. The user is then presented with a page with two text boxes, one for the English translation and one for the Welsh translation, a drop down box to specify the word type, and a 'Add Word' button. All fields must be filled before the user is allowed to click the 'Add Word' button. Once this button is clicked the word is added to the currently loaded dictionary and the practise list.
When a user wants to add a new word to the dictionary they must first click on the 'Add \icon{add-icon}' option from the menu. The user is then presented with a page with two text boxes, one for the English translation and one for the Welsh translation, a drop down box to specify the word type, and an 'Add Word' button. All fields must be filled before the user is allowed to click the 'Add Word' button. Once this button is clicked the word is added to the currently loaded dictionary and the practise list.
\\\\
\textbf{Use Case 9 Change word ordering}
\\
When a user wants to change the ordering of the word list from alphabetically English to alphabetically Welsh or vice versa they must first be in the 'Dictionary \icon{dictionary-icon}' (see use case 1 on how to navigate there) or 'Practise List \icon{practise-icon}' (see use case 3 on how to navigate there) page. The user is then presented with the \icon{order-icon} icon and the words sorted alphabetically in English (default). Once clicked the words will then be alphabetically sorted in Welsh. If the user wishes they may then switch the order back to English by pressing the \icon{order-icon} icon again.
When a user wants to change the ordering of the word list from English to Welsh or vice versa (both ordered alphabetically) they must first be in the 'Dictionary \icon{dictionary-icon}' (see use case 1 on how to navigate there) or 'Practise List \icon{practise-icon}' (see use case 3 on how to navigate there) page. The user is then presented with the \icon{order-icon} icon and the words ordered in English by default. Once clicked, the words will then be ordered in Welsh. If the user wishes, they may switch the order back to English by pressing the \icon{order-icon} icon again.
\\
\section{ERROR CONDITIONS}
@ -203,7 +203,7 @@ If the user hasn't defined the Welsh and English word for a new word, the progra
\end{itemize}
The error should state:
\begin{center}
\emph{'Warning: One or more word translation are not defined. Please fill all text boxes.'}
\emph{'Warning: One or more word translation(s) are not defined. Please fill all text boxes.'}
\end{center}
This should prompt the user to type in the Welsh and English equivalent words in their associated text boxes.
\subsection{Adding a word pair that already exists}

View file

@ -1 +1 @@
,noble,night.localdomain,21.02.2020 00:29,file:///home/noble/.config/libreoffice/4;
,noble,night.localdomain,23.02.2020 18:00,file:///home/noble/.config/libreoffice/4;

Binary file not shown.

After

Width:  |  Height:  |  Size: 156 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 159 KiB

After

Width:  |  Height:  |  Size: 156 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 182 KiB

After

Width:  |  Height:  |  Size: 179 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 159 KiB

After

Width:  |  Height:  |  Size: 156 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 155 KiB

After

Width:  |  Height:  |  Size: 161 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 55 KiB

After

Width:  |  Height:  |  Size: 76 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 60 KiB

After

Width:  |  Height:  |  Size: 67 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 76 KiB

After

Width:  |  Height:  |  Size: 77 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 84 KiB

After

Width:  |  Height:  |  Size: 85 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 69 KiB

After

Width:  |  Height:  |  Size: 70 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 998 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 1,011 B