[pitivi: 35/41] Initial commit for the Mallard-formatted user manual covering pitivi 0.13.4
- From: Thibault Saunier <tsaunier src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [pitivi: 35/41] Initial commit for the Mallard-formatted user manual covering pitivi 0.13.4
- Date: Sat, 13 Aug 2011 12:09:10 +0000 (UTC)
commit ed4915e2c2e1ca5c5fc5a848b2265048becce10b
Author: Jean-FranÃois Fortin Tam <nekohayo gmail com>
Date: Mon Jan 17 12:14:26 2011 -0500
Initial commit for the Mallard-formatted user manual covering pitivi 0.13.4
help/C/about.page | 38 +++++++++++
help/C/crossfading.page | 34 ++++++++++
help/C/effects.page | 47 ++++++++++++++
help/C/effectsanimation.page | 22 +++++++
help/C/fadeinfadeout.page | 47 ++++++++++++++
help/C/figures/fadestep1.png | Bin 0 -> 488 bytes
help/C/figures/fadestep2.png | Bin 0 -> 557 bytes
help/C/figures/fadestep3.png | Bin 0 -> 2330 bytes
help/C/figures/filechooser.png | Bin 0 -> 104156 bytes
help/C/figures/hovering.png | Bin 0 -> 10081 bytes
help/C/figures/keyframecurves.png | Bin 0 -> 13323 bytes
help/C/figures/layers.png | Bin 0 -> 29932 bytes
help/C/figures/logo.png | Bin 0 -> 8968 bytes
help/C/figures/mainwindow.png | Bin 0 -> 226610 bytes
help/C/figures/previewsource.png | Bin 0 -> 15143 bytes
help/C/figures/ripple-after.png | Bin 0 -> 15855 bytes
help/C/figures/ripple-before.png | Bin 0 -> 16943 bytes
help/C/figures/roll-after.png | Bin 0 -> 21175 bytes
help/C/figures/roll-before.png | Bin 0 -> 16944 bytes
help/C/figures/ruler.png | Bin 0 -> 1669 bytes
help/C/figures/trimming-individual.png | Bin 0 -> 127958 bytes
help/C/gstreamer.page | 59 ++++++++++++++++++
help/C/importing.page | 75 ++++++++++++++++++++++
help/C/importingmpegts.page | 27 ++++++++
help/C/index.page | 56 +++++++++++++++++
help/C/insertintimeline.page | 37 +++++++++++
help/C/interface.page | 21 ++++++
help/C/keyframecurves.page | 53 ++++++++++++++++
help/C/layers.page | 59 ++++++++++++++++++
help/C/license.page | 50 +++++++++++++++
help/C/mainwindow.page | 106 ++++++++++++++++++++++++++++++++
help/C/makeselections.page | 49 +++++++++++++++
help/C/medialibrary.page | 52 ++++++++++++++++
help/C/movearoundtimeline.page | 68 ++++++++++++++++++++
help/C/othertransitions.page | 27 ++++++++
help/C/projectsettings.page | 56 +++++++++++++++++
help/C/rendering.page | 37 +++++++++++
help/C/saveproject.page | 32 ++++++++++
help/C/splitting.page | 53 ++++++++++++++++
help/C/sysreq.page | 32 ++++++++++
help/C/trimming.page | 87 ++++++++++++++++++++++++++
help/C/usingclips.page | 53 ++++++++++++++++
42 files changed, 1277 insertions(+), 0 deletions(-)
---
diff --git a/help/C/about.page b/help/C/about.page
new file mode 100644
index 0000000..dc68da4
--- /dev/null
+++ b/help/C/about.page
@@ -0,0 +1,38 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ xmlns:e="http://projectmallard.org/experimental/";
+ type="topic"
+ id="about">
+
+ <info>
+ <link type="seealso" xref="index"/>
+ <revision pkgversion="0.14" version="0.2" date="2011-06-05" status="complete"/>
+ <credit type="author">
+ <name>Jean-FranÃois Fortin Tam</name>
+ <email>nekohayo gmail com</email>
+ </credit>
+ <credit type="contributor">
+ <name>Mario BlÃttermann</name>
+ <email>mariobl gnome org</email>
+ </credit>
+ <desc>
+ Current state of this user manual and call for participation.
+ </desc>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>About this manual</title>
+ <p>This user manual is written and maintained by Jean-FranÃois Fortin Tam.</p>
+ <section>
+ <title>Work in progress</title>
+ <p>You may encounter unwritten portions due to features that have not yet been implemented in PiTiVi at the time of writing.</p>
+ <p>You may also encounter smaller areas which have been documented in this manual but have not been implemented in PiTiVi â those are areas where the design and expected user interaction are quite narrow/certain.</p>
+ </section>
+
+ <section>
+ <title>Patches welcome</title>
+ <p>If you happen to find errors, missing information or unclear passages in this manual, please feel free to submit corrections. You can find contact information on <link href="http://jeff.ecchi.ca/";>my personal website</link>. You can also <link href="https://bugzilla.gnome.org/enter_bug.cgi?product=pitivi;component=documentation";>file bugs on the âdocumentationâ component in our bug tracker</link>.</p>
+ </section>
+
+</page>
diff --git a/help/C/crossfading.page b/help/C/crossfading.page
new file mode 100644
index 0000000..d8bef26
--- /dev/null
+++ b/help/C/crossfading.page
@@ -0,0 +1,34 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ xmlns:e="http://projectmallard.org/experimental/";
+ type="topic"
+ id="crossfading">
+
+ <info>
+ <link type="guide" xref="index#transitions"/>
+ <link type="seealso" xref="fadeinfadeout"/>
+ <revision pkgversion="0.13.4" version="0.1" date="2010-12-05" status="incomplete"/>
+ <credit type="author">
+ <name>Jean-FranÃois Fortin Tam</name>
+ <email>nekohayo gmail com</email>
+ </credit>
+ <credit type="contributor">
+ <name>Mario BlÃttermann</name>
+ <email>mariobl gnome org</email>
+ </credit>
+ <desc>
+ Making two clips fade into each other.
+ </desc>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>Crossfading clips</title>
+
+ <p>To do a crossfade between two clips on the same layer, simply drag one of the clips onto the other so that it overlaps. The overlapping region will be used for transitions (crossfade by default) between the two clips. You can adjust the length of the transition by moving or trimming the clips.</p>
+ <note>
+ <p>Crossfades are achieved using <app>PiTiVi</app>'s video mixing features, which use keyframes to control the opacity of clips.</p>
+ <p>This also means that if you set opacity keyframes for that clip, they will be taken into account for the crossfade.</p>
+ </note>
+
+</page>
diff --git a/help/C/effects.page b/help/C/effects.page
new file mode 100644
index 0000000..73c5ef3
--- /dev/null
+++ b/help/C/effects.page
@@ -0,0 +1,47 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ xmlns:e="http://projectmallard.org/experimental/";
+ type="topic"
+ id="effects">
+
+ <info>
+ <link type="guide" xref="index#effects"/>
+ <link type="seealso" xref="gstreamer"/>
+ <revision pkgversion="0.14" version="0.1" date="2010-06-20" status="incomplete"/>
+ <credit type="author">
+ <name>Jean-FranÃois Fortin Tam</name>
+ <email>nekohayo gmail com</email>
+ </credit>
+ <desc>Adding special effects to your video and audio</desc>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>Introduction to effects</title>
+
+ <p><app>PiTiVi</app> offers a wide variety of video and audio effects to spice up your movies. Effects are non destructive: they are only applied to the resulting rendered movie and do not affect your source files.</p>
+ <note style="important">
+ <p>Available effects depend on the software installed on your computer. If you don't see anything (or only a handful of effects) in <app>PiTiVi</app>'s effect library, make sure that the following are installed on your system:</p>
+ <list>
+ <item><p>The <link xref="gstreamer">appropriate GStreamer plugins</link></p></item>
+ <item><p>frei0r-plugins</p></item>
+ <item><p>gnome-video-effects</p></item>
+ </list>
+ </note>
+
+ <section>
+ <title>Adding and removing effects to clips</title>
+ <p>To add an effect:</p>
+ <steps>
+ <item><p>Select an existing clip on the timeline</p></item>
+ <item><p>Choose an effect in the effect library</p></item>
+ <item><p>Drag the chosen effect into the <gui>Effect Properties</gui> pane</p></item>
+ </steps>
+ <p>To remove an effect on a selected clip, select it in the effect properties pane and click the <gui>Remove</gui> button.</p>
+ </section>
+ <section>
+ <title>Toggling effects on and off</title>
+ <p>If you want to temporarily disable an effect (to compare with and without the effect, or for performance reasons), click the corresponding checkbox in the effect properties pane.</p>
+ </section>
+ <note><p>Currently, effects are applied on a "per-clip" basis. It is not yet possible to apply effects to timeline layers.</p></note>
+</page>
diff --git a/help/C/effectsanimation.page b/help/C/effectsanimation.page
new file mode 100644
index 0000000..6f7f5ea
--- /dev/null
+++ b/help/C/effectsanimation.page
@@ -0,0 +1,22 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ xmlns:e="http://projectmallard.org/experimental/";
+ type="topic"
+ id="effectsanimation">
+
+ <info>
+ <link type="guide" xref="index#effects"/>
+ <revision pkgversion="0.15" version="0.1" date="2011-06-20" status="incomplete"/>
+ <credit type="author">
+ <name>Jean-FranÃois Fortin Tam</name>
+ <email>nekohayo gmail com</email>
+ </credit>
+ <desc>Changing the properties of effects over time</desc>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>Animating effects with Keyframes</title>
+
+ <p>This feature is not yet implemented, but is planned to be completed as a GSoC 2011 project.</p>
+</page>
diff --git a/help/C/fadeinfadeout.page b/help/C/fadeinfadeout.page
new file mode 100644
index 0000000..490b7b2
--- /dev/null
+++ b/help/C/fadeinfadeout.page
@@ -0,0 +1,47 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ xmlns:e="http://projectmallard.org/experimental/";
+ type="topic"
+ id="fadeinfadeout">
+
+ <info>
+ <link type="guide" xref="index#transitions"/>
+ <revision pkgversion="0.13.4" version="0.1" date="2010-12-05" status="complete"/>
+ <credit type="author">
+ <name>Jean-FranÃois Fortin Tam</name>
+ <email>nekohayo gmail com</email>
+ </credit>
+ <credit type="contributor">
+ <name>Mario BlÃttermann</name>
+ <email>mariobl gnome org</email>
+ </credit>
+ <desc>
+ Fading video to black or to a layer below, or fading audio.
+ </desc>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>Fade-ins and fade-outs</title>
+
+ <p>You can do âfadesâ of single clip by using <app>PiTiVi</app>'s video mixing capabilities, which relies on keyframes controlling each clip's opacity (see also: <link xref="layers">Understanding layers</link>).</p>
+ <p>To fade a clip to black:</p>
+ <steps>
+ <item>
+ <p>Double-click on its opacity keyframe curve where you want the fade-out to start (or the fade-in to end).</p>
+ <figure>
+ <media type="image" src="figures/fadestep1.png" mime="image/png" style="right"></media>
+ </figure>
+ <figure>
+ <media type="image" src="figures/fadestep2.png" mime="image/png" style="right"></media>
+ </figure>
+ </item>
+ <item>
+ <p>Click and drag the last (or first) keyframe of the clip downwards.</p>
+ <figure>
+ <media type="image" src="figures/fadestep3.png" mime="image/png" style="right"></media>
+ </figure>
+ </item>
+ </steps>
+
+</page>
diff --git a/help/C/figures/fadestep1.png b/help/C/figures/fadestep1.png
new file mode 100644
index 0000000..a650273
Binary files /dev/null and b/help/C/figures/fadestep1.png differ
diff --git a/help/C/figures/fadestep2.png b/help/C/figures/fadestep2.png
new file mode 100644
index 0000000..f2b794a
Binary files /dev/null and b/help/C/figures/fadestep2.png differ
diff --git a/help/C/figures/fadestep3.png b/help/C/figures/fadestep3.png
new file mode 100644
index 0000000..3c0770d
Binary files /dev/null and b/help/C/figures/fadestep3.png differ
diff --git a/help/C/figures/filechooser.png b/help/C/figures/filechooser.png
new file mode 100644
index 0000000..36e2343
Binary files /dev/null and b/help/C/figures/filechooser.png differ
diff --git a/help/C/figures/hovering.png b/help/C/figures/hovering.png
new file mode 100644
index 0000000..867648b
Binary files /dev/null and b/help/C/figures/hovering.png differ
diff --git a/help/C/figures/keyframecurves.png b/help/C/figures/keyframecurves.png
new file mode 100644
index 0000000..ebeccbc
Binary files /dev/null and b/help/C/figures/keyframecurves.png differ
diff --git a/help/C/figures/layers.png b/help/C/figures/layers.png
new file mode 100644
index 0000000..8fb1560
Binary files /dev/null and b/help/C/figures/layers.png differ
diff --git a/help/C/figures/logo.png b/help/C/figures/logo.png
new file mode 100644
index 0000000..09fd7cd
Binary files /dev/null and b/help/C/figures/logo.png differ
diff --git a/help/C/figures/mainwindow.png b/help/C/figures/mainwindow.png
new file mode 100644
index 0000000..f87ba25
Binary files /dev/null and b/help/C/figures/mainwindow.png differ
diff --git a/help/C/figures/previewsource.png b/help/C/figures/previewsource.png
new file mode 100644
index 0000000..3ce2fd8
Binary files /dev/null and b/help/C/figures/previewsource.png differ
diff --git a/help/C/figures/ripple-after.png b/help/C/figures/ripple-after.png
new file mode 100644
index 0000000..bf3926b
Binary files /dev/null and b/help/C/figures/ripple-after.png differ
diff --git a/help/C/figures/ripple-before.png b/help/C/figures/ripple-before.png
new file mode 100644
index 0000000..5b7ab54
Binary files /dev/null and b/help/C/figures/ripple-before.png differ
diff --git a/help/C/figures/roll-after.png b/help/C/figures/roll-after.png
new file mode 100644
index 0000000..92a25ce
Binary files /dev/null and b/help/C/figures/roll-after.png differ
diff --git a/help/C/figures/roll-before.png b/help/C/figures/roll-before.png
new file mode 100644
index 0000000..6e6b30c
Binary files /dev/null and b/help/C/figures/roll-before.png differ
diff --git a/help/C/figures/ruler.png b/help/C/figures/ruler.png
new file mode 100644
index 0000000..9064464
Binary files /dev/null and b/help/C/figures/ruler.png differ
diff --git a/help/C/figures/trimming-individual.png b/help/C/figures/trimming-individual.png
new file mode 100644
index 0000000..f2b4492
Binary files /dev/null and b/help/C/figures/trimming-individual.png differ
diff --git a/help/C/gstreamer.page b/help/C/gstreamer.page
new file mode 100644
index 0000000..0e97ebb
--- /dev/null
+++ b/help/C/gstreamer.page
@@ -0,0 +1,59 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ xmlns:e="http://projectmallard.org/experimental/";
+ type="topic"
+ id="gstreamer">
+
+ <info>
+ <link type="guide" xref="index#intro"/>
+ <revision pkgversion="0.14" version="0.2" date="2011-06-05" status="complete"/>
+ <credit type="author">
+ <name>Jean-FranÃois Fortin Tam</name>
+ <email>nekohayo gmail com</email>
+ </credit>
+ <credit type="contributor">
+ <name>Mario BlÃttermann</name>
+ <email>mariobl gnome org</email>
+ </credit>
+ <desc>
+ Ensuring you have the proper multimedia codecs and plugins installed for maximum compatibility.
+ </desc>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>Gstreamer and compatibility</title>
+
+ <p>A great strength in <app>PiTiVi</app> lies in its use of the <app>GStreamer</app> multimedia framework. <app>GStreamer</app> is used by dozens of multimedia applications across desktop environments, operating systems and architectures.</p>
+ <p>This essentially means three things to you, the user:</p>
+ <list>
+ <item>
+ <p>You can, in theory, import pretty much any media file supported by <app>GStreamer</app> (but see the next section).</p>
+ </item>
+ <item>
+ <p>You can render your projects using any supported container and codec combination from <app>GStreamer</app>.</p>
+ </item>
+ <item>
+ <p>You need a very recent version of <app>GStreamer</app> to maximize <app>PiTiVi's</app> capabilities and reduce the possibilities of bugs. This is because the <app>PiTiVi</app> project developers work hard in fixing problems directly in <app>GStreamer</app> (instead of putting temporary workarounds inside <app>PiTiVi</app>).</p>
+ </item>
+ </list>
+
+ <section>
+ <title>A word about editing-friendly codecs</title>
+ <p>Some formats, like <em>MPEG</em>, are oriented towards playback only, and do not compress each frame independently. While it is the goal of <app>PiTiVi</app> to support working with these files, certain operations (like rapid seeking) will not perform as well as they would with frame-independent compressed video (such as <em>MJPEG</em> or <em>DV</em>).</p>
+ </section>
+
+ <section>
+ <title>The Good, the Bad and the Ugly</title>
+ <p><app>GStreamer</app> plugins come into three categories: good, bad and ugly. To maximize your experience, you may need to install some of all of these plugins to ensure compatibility with your media files. Whether or not you install them is up to you, and may depend on your country's jurisdiction regarding software patents.</p>
+ <list>
+ <item><p>The "Good" plugins are good quality plugins under the LGPL license. These plugins are considered safe and recommended at any time.</p></item>
+ <item><p>The "Bad" plugins are plugins whose code is not of good enough quality, or are not considered tested well enough. The licensing may or may not be LGPL.</p></item>
+ <item><p>The "Ugly" plugins are good quality plugins whose license is not LGPL or with licensing issues.</p></item>
+ </list>
+ <note><p>In addition to the Good, Bad and Ugly plugins, you may want to install gstreamer-ffmpeg to have access to ffmpeg's set of codecs.</p></note>
+ <p></p>
+ </section>
+
+
+</page>
diff --git a/help/C/importing.page b/help/C/importing.page
new file mode 100644
index 0000000..8e671de
--- /dev/null
+++ b/help/C/importing.page
@@ -0,0 +1,75 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ xmlns:e="http://projectmallard.org/experimental/";
+ type="topic"
+ id="importing">
+
+ <info>
+ <link type="guide" xref="index#gettingstarted"/>
+ <revision pkgversion="0.14" version="0.2" date="2011-06-05" status="incomplete"/>
+ <credit type="author">
+ <name>Jean-FranÃois Fortin Tam</name>
+ <email>nekohayo gmail com</email>
+ </credit>
+ <credit type="contributor">
+ <name>Mario BlÃttermann</name>
+ <email>mariobl gnome org</email>
+ </credit>
+ <desc>
+ Importing files into your project as clips.
+ </desc>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>Getting media</title>
+
+ <p>At the time of this writing, the only supported method is importing files from your hard drive. As such, you cannot use <app>PiTiVi</app> to capture directly from a camcorder. For DV/HDV camcorders using an IEEE 1394 connection, you may use <app>Kino</app> or <app>dvgrab</app> to capture footage.</p>
+ <note>
+ <p>We would welcome good quality patches to implement the following:</p>
+ <list>
+ <item><p>Capture from a DV or HDV camcorder using an IEEE 1394 connection.</p></item>
+ <item><p>Capture from a webcam.</p></item>
+ <item><p>Dumping a network/Internet stream.</p></item>
+ <item><p>Importing from DVD.</p></item>
+ <item><p>Importing from an audio CD.</p></item>
+ <item><p>Downloading from content providers such as <link href="http://www.jamendo.com";>Jamendo</link>, <link href="http://www.magnatune.com/";>Magnatune</link>, <link href="http://creativecommons.org/";>CreativeCommons</link>, etc.</p>
+ </item>
+ </list>
+ </note>
+
+ <section>
+ <title>Importing files</title>
+ <section>
+ <title>Using the file chooser</title>
+ <p>You can import media into the <gui>Media Library</gui> by using the file chooser dialog, which has the advantage of letting you preview the files you want to import. To do so, use the <guiseq><gui>Project</gui><gui>Import clips...</gui></guiseq> menu, the <gui>Import clips</gui> button on the main toolbar, or press <keyseq><key>Ctrl</key><key>i</key></keyseq>.</p>
+ <p>The following file chooser dialog window will appear:</p>
+ <figure>
+ <title>Filechooser dialog</title>
+ <desc>Filechooser dialog</desc>
+ <media type="image" src="figures/filechooser.png" mime="image/png" style="right"></media>
+ </figure>
+ <p>Press <key>Ctrl</key> or <key>Shift</key> to select multiple files at the same time. You can also import all the files contained in a folder (and its subfolders) by using <guiseq><gui>Project</gui><gui>Import folder of clips</gui></guiseq> in the menu bar.</p>
+ </section>
+ <section>
+ <title>Using drag and drop</title>
+ <p>The concept of drag and drop is a well-established method of bridging the gap between software applications. Simply select the files you want to import in another application (such as a file manager or a multimedia app) and drag them with your mouse onto <app>PiTiVi</app>'s <gui>Media Library</gui>.</p>
+ <p>This feature can be used to:</p>
+ <list>
+ <item>
+ <p>Easily import music or video clips from a media player (such as <app>Rhythmbox</app> or <app>Totem</app>).</p>
+ </item>
+ <item>
+ <p>Allow using a full-fledged file manager (such as <app>Nautilus</app>, <app>Thunar</app>, <app>Dolphin</app> or <app>Konqueror</app>) instead of the file chooser dialog.</p>
+ </item>
+ <item>
+ <p>Import a combination of files and folders at the same time.</p>
+ </item>
+ <item>
+ <p>Leverage the searching capability of another application (such as <app>GNOME Shell</app>, <app>Tracker</app>, <app>GNOME Activity Journal</app>, <app>GNOME Search Tool</app>, etc.).</p>
+ </item>
+ </list>
+ </section>
+ </section>
+
+</page>
diff --git a/help/C/importingmpegts.page b/help/C/importingmpegts.page
new file mode 100644
index 0000000..40c893c
--- /dev/null
+++ b/help/C/importingmpegts.page
@@ -0,0 +1,27 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ xmlns:e="http://projectmallard.org/experimental/";
+ type="topic"
+ id="importingmpegts">
+
+ <info>
+ <link type="seealso" xref="importing"/>
+ <link type="seealso" xref="gstreamer"/>
+ <revision pkgversion="0.14" version="0.1" date="2011-06-05" status="complete"/>
+ <credit type="author">
+ <name>Jean-FranÃois Fortin Tam</name>
+ <email>nekohayo gmail com</email>
+ </credit>
+ <desc>
+ How to convert .mts and .m2ts files to a format that can be parsed by GStreamer and PiTiVi.
+ </desc>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+ <!-- TODO: remove this manual page when gstreamer supports mpeg-ts files !-->
+ <title>Dealing with AVCHD / MPEG-TS files</title>
+
+ <p>At the time being, MPEG Transport Stream files (usually with file extensions such as .mts, .m2ts and sometimes .mpg or .mpeg), such as those used by some HD camcorders, cannot be played reliably with <app>GStreamer</app>. As such, you may want to remux them in a different container format by using <app>ffmpeg</app>. To convert losslessly to an MPEG4 container, you can use the following command:</p>
+ <code>ffmpeg -i your_clip.MTS -vcodec copy -acodec copy -sn test.mp4</code>
+
+</page>
diff --git a/help/C/index.page b/help/C/index.page
new file mode 100644
index 0000000..6b61dee
--- /dev/null
+++ b/help/C/index.page
@@ -0,0 +1,56 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ xmlns:e="http://projectmallard.org/experimental/";
+ type="guide"
+ id="index">
+
+ <info>
+ <title type="link">PiTiVi Quick Start Manual</title>
+ <title type="text">PiTiVi Quick Start Manual</title>
+ <revision pkgversion="0.14.0" version="0.2" date="2011-06-05" status="complete"/>
+ <credit type="author">
+ <name>Jean-FranÃois Fortin Tam</name>
+ <email>nekohayo gmail com</email>
+ </credit>
+ <credit type="contributor">
+ <name>Mario BlÃttermann</name>
+ <email>mariobl gnome org</email>
+ </credit>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>
+ <media type="image" mime="image/png" src="figures/logo.png">PiTiVi logo</media>
+ PiTiVi Video Editor
+ </title>
+
+ <p>Built upon the <link href="http://en.wikipedia.org/wiki/GStreamer";><app>GStreamer</app></link> multimedia framework, <app>PiTiVi</app> aims to be an intuitive and flexible video editor that integrates well with <link href="http://gnome.org";><app>GNOME</app></link> and can appeal to newbies and professionals alike.</p>
+ <p>This guide is intended to help you grasp the concepts behind its design and get productive quickly.</p>
+
+ <section id="intro" style="2column">
+ <title>Introduction</title>
+ </section>
+
+ <section id="gettingstarted" style="2column">
+ <title>Getting Started</title>
+ </section>
+
+ <section id="timeline" style="2column">
+ <title>Basic Editing with the Timeline</title>
+ </section>
+
+ <section id="effects" style="2column">
+ <title>Special Effects</title>
+ </section>
+
+ <section id="transitions" style="2column">
+ <title>Transitions</title>
+ </section>
+
+ <section id="rendering" style="2column">
+ <title>Exporting Your Finished Movie</title>
+ </section>
+
+
+</page>
diff --git a/help/C/insertintimeline.page b/help/C/insertintimeline.page
new file mode 100644
index 0000000..4f3c841
--- /dev/null
+++ b/help/C/insertintimeline.page
@@ -0,0 +1,37 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ xmlns:e="http://projectmallard.org/experimental/";
+ type="topic"
+ id="insertintimeline">
+
+ <info>
+ <link type="guide" xref="index#gettingstarted"/>
+ <revision pkgversion="0.14" version="0.2" date="2011-06-05" status="complete"/>
+ <credit type="author">
+ <name>Jean-FranÃois Fortin Tam</name>
+ <email>nekohayo gmail com</email>
+ </credit>
+ <credit type="contributor">
+ <name>Mario BlÃttermann</name>
+ <email>mariobl gnome org</email>
+ </credit>
+ <desc>
+ Putting your project media files into the timeline for editing.
+ </desc>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>Inserting clips</title>
+
+ <p>From the source list, you can insert one or more clips by selecting them (using the <key>Ctrl</key> or <key>Shift</key> keys to select multiple clips) and:</p>
+ <list>
+ <item><p>Dragging and dropping them onto place in the timeline.</p></item>
+ <item><p>Using <guiseq><gui>Project</gui><gui>Insert at end of timeline</gui></guiseq>.</p></item>
+ <item><p>Pressing the <key>Insert</key> (Ins) key. Those clips will be inserted at the end of the timeline.</p></item>
+ </list>
+ <note style="bug">
+ <p>It should also be possible to import files directly into the timeline by dragging them from another application and dropping them onto <app>PiTiVi</app>'s timeline. The files would be added automatically to the <gui>Media Library</gui> in the process. This feature is not yet implemented, see <link href="https://bugzilla.gnome.org/show_bug.cgi?id=608682";>bug #570118</link> for more information.</p>
+ </note>
+
+</page>
diff --git a/help/C/interface.page b/help/C/interface.page
new file mode 100644
index 0000000..43f9959
--- /dev/null
+++ b/help/C/interface.page
@@ -0,0 +1,21 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ xmlns:e="http://projectmallard.org/experimental/";
+ type="guide"
+ id="interface">
+
+ <info>
+ <link type="guide" xref="index#intro"/>
+ <revision pkgversion="0.14" version="0.2" date="2010-12-05" status="complete"/>
+ <credit type="author">
+ <name>Jean-FranÃois Fortin Tam</name>
+ <email>nekohayo gmail com</email>
+ </credit>
+ <desc>Discover the various windows, components and widgets.</desc>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>An overview of the user interface</title>
+
+</page>
diff --git a/help/C/keyframecurves.page b/help/C/keyframecurves.page
new file mode 100644
index 0000000..4f98305
--- /dev/null
+++ b/help/C/keyframecurves.page
@@ -0,0 +1,53 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ xmlns:e="http://projectmallard.org/experimental/";
+ type="topic"
+ id="keyframecurves">
+
+ <info>
+ <link type="guide" xref="index#timeline"/>
+ <revision pkgversion="0.13.4" version="0.1" date="2010-12-05" status="complete"/>
+ <credit type="author">
+ <name>Jean-FranÃois Fortin Tam</name>
+ <email>nekohayo gmail com</email>
+ </credit>
+ <credit type="contributor">
+ <name>Mario BlÃttermann</name>
+ <email>mariobl gnome org</email>
+ </credit>
+ <desc>
+ Changing the opacity or volume of a clip over time.
+ </desc>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>Keyframe curves</title>
+
+ <p>Some types of clips (currently only audio clips) support interpolating property values over their time. The user can add one or more <em>keyframes</em> to control the interpolation, a term borrowed from animation. <app>PiTiVi</app> represents the value of the property in between keyframes as a <em>curve</em> drawn over the clip. Currently only linear interpolation is supported.</p>
+ <figure>
+ <media type="image" src="figures/keyframecurves.png" mime="image/png" style="right"></media>
+ </figure>
+
+ <section>
+ <title>General usage</title>
+ <p>Curves are an intrinsic property of clips and can not be removed by the user. The start and end points of the curve are fixed to the start and end points of the clip, and also can not be removed by the user.</p>
+ <list>
+ <item><p>You can add a new keyframe by double-clicking on an empty portion of a curve.</p></item>
+ <item><p>You can remove a keyframe by double-clicking on it.</p></item>
+ <item><p>You can adjust the time and value of a keyframe by moving it with the mouse. You can place the keyframe anywhere on the clip you like, even if this changes the order of the keyframes.</p></item>
+ <item><p>You can click-and-drag on a segment of a curve between two keyframes to adjust the vertical position of the segment.</p></item>
+ </list>
+ </section>
+
+ <section>
+ <title>Audio curves</title>
+ <p>For volume curves the vertical position represents the volume of the clip on a scale from 0 to 200%.</p>
+ </section>
+
+ <section>
+ <title>Video compositing curves</title>
+ <p>The vertical position represents the alpha (opacity) of the clip on a scale from 0 to 100%. See the <link xref="layers">Understanding layers</link> section for more details.</p>
+ </section>
+
+</page>
diff --git a/help/C/layers.page b/help/C/layers.page
new file mode 100644
index 0000000..0f63878
--- /dev/null
+++ b/help/C/layers.page
@@ -0,0 +1,59 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ xmlns:e="http://projectmallard.org/experimental/";
+ type="topic"
+ id="layers">
+
+ <info>
+ <link type="guide" xref="index#timeline"/>
+ <revision pkgversion="0.13.4" version="0.1" date="2010-12-05" status="complete"/>
+ <credit type="author">
+ <name>Jean-FranÃois Fortin Tam</name>
+ <email>nekohayo gmail com</email>
+ </credit>
+ <credit type="contributor">
+ <name>Mario BlÃttermann</name>
+ <email>mariobl gnome org</email>
+ </credit>
+ <desc>
+
+ </desc>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>Understanding layers</title>
+
+ <p><em>Layers</em> are a fundamental concept for advanced editing in the timeline: compositing, mixing multiple videos simultaneously, and adding titles depend on this feature.</p>
+ <p>It is easier to think of layers in terms of images painted on glass. With several pieces of glass stacked on top of each other, each of these pieces of glass is a layer. If the top piece of glass is completely painted over, none of the pieces of glass underneath will be visible.</p>
+ <p>If, on the other hand, you only paint over a portion of a piece of glass, you will be able to see what is underneath the non-painted parts.</p>
+
+ <section>
+ <title>Opacity (how solid âopaqueâ things are)</title>
+ <p>Each layer (and each clip) has its own transparency. To continue the paint on glass metaphor, if the paint is thin enough, it can be seen through. Visually, an opacity of 100% means you cannot see the clips below that layer or clip, and an opacity of of 50% means you can partly see them.</p>
+ </section>
+
+ <section>
+ <title>How this translates in terms of user interface</title>
+ <p>While, in real life, you can stack pieces of glass onto each other in three dimensions, your computer monitor only has two dimensions. Thus, the <em>layers on top</em> (the âZâ axis in the physical world) are also visually <em>on top</em>, albeit on the âYâ axis.</p>
+ <p>The following diagram illustrates the <em>pieces of glass</em> (left) and how they are show as <em>layers</em> in <app>PiTiVi</app>'s user interface (right).</p>
+ <figure>
+ <media type="image" src="figures/layers.png" mime="image/png" style="right"></media>
+ </figure>
+ <p>Clips located on a layer above will block the clips below from view, unless it has an opacity value lower than 100% (as shown with the two topmost layers in the previous illustration).</p>
+ </section>
+
+ <section>
+ <title>Adding and removing layers</title>
+ <p>Layers are created and removed automatically. There is no âlayer managementâ interface in <app>PiTiVi</app> (at least, not yet).</p>
+ <p>To create a layer, drag a clip downwards until a new layer appears for it.</p>
+ <p>If there are no more clips on a layer, it is automatically removed. Thus, to remove a layer, simply drag its clips upwards onto another layer.</p>
+ </section>
+
+ <section>
+ <title>What about audio layers?</title>
+ <p>Unlike in vision, multiple sounds do not (objectively) âblockâ each other. As such, if you have multiple audio clips on separate layers, their sound will be mixed together. Controlling the volume of those audio clips simply changes their relative loudness.</p>
+ </section>
+
+
+</page>
diff --git a/help/C/license.page b/help/C/license.page
new file mode 100644
index 0000000..668eec1
--- /dev/null
+++ b/help/C/license.page
@@ -0,0 +1,50 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="topic"
+ id="license">
+
+ <info>
+ <link type="seealso" xref="index"/>
+ <revision pkgversion="2.30" version="0.1" date="2009-12-28" status="draft"/>
+ <desc>Legal information.</desc>
+ </info>
+
+ <title>License</title>
+ <p>
+ <!--
+ Translators: try to use the same translation as the one provided by the CreativeCommons website.
+ If there is no translation for your language, consider providing one to CreativeCommons.
+ -->
+ This work is distributed under a CreativeCommons Attribution-Share Alike
+ 3.0 Unported license.
+ </p>
+ <p>
+ You are free:
+ </p>
+ <terms>
+ <item>
+ <title><em>To share</em></title>
+ <p>To copy, distribute and transmit the work.</p>
+ </item>
+ <item>
+ <title><em>To remix</em></title>
+ <p>To adapt the work.</p>
+ </item>
+ </terms>
+ <p>Under the following conditions:</p>
+ <terms>
+ <item>
+ <title><em>Attribution</em></title>
+ <p>You must attribute the work in the manner specified by the author or licensor (but not in any way that suggests that they endorse you or your use of the work).</p>
+ </item>
+ <item>
+ <title><em>Share Alike</em></title>
+ <p>If you alter, transform, or build upon this work, you may distribute the resulting work only under the same, similar or a compatible license.</p>
+ </item>
+ </terms>
+ <p>
+ <!-- Translators: there are no official localized versions of the legal code, only the deed is localized. -->
+ For the full text of the license, see the
+ <link href="http://creativecommons.org/licenses/by-sa/3.0/legalcode";>CreativeCommons website</link>,
+ or read the full <link href="http://creativecommons.org/licenses/by-sa/3.0/";>Commons Deed</link>.
+ </p>
+</page>
diff --git a/help/C/mainwindow.page b/help/C/mainwindow.page
new file mode 100644
index 0000000..e2e7884
--- /dev/null
+++ b/help/C/mainwindow.page
@@ -0,0 +1,106 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ xmlns:e="http://projectmallard.org/experimental/";
+ type="topic"
+ id="mainwindow">
+
+ <info>
+ <link type="guide" xref="interface"/>
+ <link type="seealso" xref="medialibrary"/>
+ <link type="seealso" xref="movearoundtimeline"/>
+ <revision pkgversion="0.14" version="0.2" date="2010-12-05" status="complete"/>
+ <credit type="author">
+ <name>Jean-FranÃois Fortin Tam</name>
+ <email>nekohayo gmail com</email>
+ </credit>
+ <desc>
+ Discover the components of the main window.
+ </desc>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>The main window</title>
+
+ <figure>
+ <title><app>PiTiVi</app> main window</title>
+ <desc><app>PiTiVi</app> main window</desc>
+ <media type="image" src="figures/mainwindow.png" mime="image/png" style="right">
+ <p><app>PiTiVi</app> main window.</p>
+ </media>
+ </figure>
+ <p>The main window, as the name implies, is the window containing the main components of the <app>PiTiVi</app> user interface, namely: the menu bar, the toolbars, the timeline and various customizable components (source list, previewer, effects list, transitions list, etc.).</p>
+
+
+ <section>
+ <title>Menu bar</title>
+ <p>The menu bar contains all the possible actions of the toolbars, plus many more. The menu bar also provides some instant-apply settings, as well as access to further customizations in the <gui>Project settings</gui> dialog and <gui>Preferences</gui> dialog.</p>
+ <note><p>The menu bar cannot be hidden.</p>
+ </note>
+ </section>
+
+ <section>
+ <title>The toolbars</title>
+ <p>Toolbars provide access to the most commonly used functions of <app>PiTiVi</app>. All items in toolbars can also be accessed through the menu bar. Toolbars can be activated or deactivated in the <gui>View</gui> menu.</p>
+ <p>You can hover the mouse cursor over a toolbar item to reveal an information tooltip regarding its function.</p>
+ <figure>
+ <media type="image" src="figures/hovering.png" mime="image/png" style="right"></media>
+ </figure>
+ </section>
+
+ <section>
+ <title>Ruler</title>
+ <p>The ruler plays a crucial role in your interaction with the timeline. In addition to giving you time measurements (in seconds), it is the primary way of moving the playhead (and thus, your position in time).</p>
+ <p>The current playhead position is indicated by a red vertical line:</p>
+ <figure>
+ <media type="image" src="figures/ruler.png" mime="image/png" style="right"></media>
+ </figure>
+ <note>
+ <p>When zoomed in, frames are visually represented on the ruler as alternating light and dark areas in the bottom part; those are based on the project framerate settings.</p>
+ </note>
+ <p>To move your position in time, click anywhere on the ruler. You can also <em>scrub</em> the timeline by clicking on the ruler and holding down the mouse button while moving. See the <link xref="scrubbing">Scrubbing</link> section for more details.</p>
+ </section>
+
+ <section>
+ <title>Marker bar</title>
+ <p>Markers are visual cues that you can create to <em>mark</em> important points or regions in your project's timeline. The marker bar allows you to view and edit markers that you created.</p>
+ <note style="bug">
+ <p>This feature is not yet implemented. See <link href="https://bugzilla.gnome.org/show_bug.cgi?id=608682";>bug #608682</link> for more information.</p>
+ </note>
+ </section>
+
+ <section>
+ <title>Timeline</title>
+ <p>The timeline is the core user interface component that you will use for editing. It is a visual, time-proportional representation of your project's chronology.</p>
+ </section>
+
+ <section>
+ <title>Playback toolbar</title>
+ <p>This toolbar, located below the previewer, contains buttons controlling</p>
+ <list>
+ <item><p>The playback of the timeline.</p></item>
+ <item><p>The playback of a clip being previewed from the source list.</p></item>
+ </list>
+ <p>The <gui>Play</gui> button transforms into a <gui>Pause</gui> button when playing, and reverts to a <gui>Play</gui> button again when not playing.</p>
+ </section>
+
+ <section>
+ <title>Previewer</title>
+ <p>The previewer displays</p>
+ <list>
+ <item><p>Your project's video when playing back.</p></item>
+ <item><p>The video frame at the current position of the playhead.</p></item>
+ <item><p>A <em>live preview</em> when trimming a clip's beginning/end point.</p>
+ <note style="bug">
+ <p>The <em>live preview</em> feature is not yet implemented. See <link href="https://bugzilla.gnome.org/show_bug.cgi?id=569980";>bug #569980</link> for more information.</p>
+ </note>
+ </item>
+ </list>
+ </section>
+
+ <section>
+ <title>Media Library</title>
+ <p>The media library displays the imported media files in your project and allows you to manage them.</p>
+ </section>
+
+</page>
diff --git a/help/C/makeselections.page b/help/C/makeselections.page
new file mode 100644
index 0000000..6ec8779
--- /dev/null
+++ b/help/C/makeselections.page
@@ -0,0 +1,49 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ xmlns:e="http://projectmallard.org/experimental/";
+ type="topic"
+ id="makeselections">
+
+ <info>
+ <link type="guide" xref="index#gettingstarted"/>
+ <revision pkgversion="0.13.4" version="0.1" date="2010-12-05" status="complete"/>
+ <credit type="author">
+ <name>Jean-FranÃois Fortin Tam</name>
+ <email>nekohayo gmail com</email>
+ </credit>
+ <credit type="contributor">
+ <name>Mario BlÃttermann</name>
+ <email>mariobl gnome org</email>
+ </credit>
+ <desc>
+ Selecting and deselecting single or multiple items.
+ </desc>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>Making selections</title>
+
+ <section>
+ <title>Selecting a single item</title>
+ <p>To select a file or a clip in <app>PiTiVi</app>, click it.</p>
+ </section>
+
+ <section>
+ <title>Selecting multiple items</title>
+ <p>Multiple selections allow you to apply actions (dragging, deleting, grouping, etc.) to many clips at once.</p>
+ <p>Selecting multiple adjacent items:</p>
+ <steps>
+ <item><p>Click the first item.</p></item>
+ <item><p>Hold the <key>Shift</key> key.</p></item>
+ <item><p>Click the last item.</p></item>
+ </steps>
+ <p>Selecting multiple nonadjacent items:</p>
+ <steps>
+ <item><p>Hold down the <key>Ctrl</key> key.</p></item>
+ <item><p>Click on all the items you want to select.</p></item>
+ </steps>
+ <p>You can deselect an individual item by clicking on it again with the <key>Ctrl</key> key held down. This can be used in conjunction with the <em>Selecting multiple adjacent items</em> technique above.</p>
+ </section>
+
+</page>
diff --git a/help/C/medialibrary.page b/help/C/medialibrary.page
new file mode 100644
index 0000000..4bccb80
--- /dev/null
+++ b/help/C/medialibrary.page
@@ -0,0 +1,52 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ xmlns:e="http://projectmallard.org/experimental/";
+ type="topic"
+ id="medialibrary">
+
+ <info>
+ <link type="guide" xref="interface"/>
+ <revision pkgversion="0.14" version="0.2" date="2011-06-05" status="incomplete"/>
+ <credit type="author">
+ <name>Jean-FranÃois Fortin Tam</name>
+ <email>nekohayo gmail com</email>
+ </credit>
+ <desc>
+ Managing your imported clips with the Media Library
+ </desc>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>Using the Media Library</title>
+
+ <section>
+ <title>Previewing a clip from the <gui>Media Library</gui></title>
+ <p>To preview a clip before placing it on the timeline, you can double-click on it in the <gui>Media Library</gui>, or right-click and choose <gui>Play clip</gui> from the popup menu.</p>
+ <figure>
+ <desc>Popup menu</desc>
+ <media type="image" src="figures/previewsource.png" mime="image/png" style="right"></media>
+ </figure>
+ </section>
+ <section>
+ <title>Filtering search</title>
+ <p>A search bar is shown at the top of the <gui>Media Library</gui>. Typing into the search entry filters the contents of the <gui>Media Library</gui> to show only clips whose filenames match your search terms. To reset the search entry, click the "cleanup" icon in the search entry.</p>
+ </section>
+ <section>
+ <title>Typeahead search</title>
+ <p>An alternative way of searching, if you know the beginning of a clip's filename, is to click anywhere in the <gui>Media Library</gui> and start typing the name of the file you're looking for.</p>
+ <list>
+ <item><p>As you type, the first matching file will become selected.</p></item>
+ <item><p>You can keep typing to refine your search.</p></item>
+ <item><p>When there are multiple results, you can use the <gui>up</gui> and <app>down</app> arrow keys to switch the selection between each search result.</p>
+ </item>
+ </list>
+ <p>This method only allows searching from the beginning of the filename.</p>
+ </section>
+ <section>
+ <title>View modes</title>
+ <p>The <gui>Media Library</gui> can display your clips in a list (<guiseq><gui>View</gui><gui>Show Clips as a List</gui></guiseq>) or in an icon view (<guiseq><gui>View</gui><gui>Show Clips as Icons</gui></guiseq>).</p>
+ <p>The list view mode shows more details about each clip, but the icon view mode can display more clips without needing to scroll (especially on high resolution computer monitors).</p>
+ </section>
+
+</page>
diff --git a/help/C/movearoundtimeline.page b/help/C/movearoundtimeline.page
new file mode 100644
index 0000000..0213757
--- /dev/null
+++ b/help/C/movearoundtimeline.page
@@ -0,0 +1,68 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ xmlns:e="http://projectmallard.org/experimental/";
+ type="topic"
+ id="movearoundtimeline">
+
+ <info>
+ <link type="guide" xref="index#gettingstarted"/>
+ <revision pkgversion="0.13.4" version="0.1" date="2010-12-05" status="incomplete"/>
+ <credit type="author">
+ <name>Jean-FranÃois Fortin Tam</name>
+ <email>nekohayo gmail com</email>
+ </credit>
+ <credit type="contributor">
+ <name>Mario BlÃttermann</name>
+ <email>mariobl gnome org</email>
+ </credit>
+ <desc>
+ Moving the playhead, using the zoom feature, scrolling and scrubbing.
+ </desc>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>Moving around the timeline</title>
+
+ <section>
+ <title>Scrolling</title>
+ <p>You can use the scrollbars (located on the right and bottom of the timeline), use the mouse wheel anywhere over the timeline to scroll horizontally, or hold down the <key>Shift</key> key while using the mousewheel to scroll the timeline layers vertically.</p>
+ </section>
+
+ <section>
+ <title>Zooming</title>
+ <p>Zooming directly affects your editing accuracy and your ability to move quickly along the timeline:</p>
+ <list>
+ <item><p>When zooming in, video clips display more thumbnails and audio clips display increasingly detailed waveforms, allowing you to do precise edits.</p></item>
+ <item><p>Zooming out allows you to scroll faster along the timeline. Zoom can thus be used in conjunction with scrolling to move quickly between distant points of your project's chronology.</p></item>
+ </list>
+ <p>You can zoom in and out by holding the <key>Ctrl</key> key while using the mousewheel over the timeline, using the <guiseq><gui>View</gui><gui>Zoom In</gui></guiseq> and <guiseq><gui>View</gui><gui>Zoom Out</gui></guiseq>menu items, or dragging the zoom slider on the left of the ruler.</p>
+ <note>
+ <title><em>Warping</em> between zoom levels</title>
+ <p>Using your mouse's scroll wheel, you can also <em>warp</em> instantly from any zoom level to another in a single click. To do that, click with your mousewheel anywhere on the zoom slider.</p>
+ </note>
+ </section>
+
+ <section id="movingplayhead">
+ <title>Moving the playhead</title>
+ <p>You can change the position of the playhead by clicking anywhere on the ruler or on the timeline.</p>
+ <p>When clicking on the <em>timeline</em>:</p>
+ <list>
+ <item><p>If a clip is under the mouse cursor, it will replace the current clip selection (see the <link xref="selectmulti">Selecting multiple items</link> section for more detailed instructions).</p></item>
+ <item><p>If there is no clip under the cursor, all selected clips (if any) will be deselected.</p></item>
+ </list>
+ <p>When clicking on the ruler, only the playhead's position changes; clip selections are not affected.</p>
+ </section>
+
+ <section>
+ <title>Scrubbing</title>
+ <p><em>Scrubbing</em> is a way of moving the playhead that allows you to:</p>
+ <list>
+ <item><p>Search for a specific position in time by approximation/trial and error.</p></item>
+ <item><p>Review repeatedly the visual motion in a scene by moving back and forth in time.</p></item>
+ </list>
+ <p>To scrub, click on the ruler and move the mouse with the button still held down.</p>
+ <p>You can also scrub by dragging the black vertical line that stems from the playhead and spans across the timeline.</p>
+ </section>
+
+</page>
diff --git a/help/C/othertransitions.page b/help/C/othertransitions.page
new file mode 100644
index 0000000..bd7cc67
--- /dev/null
+++ b/help/C/othertransitions.page
@@ -0,0 +1,27 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ xmlns:e="http://projectmallard.org/experimental/";
+ type="topic"
+ id="othertransitions">
+
+ <info>
+ <link type="guide" xref="index#transitions"/>
+ <revision pkgversion="0.13.4" version="0.1" date="2010-12-05" status="incomplete"/>
+ <credit type="author">
+ <name>Jean-FranÃois Fortin Tam</name>
+ <email>nekohayo gmail com</email>
+ </credit>
+ <credit type="contributor">
+ <name>Mario BlÃttermann</name>
+ <email>mariobl gnome org</email>
+ </credit>
+ <desc></desc>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>Other transitions</title>
+
+ <p>Other types of transitions (such as wipes) are not yet implemented (see <link href="https://bugzilla.gnome.org/show_bug.cgi?id=609353";>bug #609353</link>).</p>
+
+</page>
diff --git a/help/C/projectsettings.page b/help/C/projectsettings.page
new file mode 100644
index 0000000..0f4dff8
--- /dev/null
+++ b/help/C/projectsettings.page
@@ -0,0 +1,56 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ xmlns:e="http://projectmallard.org/experimental/";
+ type="topic"
+ id="editsettings">
+
+ <info>
+ <link type="guide" xref="index#gettingstarted"/>
+ <revision pkgversion="0.14" version="0.2" date="2011-06-05" status="complete"/>
+ <credit type="author">
+ <name>Jean-FranÃois Fortin Tam</name>
+ <email>nekohayo gmail com</email>
+ </credit>
+ <credit type="contributor">
+ <name>Mario BlÃttermann</name>
+ <email>mariobl gnome org</email>
+ </credit>
+ <desc>
+ How to specify the global project resolution, framerate, aspect ratio, audio settings and project metadata.
+ </desc>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>Editing project settings</title>
+
+ <p>When starting a new project, you should make sure to go adjust the project settings, such as framerate, resolution and preferred codecs. The video resolution and aspect ratio will affect the appearance of the previewer. If you do not set the resolution and aspect ratio to match those of your footage, the video may look squished or letterboxed.</p>
+ <p>To edit the project settings after initial creation, use the <guiseq><gui>Project</gui><gui>Project Settings</gui></guiseq> menu.</p>
+
+ <section>
+ <title>Pixel aspect ratio vs display aspect ratio</title>
+ <p>Digital images are composed of a grid of <link href="http://en.wikipedia.org/wiki/Pixel";>pixels</link>, which may or may not be square. As such, in some cases, you may need to set the <link href="http://en.wikipedia.org/wiki/Pixel_aspect_ratio";>pixel aspect ratio</link> (PAR) for the image to display correctly. On the other hand, <link href="http://en.wikipedia.org/wiki/Display_aspect_ratio";>display aspect ratio</link> (DAR) is the mathematical ratio of width:height for the whole image.</p>
+ <p>In <app>PiTiVi</app>, pixel aspect ratio and display aspect ratio are related to each other by the video resolution (width and height). Once your resolution is set, setting the DAR will influence the PAR and vice versa. You can use either DAR or PAR, whichever you are most comfortable with.</p>
+ <p>You can use the ratios already provided in the combo boxes, or input a custom aspect ratio in the text entry below (using a syntax such as "4:3" or "1.3333", although the decimal version is less precise).</p>
+ </section>
+
+ <section>
+ <title>Presets</title>
+ <p>The project settings dialog allows you to save presets for later use. If you often deal with the same kind of project settings or with different cameras using different settings, you may want to create custom presets.</p>
+ <note><p>Video presets and audio presets are independent of each other.</p></note>
+ <p>To create a preset:</p>
+ <steps>
+ <item><p>Change the video (or audio) settings to your liking.</p></item>
+ <item><p>Click the <gui>Add</gui> button.</p></item>
+ <item><p>Give your preset a unique name: while the preset is selected in the list, click on its name to toggle editing mode. When you're done, press <key>Enter</key>.</p></item>
+ </steps>
+ <p>To edit a preset:</p>
+ <steps>
+ <item><p>Select your preset in the list of existing presets.</p></item>
+ <item><p>Change the settings to your liking.</p></item>
+ <item><p>Click the <gui>Save</gui> button.</p></item>
+ </steps>
+ <p>To remove a preset, simply select it in the list of presets and press the <gui>Remove</gui> button.</p>
+ </section>
+
+</page>
diff --git a/help/C/rendering.page b/help/C/rendering.page
new file mode 100644
index 0000000..0008e3c
--- /dev/null
+++ b/help/C/rendering.page
@@ -0,0 +1,37 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ xmlns:e="http://projectmallard.org/experimental/";
+ type="topic"
+ id="rendering">
+
+ <info>
+ <link type="guide" xref="index#rendering"/>
+ <revision pkgversion="0.13.4" version="0.1" date="2010-12-05" status="incomplete"/>
+ <credit type="author">
+ <name>Jean-FranÃois Fortin Tam</name>
+ <email>nekohayo gmail com</email>
+ </credit>
+ <credit type="contributor">
+ <name>Mario BlÃttermann</name>
+ <email>mariobl gnome org</email>
+ </credit>
+ <desc>
+ Learn the difference between saving a project and exporting a rendered movie.
+ </desc>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>Understanding rendering</title>
+
+ <p>Rendering is the process of exporting your project into a new, finalized media file. Rendering only creates a new ârenderedâ video file, and does not affect the project itself; you can still make edits to your project and render again as many times as needed.</p>
+ <steps>
+ <item><p>From the <gui>Project</gui> menu, use <gui>Render</gui>.</p></item>
+ <item><p>Adjust the various encoding settings, if needed, to use settings different from the project settings.</p></item>
+ <item><p>Click the <gui>Render</gui> button.</p></item>
+ </steps>
+ <note style="bug">
+ <p>If your computer is set to suspend or hibernate automatically, <app>PiTiVi</app> will automatically inhibit the power saving features during the render process (see bug <link href="https://bugzilla.gnome.org/show_bug.cgi?id=571885";>bug #571885</link>).</p>
+ </note>
+
+</page>
diff --git a/help/C/saveproject.page b/help/C/saveproject.page
new file mode 100644
index 0000000..5732c37
--- /dev/null
+++ b/help/C/saveproject.page
@@ -0,0 +1,32 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ xmlns:e="http://projectmallard.org/experimental/";
+ type="topic"
+ id="saveproject">
+
+ <info>
+ <link type="guide" xref="index#gettingstarted"/>
+ <link type="seealso" xref="rendering"/>
+ <revision pkgversion="0.13.4" version="0.1" date="2010-12-05" status="incomplete"/>
+ <credit type="author">
+ <name>Jean-FranÃois Fortin Tam</name>
+ <email>nekohayo gmail com</email>
+ </credit>
+ <credit type="contributor">
+ <name>Mario BlÃttermann</name>
+ <email>mariobl gnome org</email>
+ </credit>
+ <desc>
+ How to save your project for later editing use.
+ </desc>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>Saving a project</title>
+
+ <p>To save your project work, use the <guiseq><gui>File</gui><gui>Save</gui></guiseq> menu, the Save button on the main toolbar or press <keyseq><key>Ctrl</key><key>S</key></keyseq>.</p>
+ <p>When you save a project for the first time, a dialog window appears, asking you where to save the project file and how to name it.</p>
+ <p>If you want to save your project as a different file, use <guiseq><gui>File</gui><gui>Save as</gui></guiseq> or press <keyseq><key>Ctrl</key><key>Shift</key><key>S</key></keyseq>. This can be used to create different versions of your project.</p>
+<!-- TODO: document the "revert to saved" feature -->
+</page>
diff --git a/help/C/splitting.page b/help/C/splitting.page
new file mode 100644
index 0000000..4e53ca8
--- /dev/null
+++ b/help/C/splitting.page
@@ -0,0 +1,53 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ xmlns:e="http://projectmallard.org/experimental/";
+ type="topic"
+ id="splitting">
+
+ <info>
+ <link type="guide" xref="index#timeline"/>
+ <revision pkgversion="0.13.4" version="0.1" date="2010-12-05" status="complete"/>
+ <credit type="author">
+ <name>Jean-FranÃois Fortin Tam</name>
+ <email>nekohayo gmail com</email>
+ </credit>
+ <credit type="contributor">
+ <name>Mario BlÃttermann</name>
+ <email>mariobl gnome org</email>
+ </credit>
+ <desc>
+ Dividing clips in two parts.
+ </desc>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>Splitting</title>
+
+ <p>As the name implies, splitting a clip divides it into two adjacent clips, with new beginning/end points being created accordingly.</p>
+ <p>In <app>PiTiVi</app>, splitting is a ânon-modalâ operation; this means that you do not have to âactivateâ a particular tool before doing the split action. Splitting occurs where the playhead is currently located (see also <link xref="movingplayhead">Moving the playhead</link>). Combined with zooming, frame-by-frame seeking with the keyboard or scrubbing, modeless splitting is not only fast and efficient, it is also very accurate.</p>
+ <p>Selections affect splitting in the following ways:</p>
+ <list>
+ <item><p>Only the selected clips under the playhead will be split.</p></item>
+ <item><p>If no clips are selected, all the clips under the playhead will be split.</p></item>
+ </list>
+ <p>To split a single clip:</p>
+ <steps>
+ <item><p>Click on the clip.</p></item>
+ <item><p>Reposition the playhead (if needed).</p></item>
+ <item><p>Click on the <gui>Split</gui> button on the timeline toolbar or press <key>S</key>.</p></item>
+ </steps>
+ <p>To split all the clips across the all layers:</p>
+ <steps>
+ <item><p>Click on a blank area of the timeline (this will deselect all selected clips, if any).</p></item>
+ <item><p>Reposition the playhead (if needed).</p></item>
+ <item><p>Click on the <gui>Split</gui> button on the timeline toolbar or press <key>S</key>.</p></item>
+ </steps>
+ <p>To split multiple selected clips:</p>
+ <steps>
+ <item><p>Position the playhead where you want to split.</p></item>
+ <item><p>Add or remove clips to the selection with the <key>Ctrl</key> modifier key. This will not affect the playhead's position.</p></item>
+ <item><p>Click on the <gui>Split</gui> button on the timeline toolbar or press <key>S</key>.</p></item>
+ </steps>
+
+</page>
diff --git a/help/C/sysreq.page b/help/C/sysreq.page
new file mode 100644
index 0000000..1be2986
--- /dev/null
+++ b/help/C/sysreq.page
@@ -0,0 +1,32 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ xmlns:e="http://projectmallard.org/experimental/";
+ type="topic"
+ id="sysreq">
+
+ <info>
+ <link type="guide" xref="index#intro"/>
+ <link type="seealso" xref="gstreamer"/>
+ <revision pkgversion="0.13.4" version="0.1" date="2010-12-05" status="incomplete"/>
+ <credit type="author">
+ <name>Jean-FranÃois Fortin Tam</name>
+ <email>nekohayo gmail com</email>
+ </credit>
+ <credit type="contributor">
+ <name>Mario BlÃttermann</name>
+ <email>mariobl gnome org</email>
+ </credit>
+ <desc>
+ What kind of hardware is needed to do video editing?
+ </desc>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>System requirements</title>
+
+ <p>In terms of hardware, video editing typically requires a powerful computer, depending on the type of video you are editing. While the processing power of computers has increased tremendously over the years, so has demand for higher quality video.</p>
+ <p>Editing HD (High Definition) video usually requires (at the time of this writing) state of the art hardware (depending on the codec used), while SD (Standard Definition) video editing can be done on modest hardware configurations. It is up to you to make sure that your equipment is adequate. It should at least be able to playback your media in <app>Totem</app> without lagging.</p>
+ <p>It is possible, however, to use low-quality versions of your footage during editing and use the high-quality versions when rendering the final output, thus allowing to bypass hardware limitations to some extent. This is called <em>proxy editing</em>. This feature, however, is not yet available in <app>PiTiVi</app>.</p>
+
+</page>
diff --git a/help/C/trimming.page b/help/C/trimming.page
new file mode 100644
index 0000000..86223d6
--- /dev/null
+++ b/help/C/trimming.page
@@ -0,0 +1,87 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ xmlns:e="http://projectmallard.org/experimental/";
+ type="topic"
+ id="trimming">
+
+ <info>
+ <link type="guide" xref="index#timeline"/>
+ <link type="seealso" xref="splitting"/>
+ <revision pkgversion="0.13.4" version="0.1" date="2010-12-05" status="complete"/>
+ <credit type="author">
+ <name>Jean-FranÃois Fortin Tam</name>
+ <email>nekohayo gmail com</email>
+ </credit>
+ <credit type="contributor">
+ <name>Mario BlÃttermann</name>
+ <email>mariobl gnome org</email>
+ </credit>
+ <desc>
+ Shortening clips by changing the beginning and ending points. Also covers ripple and roll editing.
+ </desc>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>Trimming</title>
+
+ <p>Trimming is the act of changing the beginning or end point of a clip in the timeline.</p>
+
+ <section>
+ <title>Trimming an individual clip</title>
+ <p>Move the mouse cursor over a clip, and trimming handles will appear. Drag one of the trimming handles on the left or right edge of the clip to trim.</p>
+ <figure>
+ <media type="image" src="figures/trimming-individual.png" mime="image/png" style="right"></media>
+ </figure>
+ <p>Clips that are grouped together, such as a video clip with its associated audio clip, will trim in unison when you drag the trimming handles. To trim only the audio or only the video part, you need to ungroup them first (see the section on Grouping/linking).</p>
+ </section>
+
+ <section>
+ <title>Ripple editing</title>
+ <p>Ripple edits are a variant of basic trimming which, in addition to trimming a clip, moves the âfollowingâ clips (the clips that start after the one you're directly editing) to fill the gap.</p>
+ <note>
+ <p>The ripple applies to all âfollowingâ clips, regardless of whether or not they are on the same layer.</p>
+ </note>
+ <p>Before:</p>
+ <figure>
+ <media type="image" src="figures/ripple-before.png" mime="image/png" style="right"></media>
+ </figure>
+ <p>After:</p>
+ <figure>
+ <media type="image" src="figures/ripple-after.png" mime="image/png" style="right"></media>
+ </figure>
+ <p>To do a ripple edit:
+ </p>
+ <steps>
+ <item><p>Place the mouse cursor on a trimming handle between two adjacent clips.</p></item>
+ <item><p>Press and hold <key>Shift</key>.</p></item>
+ <item><p>Drag the trimming handle.</p></item>
+ </steps>
+ <p>Ripple editing can also be used when moving clips around in the timeline. For detailed explanations on how to do this, see the section <link xref="rippleusingclips">Using ripple editing while moving clips</link>.</p>
+ </section>
+
+ <section>
+ <title>Roll editing</title>
+ <p>Roll edits are a variant of basic trimming which, in addition to trimming a clip, <em>trims</em> the adjacent clips to prevent creating gaps.</p>
+ <note>
+ <p>The roll applies to all temporally adjacent clips, regardless of whether or not they are on the same layer.</p>
+ </note>
+ <p>Before:</p>
+ <figure>
+ <media type="image" src="figures/roll-before.png" mime="image/png" style="right"></media>
+ </figure>
+ <p>After:</p>
+ <figure>
+ <media type="image" src="figures/roll-after.png" mime="image/png" style="right"></media>
+ </figure>
+ <p>To do a roll edit:</p>
+ <steps>
+ <item><p>Place the mouse cursor on a trimming handle between two adjacent clips.</p></item>
+ <item><p>Press and hold <key>Ctrl</key>.</p></item>
+ <item><p>Drag the trimming handle.</p></item>
+ </steps>
+ </section>
+
+
+
+</page>
diff --git a/help/C/usingclips.page b/help/C/usingclips.page
new file mode 100644
index 0000000..b53da3f
--- /dev/null
+++ b/help/C/usingclips.page
@@ -0,0 +1,53 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ xmlns:e="http://projectmallard.org/experimental/";
+ type="topic"
+ id="usingclips">
+
+ <info>
+ <link type="guide" xref="index#gettingstarted"/>
+ <revision pkgversion="0.13.4" version="0.1" date="2010-12-05" status="complete"/>
+ <credit type="author">
+ <name>Jean-FranÃois Fortin Tam</name>
+ <email>nekohayo gmail com</email>
+ </credit>
+ <credit type="contributor">
+ <name>Mario BlÃttermann</name>
+ <email>mariobl gnome org</email>
+ </credit>
+ <desc>
+ Learn the difference between clips and files and how to do basic operations on clips in the timeline.
+ </desc>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>Using clips</title>
+
+ <section>
+ <title>Clips vs files</title>
+ <list>
+ <item><p><em>Files</em> are data on your hard disk (videos, music, pictures, etc.) that can be accessed by <app>PiTiVi</app> and incorporated in your video editing project.</p></item>
+ <item><p><em>Clips</em> are a visual representation of your files on the timeline. They represent the period of time they consume on the timeline and can be edited independently: each time you drag a file from the source list to the timeline, a new clip is created. As such, a file can be reused as much as you want to create any amount of different clips.</p></item>
+ </list>
+ <p>Since PiTiVi is a non-destructive editor, clips are edited, not files. As such, your files stay intact.</p>
+ </section>
+
+ <section>
+ <title>Moving clips along the timeline</title>
+ <p>You can move a clip within a layer or move it to a different layer.</p>
+ <p>Click and drag a single clip to move it, and release the mouse button to place it. Dragging horizontally keeps the clip on the same layer, but dragging it vertically moves the clip to a different layer.</p>
+ <p>To move multiple clips at the same time, use the <key>Ctrl</key> or <key>Shift</key> keys to select multiple clips. Selected clips do not need to be on the same layer. Then, drag the clips just as you would do for a single clip; their position relative to each other will be preserved.</p>
+ <section>
+ <title>Using ripple editing while moving clips</title>
+ <p>While dragging clips around in the timeline, you can use the <link xref="rippletechnique">ripple technique</link> to move the <em>following</em> clips (the clips that start after the one you're directly editing) to fill the gap.</p>
+ <steps>
+ <item><p>Click and drag the clip you want to move, with the mouse button held down</p></item>
+ <item><p>During the drag, hold down <key>Shift</key> on the keyboard</p></item>
+ <item><p>Release the mouse button to end the drag operation, then release the <key>Shift</key> key.</p></item>
+ </steps>
+ <p>During the drag operation, if you changed your mind and only want to drag one clip at a time, just release the <key>Shift</key> key before you release the mouse button.</p>
+ </section>
+ </section>
+
+</page>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
