blob: b24a6947c6ebde63f83cc508708356c2bfcda5a8 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
|
<?xml version="1.0"?>
<book xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
<info>
<title>Experiment Player</title>
<subtitle>A tool to analyze audiovisual experiment recordings and transcripts</subtitle>
<author>
<personname><firstname>Jens</firstname> <surname>Lammert</surname></personname>
<email>jens.lammert@st.ovgu.de</email>
</author>
<copyright>
<year>2012</year>
<year>2013</year>
<holder>Otto-von-Guericke Universität Magdeburg</holder>
</copyright>
<abstract><para>
The following document illustrates how to install, configure
and use the Experiment Player to analyze experiments.
</para></abstract>
<address>
<uri>
<link xlink:href="https://github.com/rhaberkorn/experiment-player">https://github.com/rhaberkorn/experiment-player</link>
</uri>
</address>
</info>
<chapter>
<title>Installation</title>
<section>
<title>Windows</title>
<para>
To install the <productname>Experiment Player</productname> on a Windows-based operating system,
the GTK+ 2 widget toolkit must first be downloaded and installed.
A convenient GTK+ installer can be downloaded from the
<link xlink:href="http://gtk-win.sourceforge.net/home/index.php/Main/Downloads">
"GTK+ for Windows Runtime Environment Installer" project page</link>.
It is only necessary to install the
<link xlink:href="http://downloads.sourceforge.net/gtk-win/gtk2-runtime-2.24.10-2012-10-10-ash.exe?download">
GTK+ runtime</link>.
<link xlink:href="http://downloads.sourceforge.net/gtk-win/gtk2-themes-2009-09-07-ash.exe?download">
Additional themes</link> may be installed as well - but the default GTK+ theme should be sufficient.
</para><para>
Precompiled Windows 32-bit binaries of the <productname>Experiment Player</productname> itself
are available as ZIP archives from the
<link xlink:href="http://sourceforge.net/projects/exp-player/files/bin/">Sourceforge project page</link>.
The ZIP archive merely has to be extracted somewhere.
Afterwards the included <filename>experiment-player.exe</filename> can be executed.
All library dependencies except GTK+ are included in the ZIP archive.
</para>
</section>
<section>
<title>Linux</title>
<para>
To install the <productname>Experiment Player</productname> on a Linux-based operating system,
it first has to be built from source.
It can either be built from a local
<link xlink:href="https://github.com/rhaberkorn/experiment-player">Git repository</link> clone,
or from a source code package that can be downloaded from the
<link xlink:href="http://sourceforge.net/projects/exp-player/files/src/">project's download archive
on Sourceforge</link>.
In either case, further build instructions are given in the included
<filename>INSTALL</filename> file.
</para>
</section>
</chapter>
<chapter>
<title>First Steps</title>
<para>
After starting the experiment-player video-files and transcripts can be
loaded. To open files first choose a directory in menue QuickOpen entry
Choose directory. Select any directory that contains the desired data.
If there are a XML-file and an AVI or MP4-file with an identical name the
data will bei listed under QuickOpen. For example <filename>20111117.xml</filename> and <filename>20111117.mp4</filename>.
The last chosen directory will be saved as default value and will be
selelected automaticly the at the next start.
</para>
</chapter>
<chapter>
<title>Transcript</title>
<para>
If the transcript is opened and a files was selected the transcript widget
shows the dialog between proband and wizard. The dialog monitor is divided
up into two seperate widgets so there can be different settings and fonts
at each widget. Also it is possible to markup matches separate from each other.
There two way to search matches: regular expressions and format files.
</para>
<section>
<title>Regular Expressions</title>
<para>
For more information how to use regular expressions have a look at
<link xlink:href="http://developer.gnome.org/glib/stable/glib-Perl-compatible-regular-expressions.html">glib documentation for Perl compatible regular expression</link>.
Regular expressions are case-insensitive so both lower-case and upper-case character
will match the same expression. Regular expression matches will be formated bold by default.
Captures are not be supported.
</para>
</section>
<section>
<title>Format Expression</title>
<para>
By default a search term will be regarded as regular expression. If the
markup toggle is activated the input expression will be regarded as
format expression which is a combination of regular expression and Pango mark up.
That means if the regular expression matchs at the text the markup
expressions will apply.
For more information refer to the <link xlink:href="http://developer.gnome.org/pango/stable/PangoMarkupFormat.html">Pango Markup documentation.</link>.
</para>
</section>
<section>
<title>Format Files</title>
<para>
Format files are collection of multiple format expressions. At first there
has to be selected a quick open directory in menue Format entry Choose Directory.
After that all available format files in the selected directory will be listed
under menue Formats. To create an own format file care the following:
<itemizedlist mark='bullet'>
<listitem>
<para>Each line will regarded as a single mark up statement.
</para>
</listitem>
<listitem>
<para>Leading whitespace characters will be ignored.
</para>
</listitem>
<listitem>
<para>A line beginning with '<filename>#</filename>' will be ignored complete.
</para>
</listitem>
<listitem>
<para>Only whole lines can be ignored.
</para>
</listitem>
<listitem>
<para>The format file has to save as a FMT-file (<filename>*.fmt</filename>).
</para>
</listitem>
<listitem>
<para>Incorrect lines will cause an error message.
</para>
</listitem>
</itemizedlist>
Let be the whole text referring to a single time stamp a text fragment.
For each text fragment each format expression in the format file will be
iterated and the associated regular expression will matched.
For each match all associated mark ups will apply cumulatively at the
matching text.
</para>
</section>
</chapter>
<chapter>
<title>Config File</title>
<para>
The config file is located in the users default directory where each config
files are. By editing the config-file default keys which can not changed via
gui can set. More details about the structure of the config file can be
found in the
<link xlink:href="developer.gnome.org/glib/unstable/glib-Key-value-file-parser.html">glib documentation</link>.
The following table shows all additional keys :
<table border="1">
<thead border="1">
<tr>
<td>Key</td>
<td>Description</td>
</tr>
</thead>
<tbody border="1">
<tr>
<td><filename>Default-Format-Font</filename></td>
<td>For detailed information follow <link xlink:href="http://developer.gnome.org/pango/stable/pango-Fonts.html#pango-font-description-from-string">pango font description</link></td>
</tr>
<tr>
<td><filename>Default-Format-Text-Color</filename></td>
<td>An RGB color specification such as '#00FF00' or a color name such as 'red'</td>
</tr>
<tr>
<td><filename>Default-Format-BG-Color</filename></td>
<td>An RGB color specification such as '#00FF00' or a color name such as 'red'</td>
</tr>
</tbody>
</table>
</para>
</chapter>
</book>
|
