aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJens Lammert <jens.lammert@st.ovgu.de>2013-06-09 22:22:52 +0200
committerRobin Haberkorn <robin.haberkorn@googlemail.com>2013-06-09 22:22:52 +0200
commit17111385c513a3dbdc3fec336e8dfa3708ae0063 (patch)
treec2cf3b71ba18fdf9a8627442d331d830be5f6cb2 /doc
parent9162c1900f642154321fe31a7c4f4be4c1f0770e (diff)
downloadgtk-vlc-player-17111385c513a3dbdc3fec336e8dfa3708ae0063.tar.gz
user documentation: written chapter explaining the GUI
Diffstat (limited to 'doc')
-rw-r--r--doc/experiment-player.xml62
1 files changed, 62 insertions, 0 deletions
diff --git a/doc/experiment-player.xml b/doc/experiment-player.xml
index b24a694..e8dec89 100644
--- a/doc/experiment-player.xml
+++ b/doc/experiment-player.xml
@@ -68,6 +68,68 @@
</section>
</chapter>
<chapter>
+ <title>Graphical User Interface</title>
+ <para>
+ After startup there will be two windows, a <emphasis>player</emphasis>
+ window and a <emphasis>data</emphasis> window.
+ They are explained in the following sections.
+ </para>
+ <section>
+ <title>Player Window</title>
+ <screenshot>
+ <!-- <title>Player Window after startup</title> -->
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/player-window-new.png"/>
+ </imageobject>
+ <caption>Player Window after startup</caption>
+ </mediaobject>
+ </screenshot>
+ <para>
+ The image above depicts the player window after startup.
+ No experiment is yet opened in the application, so several
+ controls are greyed out.
+ </para><para>
+ Experiments can be opened via the <guimenu>File</guimenu> menu
+ or the <guimenu>Quick Open</guimenu> menu.
+ The process of opening experiments via the <guimenu>Quick Open</guimenu> menu
+ is explained later on.
+ The remaining interface components are self-explanatory.
+ </para>
+ </section>
+ <section>
+ <title>Data Window</title>
+ <screenshot>
+ <!-- <title>Data Window after startup</title> -->
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/data-window-new.png"/>
+ </imageobject>
+ <caption>Data Window after startup</caption>
+ </mediaobject>
+ </screenshot>
+ <para>
+ The image above depicts the data window after startup.
+ The data window is used to display additional information of an
+ experiment.
+ This information is time-dependant and synchronized with other
+ time-dependant data, like the current video position.
+ If the time is changed in one component, it changes in all the
+ other ones as well.
+ </para><para>
+ The current implementation is able to display an experiment
+ transcript (in the Transcript view area).
+ The transcript view is divided up into a left part showing the
+ proband's text contributions and a right part showing the
+ wizard's text contributions.
+ The different experiment phases are displayed hierachically
+ in the Transcript navigation area.
+ Transcripts can also be highlighted but this feature is
+ explained later on.
+ </para>
+ </section>
+ </chapter>
+ <chapter>
<title>First Steps</title>
<para>
After starting the experiment-player video-files and transcripts can be