comparison docs/ResultsSpecificationDocument.tex @ 53:8baa6b5cb4be Dev_main

Updated documentation to reflect minor syntax changes
author Nicholas Jillings <n.g.r.jillings@se14.qmul.ac.uk>
date Mon, 13 Apr 2015 11:46:21 +0100
parents 3653190a0926
children
comparison
equal deleted inserted replaced
52:584302307987 53:8baa6b5cb4be
32 \item \texttt{id} - Mandatory. This returns the ID of the track in question. This is either the value passed in from the project specification, or calculated based on the position in the list. For instance, in the automatic system, the first test sample has ID 0, the second ID 1 and so forth. The value passed in from the project specification can either be a string or a Number. 32 \item \texttt{id} - Mandatory. This returns the ID of the track in question. This is either the value passed in from the project specification, or calculated based on the position in the list. For instance, in the automatic system, the first test sample has ID 0, the second ID 1 and so forth. The value passed in from the project specification can either be a string or a Number.
33 \item \texttt{url} - Mandatory. Returns the full URL given incase of errors or for later checking. 33 \item \texttt{url} - Mandatory. Returns the full URL given incase of errors or for later checking.
34 \end{itemize} 34 \end{itemize}
35 35
36 \subsubsection{Value} 36 \subsubsection{Value}
37 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. 37 One of these elements per track, containing the floating value between 0 and 1 relating the user rating of the track. This is a mandatory element.
38 % 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)
39 % Nick - Can be a float, was trying to remove/reduce ambiguity from pixel position. But can easily make it to .01
40 38
41 \subsubsection{Comment} 39 \subsubsection{Comment}
42 One of these elements per track, containing any commenting data from the interface text boxes. Has the two following child nodes. 40 One of these elements per track, containing any commenting data from the interface text boxes. Has the two following child nodes.
43 \begin{itemize} 41 \begin{itemize}
44 \item \texttt{Question} - Returns the text next to the comment box 42 \item \texttt{Question} - Returns the text next to the comment box
62 60
63 \section{Session Data} 61 \section{Session Data}
64 This will contain any captured session data. Currently not implemented but here for future referencing. 62 This will contain any captured session data. Currently not implemented but here for future referencing.
65 % I used to have a 'global' comment for each 'session' as well 63 % I used to have a 'global' comment for each 'session' as well
66 64
67 \section{Globals}
68 Contains any comment boxes which were specified in the APE project specification with the comment ID, comment text and the comment results.
69
70 \end{document} 65 \end{document}