Add the ardour manual converted to docbook format with only a few minor

additions.

Add dbhelper.vim key stroke mappings I use for working with docbook source.

There are no xsl or css files for customizing the html output so it will 
look really boring...this will only be temporary.

Support for content localization and generation of pdf's is planned.



git-svn-id: svn://localhost/ardour2/trunk@1405 d708f5d6-7413-0410-9779-e7cbd77b26cf

1 files changed, 305 insertions, 0 deletions

diff --git a/manual/xml/mouse_operations_object_mode.xml b/manual/xml/mouse_operations_object_mode.xml
new file mode 100644
index 0000000000..a013c9464c
--- /dev/null
+++ b/manual/xml/mouse_operations_object_mode.xml
@@ -0,0 +1,305 @@
+<?xml version="1.0" standalone="no"?>
+
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
+
+]>
+
+<section id="sn-mouse-operations-object-mode">
+	<title>Object Mode</title>
+	<section id="sn-object-mode-region-operations">
+		<title>Region Operations</title>
+		<para>
+			A region has several areas in its on-screen representation:
+		</para>
+
+		<itemizedlist>
+			<listitem>
+				<para>
+					the waveform (the majority of the region's display area, normally)
+				</para>
+			</listitem>
+			<listitem>
+				<para>
+					the trim bar (the colored bar below the waveform)
+				</para>
+			</listitem>
+			<listitem>
+				<para>
+					the name (in the trim bar, text)
+				</para>
+			</listitem>
+			<listitem>
+				<para>
+					the fade handles (small squares that default to the upper left + right
+					corners)
+				</para>
+			</listitem>
+			<listitem>
+				<para>
+					the fade shape (filled or empty curves representing fade in + fade out)
+				</para>
+			</listitem>
+			<listitem>
+				<para>
+					the gain envelope (hidden by default)
+				</para>
+			</listitem>
+		</itemizedlist>
+
+		<para>
+			Mouse operations on each area will do different things.
+		</para>
+
+		<table id="tbl-object-mode-region-operations">
+			<title>Region Operations</title>
+			<tgroup cols = "2">
+				<colspec colnum="1" colname="Mouse Action" colwidth="1"/>
+				<colspec colnum="2" colname="Result" colwidth= "2"/>
+				<thead>
+					<row>
+						<entry>
+							Mouse Action
+						</entry>
+						<entry>
+							Result
+						</entry>
+					</row>
+				</thead>
+				<tbody>
+					<row>
+						<entry>
+							Button1 click on waveform
+						</entry>
+						<entry>
+							select region
+						</entry>
+					</row>
+					<row>
+						<entry>
+							<keycombo><keycap>Shift</keycap>
+								<mousebutton>Button1</mousebutton>
+							</keycombo>
+							click
+						</entry>
+						<entry>
+							add region to selection, or deselect it if selected
+						</entry>
+					</row>
+					<row>
+						<entry>
+							<mousebutton>Button1</mousebutton>
+							drag on "empty space"
+						</entry>
+						<entry>
+							rubber-band selection of regions
+						</entry>
+					</row>
+					<row>
+						<entry>
+							<keycombo><keycap>Ctrl</keycap><keycap>Alt</keycap>
+								<mousebutton>Button1</mousebutton>
+							</keycombo>
+							drag on region
+						</entry>
+						<entry>
+							rubber-band selection of regions
+						</entry>
+					</row>
+					<row>
+						<entry>
+							<mousebutton>Button1</mousebutton>
+							click in trim bar
+						</entry>
+						<entry>
+							set start of region
+						</entry>
+					</row>
+					<row>
+						<entry>
+							<mousebutton>Button2</mousebutton>
+							click in trim bar
+						</entry>
+						<entry>
+							set end of region
+						</entry>
+					</row>
+					<row>
+						<entry>
+							<mousebutton>Button1</mousebutton>
+							drag near ends of trim bar
+						</entry>
+						<entry>
+							adjust start/end of region
+						</entry>
+					</row>
+					<row>
+						<entry>
+							<keycombo><keycap>Ctrl</keycap>
+								<mousebutton>Button1</mousebutton>
+							</keycombo>
+							drag in trim bar
+						</entry>
+						<entry>
+							move audio inside region
+						</entry>
+					</row>
+					<row>
+						<entry>
+							<mousebutton>Button1</mousebutton>
+							drag
+						</entry>
+						<entry>
+							move region
+						</entry>
+					</row>
+					<row>
+						<entry>
+							<keycombo><keycap>Ctrl</keycap>
+								<mousebutton>Button1</mousebutton>
+							</keycombo>
+							drag
+						</entry>
+						<entry>
+							copy region and move copy
+						</entry>
+					</row>
+					<row>
+						<entry>
+							<mousebutton>Button2</mousebutton>
+							drag
+						</entry>
+						<entry>
+							fixed time move (for transfer to other tracks)
+						</entry>
+					</row>
+					<row>
+						<entry>
+							<keycombo><keycap>Ctrl</keycap>
+								<mousebutton>Button2</mousebutton>
+							</keycombo>
+							drag
+						</entry>
+						<entry>
+							fixed time copy+move
+						</entry>
+					</row>
+					<row>
+						<entry>
+							<keycombo><keycap>Shift</keycap>
+								<mousebutton>Button2</mousebutton>
+							</keycombo>
+							click
+						</entry>
+						<entry>
+							raise region
+						</entry>
+					</row>
+					<row>
+						<entry>
+							<keycombo><keycap>Alt</keycap><keycap>Shift</keycap>
+								<mousebutton>Button2</mousebutton>
+							</keycombo>
+							click
+						</entry>
+						<entry>
+							lower region
+						</entry>
+					</row>
+				</tbody>
+			</tgroup>
+		</table>
+	</section>
+
+	<section id="object-mode-automation-operations">
+		<title>Automation Operations</title>
+		<para>
+			In general Button2-drag will do a constrained drag: control points will
+			stay at the same position in time if dragged up and down and they will stay
+			at the same value if dragged sideways.
+		</para>
+
+		<table id="tbl-object-mode-automation-operations">
+			<title>Region Operations</title>
+			<tgroup cols = "2">
+				<colspec colnum="1" colname="Mouse Action" colwidth="1"/>
+				<colspec colnum="2" colname="Result" colwidth= "2"/>
+				<thead>
+					<row>
+						<entry>
+							Mouse Action
+						</entry>
+						<entry>
+							Result
+						</entry>
+					</row>
+				</thead>
+				<tbody>
+					<row>
+						<entry>
+							<mousebutton>Button1</mousebutton> click in automation track
+						</entry>
+						<entry>
+							add a new control point to the line
+						</entry>
+					</row>
+					<row>
+						<entry>
+							<mousebutton>Button1</mousebutton> drag in an automation track
+						</entry>
+						<entry>
+							rubber-band select control points
+						</entry>
+					</row>
+					<row>
+						<entry>
+							<mousebutton>Button1</mousebutton> drag on control point
+						</entry>
+						<entry>
+							move control point
+						</entry>
+					</row>
+					<row>
+						<entry>
+							<mousebutton>Button1</mousebutton> drag on line
+						</entry>
+						<entry>
+							move line segment vertically
+						</entry>
+					</row>
+					<row>
+						<entry>
+							<mousebutton>Button2</mousebutton> drag on control-point
+						</entry>
+						<entry>
+							constrained adjustment
+						</entry>
+					</row>
+					<row>
+						<entry>
+							<keycombo><keycap>Ctrl</keycap><mousebutton>Button1</mousebutton></keycombo>
+							 drag on control point
+						</entry>
+						<entry>
+							move control point+all later points move with the same time
+							displacement
+						</entry>
+					</row>
+					<row>
+						<entry>
+							<keycombo><keycap>Ctrl</keycap><mousebutton>Button2</mousebutton></keycombo>
+							drag on control point
+						</entry>
+						<entry>
+							constrained move control point + move all later points with the same
+							time displacement
+						</entry>
+					</row>
+				</tbody>
+			</tgroup>
+		</table>
+	</section>
+<!--
+	<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" 
+		href="Some_Subsection.xml" />
+	-->
+</section>