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, 473 insertions, 0 deletions

diff --git a/manual/xml/frontier_design_tranzport.xml b/manual/xml/frontier_design_tranzport.xml
new file mode 100644
index 0000000000..a4d1036bd9
--- /dev/null
+++ b/manual/xml/frontier_design_tranzport.xml
@@ -0,0 +1,473 @@
+<?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-frontier-design-tranzport">
+	<title>Using a Frontier Design Tranzport</title>
+	<section id="tranzport-configuration">
+		<title>Enabling a Tranzport</title>
+		<para>
+			Ardour 2.0 can currently use a single Tranzport controller. Ensure that the
+			device is plugged into a functional USB port. On Linux you will need to
+			<link linkend="sn-configuring-usb-device-access">take steps</link>
+			to ensure that non-administrative users can access the device. Note that
+			this feature is <emphasis>not</emphasis> available in Ardour 0.99.x.
+		</para>
+
+		<para>
+			In the Options menu, navigate into the Control Surfaces submenu. Click on
+			the "Tranzport" option to enable use of the control surface within Ardour.
+			To disable it, click on this item a second time.
+		</para>
+	</section>
+
+	<section id="tranzport-buttons-and-wheel-functions">
+		<title>Tranzport Buttons and Datawheel functions</title>
+		<table id="tbl-tranzport-functions">
+			<title>Tranzport Functions</title>
+			<tgroup cols = "3">
+				<colspec colnum="1" colname = "Key Binding" colwidth = "1"/>
+				<colspec colnum="2" colname="Action" colwidth= "2"/>
+				<thead>
+					<row>
+						<entry>
+							Key
+						</entry>
+						<entry>
+							Normal Click
+						</entry>
+						<entry>
+							Shift Click
+						</entry>
+					</row>
+				</thead>
+				<tbody>
+					<row>
+						<entry>
+							<para>
+								REW
+							</para>
+						</entry>
+						<entry>
+							<para>
+								Rewind
+							</para>
+						</entry>
+						<entry>
+							<para>
+								Go to start
+							</para>
+						</entry>
+					</row>
+					<row>
+						<entry>
+							<para>
+								FFWD
+							</para>
+						</entry>
+						<entry>
+							<para>
+								Fast forward
+							</para>
+						</entry>
+						<entry>
+							<para>
+								Go to end
+							</para>
+						</entry>
+					</row>
+					<row>
+						<entry>
+							<para>
+								STOP
+							</para>
+						</entry>
+						<entry>
+							<para>
+								Stop
+							</para>
+						</entry>
+						<entry>
+							<para>
+								Enter *
+							</para>
+						</entry>
+					</row>
+					<row>
+						<entry>
+							<para>
+								PLAY
+							</para>
+						</entry>
+						<entry>
+							<para>
+								Play
+							</para>
+						</entry>
+						<entry>
+							<para>
+								Save
+							</para>
+						</entry>
+					</row>
+					<row>
+						<entry>
+							<para>
+								RECORD
+							</para>
+						</entry>
+						<entry>
+							<para>
+								Record
+							</para>
+						</entry>
+						<entry>
+							<para></para>
+						</entry>
+					</row>
+					<row>
+						<entry></entry>
+						<entry></entry>
+						<entry></entry>
+					</row>
+					<row>
+						<entry>
+							<para>
+								PREV
+							</para>
+						</entry>
+						<entry>
+							<para>
+								Go to previous marker
+							</para>
+						</entry>
+						<entry>
+							<para>
+								Zoom full
+							</para>
+						</entry>
+					</row>
+					<row>
+						<entry>
+							<para>
+								ADD
+							</para>
+						</entry>
+						<entry>
+							<para>
+								Add marker at current location
+							</para>
+						</entry>
+						<entry>
+							<para></para>
+						</entry>
+					</row>
+					<row>
+						<entry>
+							<para>
+								NEXT
+							</para>
+						</entry>
+						<entry>
+							<para>
+								Go to next marker
+							</para>
+						</entry>
+						<entry>
+							<para>
+								Select normal, scrub or shuttle mode
+							</para>
+						</entry>
+					</row>
+					<row>
+						<entry></entry>
+						<entry></entry>
+						<entry></entry>
+					</row>
+					<row>
+						<entry>
+							<para>
+								IN
+							</para>
+						</entry>
+						<entry>
+							<para></para>
+						</entry>
+						<entry>
+							<para>
+								Zoom In
+							</para>
+						</entry>
+					</row>
+					<row>
+						<entry>
+							<para>
+								OUT
+							</para>
+						</entry>
+						<entry>
+							<para></para>
+						</entry>
+						<entry>
+							<para>
+								Zoom Out
+							</para>
+						</entry>
+					</row>
+					<row>
+						<entry>
+							<para>
+								PUNCH
+							</para>
+						</entry>
+						<entry>
+							<para></para>
+						</entry>
+						<entry>
+							<para></para>
+						</entry>
+					</row>
+					<row>
+						<entry>
+							<para>
+								LOOP
+							</para>
+						</entry>
+						<entry>
+							<para></para>
+						</entry>
+						<entry>
+							<para>
+								Select gain/pan/master level mode
+							</para>
+						</entry>
+					</row>
+					<row>
+						<entry></entry>
+						<entry></entry>
+						<entry></entry>
+					</row>
+					<row>
+						<entry>
+							<para>
+								&lt; TRACK
+							</para>
+						</entry>
+						<entry>
+							<para>
+								Previous track
+							</para>
+						</entry>
+						<entry>
+							<para></para>
+						</entry>
+					</row>
+					<row>
+						<entry>
+							<para>
+								TRACK &gt;
+							</para>
+						</entry>
+						<entry>
+							<para>
+								Next track
+							</para>
+						</entry>
+						<entry>
+							<para></para>
+						</entry>
+					</row>
+					<row>
+						<entry>
+							<para>
+								REC
+							</para>
+						</entry>
+						<entry>
+							<para>
+								Toggle track's record enable on/off
+							</para>
+						</entry>
+						<entry>
+							<para>
+								Clear all track record arming
+							</para>
+						</entry>
+					</row>
+					<row>
+						<entry>
+							<para>
+								MUTE
+							</para>
+						</entry>
+						<entry>
+							<para>
+								Toggle track's mute status on/off
+							</para>
+						</entry>
+						<entry>
+							<para>
+								Clear all mutes
+							</para>
+						</entry>
+					</row>
+					<row>
+						<entry>
+							<para>
+								SOLO
+							</para>
+						</entry>
+						<entry>
+							<para>
+								Toggle track's solo status on/off
+							</para>
+						</entry>
+						<entry>
+							<para>
+								Clear all solos
+							</para>
+						</entry>
+					</row>
+					<row>
+						<entry>
+							<para>
+								UNDO
+							</para>
+						</entry>
+						<entry>
+							<para>
+								Undo
+							</para>
+						</entry>
+						<entry>
+							<para>
+								Redo
+							</para>
+						</entry>
+					</row>
+					<row>
+						<entry></entry>
+						<entry></entry>
+						<entry></entry>
+					</row>
+					<row>
+						<entry>
+							<para>
+								DATA WHEEL
+							</para>
+						</entry>
+						<entry>
+							<para>
+								scroll timeline, scrub or shuttle
+							</para>
+						</entry>
+						<entry>
+							<para>
+								adjust track gain, track pan or master gain
+							</para>
+						</entry>
+					</row>
+					<row>
+						<entry></entry>
+						<entry></entry>
+						<entry></entry>
+					</row>
+					<row>
+						<entry>
+							<para>
+								FOOTSWITCH
+							</para>
+						</entry>
+						<entry>
+							<para></para>
+						</entry>
+						<entry>
+							<para></para>
+						</entry>
+					</row>
+				</tbody>
+			</tgroup>
+		</table>
+	</section>
+
+	<section id="tranzport-normal-scrub-shuttle-modes">
+		<title>Normal, Scrub and Shuttle Modes</title>
+		<para>
+			In Ardour, the Tranzport in has 3 different modes of operation termed
+			"timeline", "scrub" and "shuttle".
+		</para>
+
+		<variablelist>
+			<title>Tranzport Modes of Operation</title>
+			<varlistentry>
+				<term>Timeline</term>
+				<listitem>
+					<para>
+						the data wheel scrolls the timeline in the editor window back and forth.
+					</para>
+				</listitem>
+			</varlistentry>
+
+			<varlistentry>
+				<term>Scrub</term>
+				<listitem>
+					<para>
+						the data wheel is used to scrub audio data back and forth.
+					</para>
+				</listitem>
+			</varlistentry>
+
+			<varlistentry>
+				<term>Shuttle</term>
+				<listitem>
+					<para>
+						the data wheel is used to control varispeed playback. Turning the data
+						wheel clockwise increases the playback speed in a forward direction.
+						Counter-clockwise decreases the speed and will reverse playback. Shuttle
+						mode as several important features:
+						<itemizedlist>
+							<listitem>
+								<para>
+									While in Shuttle mode the actual playback speed will be displayed in
+									the top right corner of the LCD as a percentage of real-time, ie.
+									+100% is normal playback speed.
+								</para>
+							</listitem>
+							<listitem>
+								<para>
+									Press STOP to automatically set the Shuttle speed to 0%.
+								</para>
+							</listitem>
+							<listitem>
+								<para>
+									Press PLAY to automatically set the Shuttle speed to +100%.
+								</para>
+							</listitem>
+							<listitem>
+								<para>
+									Press and hold SHIFT to momentarily toggle the TranzPort into Scrub
+									mode. Releasing the SHIFT button will return to Shuttle mode at 0%
+									speed. This combination of functions is very useful for quickly
+									moving through an audio track and accurately locating points hit
+									points.
+								</para>
+							</listitem>
+							<listitem>
+								<para>
+									Pressing ADD will drop a marker at the current location and exit
+									Shuttle mode
+								</para>
+							</listitem>
+						</itemizedlist>
+					</para>
+				</listitem>
+			</varlistentry>
+		</variablelist>
+	</section>
+<!--
+	<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" 
+		href="Some_Subsection.xml" />
+	-->
+</section>