From 6a75f1c997feab5719801bd440ef3a9843ce62b8 Mon Sep 17 00:00:00 2001 From: Jens Lammert Date: Sun, 9 Jun 2013 23:56:52 +0200 Subject: user docs: first few sections of "Getting Started" chapter --- doc/experiment-player.xml | 181 ++++++++++++++++++++++++++++------------------ 1 file changed, 110 insertions(+), 71 deletions(-) (limited to 'doc') diff --git a/doc/experiment-player.xml b/doc/experiment-player.xml index e8dec89..8d2f3a8 100644 --- a/doc/experiment-player.xml +++ b/doc/experiment-player.xml @@ -25,6 +25,10 @@ https://github.com/rhaberkorn/experiment-player +
+ + http://sourceforge.net/projects/exp-player/ +
@@ -130,86 +134,121 @@ - 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. - + Getting Started
- Regular Expressions + How to load a file with Quick Open - 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. + A video recording of an experiment and its related transcript file + are considered as an experiment. A video is an AVI or MP4 file + while transcript files are special XML applications. + The experiment's files can be opened separately or by using the + Quick Open feature. -
-
- Format Expression + + + + + + Empty Quick Open menu + + + + Quick Open can be performed using the + Quick Open menu. + The menu has items for all experiments found in a selected + directory. + The directory may be selected using the Choose Directory... + menu item. + Experiment files with identical basenames (file name without extension) are + listed as single menu items. + For instance, if the directory contains two files 20101117.xml and + 20101117.mp4, the menu will look like: + + + + + + + + - 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.. + When an experiment item is activated in the menu, the + corresponding experiment files are loaded (replacing any + already opened experiment). + The configured location of the Quick Open directory + persists after application restarts.
- Format Files + Transcript Highlighting - 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. + 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. + +
-- cgit v1.2.3