nickjillings@1690: \documentclass{article}
nickjillings@1690: 
nickjillings@1690: \usepackage[margin=2cm]{geometry}
nickjillings@1690: \usepackage{listings}
nickjillings@1690: \usepackage{color}
nickjillings@1690: 
nickjillings@1690: \begin{document}
nickjillings@1690: 
nickjillings@1690: \large APE Browser Tool - Results Specification Document
nickjillings@1690: 
nickjillings@1690: \section{Introduction}
nickjillings@1690: This document outlines the return XML document structure to hold the results from the Browser Evaluation Tool, specifically for the APE Interface.
nickjillings@1690: 
nickjillings@1690: \section{Root}
nickjillings@1690: The root of the document is \texttt{BrowserEvaluationResult}. This takes no attributes but contains all children.
nickjillings@1690: 
nickjillings@1690: \section{Track}
nickjillings@1690: 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: 
nickjillings@1690: \subsection{Value}
nickjillings@1690: 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: 
nickjillings@1690: \subsection{Comment}
nickjillings@1690: One of these elements per track, containing any commenting data from the interface text boxes.
nickjillings@1690: 
nickjillings@1690: \section{Session Data}
nickjillings@1690: This will contain any captured session data. Currently not implemented but here for future referencing.
nickjillings@1690: 
nickjillings@1690: \section{Globals}
nickjillings@1690: Contains any comment boxes which were specified in the APE project specification with the comment ID, comment text and the comment results.
nickjillings@1690: 
nickjillings@1690: \end{document}