
nicholas@9: \documentclass{article}
nicholas@9: 
nicholas@9: \usepackage[margin=2cm]{geometry}
nicholas@9: \usepackage{listings}
nicholas@9: \usepackage{color}
nicholas@9: 
nicholas@9: \begin{document}
nicholas@9: 
nicholas@9: \large APE Browser Tool - Results Specification Document
nicholas@9: 
nicholas@9: \section{Introduction}
nicholas@9: This document outlines the return XML document structure to hold the results from the Browser Evaluation Tool, specifically for the APE Interface.
nicholas@9: 
nicholas@9: \section{Root}
nicholas@9: The root of the document is \texttt{BrowserEvaluationResult}. This takes no attributes but contains all children.
nicholas@9: 
nicholas@9: \section{Track}
nicholas@9: 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.
nicholas@9: 
nicholas@9: \subsection{Value}
nicholas@9: 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.
b@17: % float or int? (I, Brecht, am sort of indifferent here, it used to be down to .01 or something before, so maybe that or .1)
nicholas@9: 
nicholas@9: \subsection{Comment}
nicholas@9: One of these elements per track, containing any commenting data from the interface text boxes.
nicholas@9: 
nicholas@9: \section{Session Data}
nicholas@9: This will contain any captured session data. Currently not implemented but here for future referencing.
b@17: % I used to have a 'global' comment for each 'session' as well
nicholas@9: 
nicholas@9: \section{Globals}
nicholas@9: Contains any comment boxes which were specified in the APE project specification with the comment ID, comment text and the comment results.
nicholas@9: 
nicholas@9: \end{document}




