Mercurial > hg > webaudioevaluationtool
annotate docs/ResultsSpecificationDocument.tex @ 1690:1e88d042624f
Added specification documents. Need formalising and updating!
| author | Nicholas Jillings <nickjillings@users.noreply.github.com> |
|---|---|
| date | Wed, 25 Mar 2015 13:11:58 +0000 |
| parents | |
| children | 18699932c396 9fb67a4ed709 869ed636f7c0 |
| rev | line source |
|---|---|
| nickjillings@1690 | 1 \documentclass{article} |
| nickjillings@1690 | 2 |
| nickjillings@1690 | 3 \usepackage[margin=2cm]{geometry} |
| nickjillings@1690 | 4 \usepackage{listings} |
| nickjillings@1690 | 5 \usepackage{color} |
| nickjillings@1690 | 6 |
| nickjillings@1690 | 7 \begin{document} |
| nickjillings@1690 | 8 |
| nickjillings@1690 | 9 \large APE Browser Tool - Results Specification Document |
| nickjillings@1690 | 10 |
| nickjillings@1690 | 11 \section{Introduction} |
| nickjillings@1690 | 12 This document outlines the return XML document structure to hold the results from the Browser Evaluation Tool, specifically for the APE Interface. |
| nickjillings@1690 | 13 |
| nickjillings@1690 | 14 \section{Root} |
| nickjillings@1690 | 15 The root of the document is \texttt{BrowserEvaluationResult}. This takes no attributes but contains all children. |
| nickjillings@1690 | 16 |
| nickjillings@1690 | 17 \section{Track} |
| nickjillings@1690 | 18 The first child element is the \texttt{Track} element. This contains the results for a specific track. This requires the attribute \texttt{trackId} to be set to the numerical track Id. |
| nickjillings@1690 | 19 |
| nickjillings@1690 | 20 \subsection{Value} |
| nickjillings@1690 | 21 One of these elements per track, containing the value between 0 and 100 relating the user rating of the track. This is a mandatory element. |
| nickjillings@1690 | 22 |
| nickjillings@1690 | 23 \subsection{Comment} |
| nickjillings@1690 | 24 One of these elements per track, containing any commenting data from the interface text boxes. |
| nickjillings@1690 | 25 |
| nickjillings@1690 | 26 \section{Session Data} |
| nickjillings@1690 | 27 This will contain any captured session data. Currently not implemented but here for future referencing. |
| nickjillings@1690 | 28 |
| nickjillings@1690 | 29 \section{Globals} |
| nickjillings@1690 | 30 Contains any comment boxes which were specified in the APE project specification with the comment ID, comment text and the comment results. |
| nickjillings@1690 | 31 |
| nickjillings@1690 | 32 \end{document} |