user docs: first few sections of "Getting Started" chapter

1 files changed, 110 insertions, 71 deletions

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 @@
 			<uri>
 				<link xlink:href="https://github.com/rhaberkorn/experiment-player">https://github.com/rhaberkorn/experiment-player</link>
 			</uri>
+		</address><address>
+			<uri>
+				<link xlink:href="http://sourceforge.net/projects/exp-player/">http://sourceforge.net/projects/exp-player/</link>
+			</uri>
 		</address>
 	</info>
 
@@ -130,86 +134,121 @@
 		</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>
+		<title>Getting Started</title>
 		<section>
-			<title>Regular Expressions</title>
+			<title>How to load a file with Quick Open</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.
+				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
+				<emphasis>Quick Open</emphasis> feature.
 			</para>
-		</section>
-		<section>
-			<title>Format Expression</title>
+			<screenshot>
+				<mediaobject>
+					<imageobject>
+						<imagedata fileref="images/quick-open-empty.png"/>
+					</imageobject>
+					<caption>Empty Quick Open menu</caption>
+				</mediaobject>
+			</screenshot>
+			<para>
+				<emphasis>Quick Open</emphasis> can be performed using the
+				<guimenu>Quick Open</guimenu> menu.
+				The menu has items for all experiments found in a selected
+				directory.
+				The directory may be selected using the <guimenuitem>Choose Directory...</guimenuitem>
+				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 <filename>20101117.xml</filename> and
+				<filename>20101117.mp4</filename>, the menu will look like:
+			</para>
+			<screenshot>
+				<mediaobject>
+					<imageobject>
+						<imagedata fileref="images/quick-open.png"/>
+					</imageobject>
+				</mediaobject>
+			</screenshot>
 			<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>.
+				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 <emphasis>Quick Open</emphasis> directory
+				persists after application restarts.
 			</para>
 		</section>
 		<section>
-			<title>Format Files</title>
+			<title>Transcript Highlighting</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.
+				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>
 		</section>
 	</chapter>
 	<chapter>