From 37abbf405c4a0315591847056eee5608489c66de Mon Sep 17 00:00:00 2001 From: Jens Lammert Date: Wed, 11 Jul 2012 15:56:36 +0200 Subject: Documentation added --- doc/experiment-player.xml | 155 +++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 147 insertions(+), 8 deletions(-) (limited to 'doc') diff --git a/doc/experiment-player.xml b/doc/experiment-player.xml index bfe5ac1..6d4d52b 100644 --- a/doc/experiment-player.xml +++ b/doc/experiment-player.xml @@ -15,17 +15,156 @@ - The following document describes how to use the experiment player... - + The following document is an overview of various experiment-player features. + +
+ + https://github.com/rhaberkorn/experiment-player +
- - Introduction - + + Installation +
+ Linux + + To install the experiment-player on a Linux based operation system + the sources have to be downloaded from the + git-repository download page. + After that follow the instruction given by the INSTALL file. + +
+
+ Windows + + To install the experiment-player on a Windows operation system a ZIP-file + can be downloaded from the + git-repository download page. + It contains all nessessary binaries to run the experiment-player except + of the GTK+ widget toolkit. GTK+ 2.24.10 will also be needed to run the experiment-player on + Windows. The Installer and instructions can be downloaded from the GTK homepage. + After installing GTK unzip the ZIP-file in any directory and excecute + experiment-player.exe to run the experiment-player. + +
+ + + First Steps + + 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 20111117.xml and 20111117.mp4. + The last chosen directory will be saved as default value and will be + selelected automaticly the at the next start. + + + + Transcript + + 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. + +
+ Regular Expressions + + For more information how to use regular expressions have a look at + glib documentation for Perl compatible regular expression. + 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. + +
+
+ Format Expression + + 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 Pango Markup documentation.. + +
+
+ Format Files + + 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: + + + Each line will regarded as a single mark up statement. + + + + Leading whitespace characters will be ignored. + + + + A line beginning with '#' will be ignored complete. + + + + Only whole lines can be ignored. + + + + The format file has to save as a FMT-file (*.fmt). + + + + Incorrect lines will cause an error message. + + + + 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. + +
+ + + Config File - Bla Bla... - + 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 + glib documentation. + + The following table shows all additional keys : + + + + + + + + + + + + + + + + + + + + + + +
KeyDescription
Default-Format-FontFor detailed information follow pango font description
Default-Format-Text-ColorAn RGB color specification such as '#00FF00' or a color name such as 'red'
Default-Format-BG-ColorAn RGB color specification such as '#00FF00' or a color name such as 'red'
 - + -- cgit v1.2.3