Mercurial > hg > webaudioevaluationtool
view docs/ResultsSpecificationDocument.tex @ 693:a74cb47e779c
Creation of experimental variables and control methods document
author | Dave Moffat <djmoffat@users.noreply.github.com> |
---|---|
date | Thu, 09 Apr 2015 12:59:46 +0100 |
parents | |
children | 18699932c396 9fb67a4ed709 869ed636f7c0 |
line wrap: on
line source
\documentclass{article} \usepackage[margin=2cm]{geometry} \usepackage{listings} \usepackage{color} \begin{document} \large APE Browser Tool - Results Specification Document \section{Introduction} This document outlines the return XML document structure to hold the results from the Browser Evaluation Tool, specifically for the APE Interface. \section{Root} The root of the document is \texttt{BrowserEvaluationResult}. This takes no attributes but contains all children. \section{Track} 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. \subsection{Value} 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. \subsection{Comment} One of these elements per track, containing any commenting data from the interface text boxes. \section{Session Data} This will contain any captured session data. Currently not implemented but here for future referencing. \section{Globals} Contains any comment boxes which were specified in the APE project specification with the comment ID, comment text and the comment results. \end{document}