[pitivi] help: Format the page files for consistent indentation
- From: Alexandru Băluț <alexbalut src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [pitivi] help: Format the page files for consistent indentation
- Date: Sun, 12 Jun 2016 23:37:34 +0000 (UTC)
commit 64689bf7cd5c79f832e2dc115b51ee694018ae00
Author: Alexandru Băluț <alexandru balut gmail com>
Date: Sun Jun 5 18:46:06 2016 +0200
help: Format the page files for consistent indentation
xmllint --format --encode utf8 $i
Differential Revision: https://phabricator.freedesktop.org/D1061
help/C/about.page | 26 ++---
help/C/cheatsheet.page | 130 +++++++++++++--------
help/C/codecscontainers.page | 24 ++---
help/C/effects.page | 66 ++++++-----
help/C/gstreamer.page | 81 ++++++-------
help/C/importing.page | 75 ++++++-------
help/C/importingmpegts.page | 17 +--
help/C/index.page | 23 +---
help/C/keyframecurves.page | 78 +++++++------
help/C/layers.page | 69 +++++-------
help/C/license.page | 29 +++--
help/C/mainwindow.page | 246 ++++++++++++++++++++++------------------
help/C/medialibrary.page | 114 ++++++++++---------
help/C/movearoundtimeline.page | 139 ++++++++++++-----------
help/C/presets.page | 73 +++++++-----
help/C/rendering.page | 58 +++++----
help/C/savescreenshot.page | 16 +--
help/C/selectiongrouping.page | 101 +++++++++--------
help/C/splitting.page | 60 +++++-----
help/C/sysreq.page | 46 ++++----
help/C/transitions.page | 118 ++++++++++---------
help/C/trimming.page | 146 ++++++++++++------------
help/C/usingclips.page | 98 ++++++++--------
help/C/usingeffects.page | 45 ++++----
help/C/welcomedialog.page | 40 ++++---
help/C/workwithprojects.page | 67 +++++------
26 files changed, 1028 insertions(+), 957 deletions(-)
---
diff --git a/help/C/about.page b/help/C/about.page
index 113b605..da288e3 100644
--- a/help/C/about.page
+++ b/help/C/about.page
@@ -1,8 +1,5 @@
-<page xmlns="http://projectmallard.org/1.0/"
- xmlns:e="http://projectmallard.org/experimental/"
- type="topic"
- id="about">
-
+<?xml version="1.0" encoding="UTF-8"?>
+<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.96" version="0.3" date="2016-02-17" status="complete"/>
@@ -21,18 +18,15 @@
<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 id="wip">
+ <p>This user manual is written and maintained by Jean-François Fortin Tam.</p>
+ <section id="wip">
<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 id="patches">
+ <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 id="patches">
<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://phabricator.freedesktop.org/maniphest/task/create/?projects=pitivi,pitivi_documentation">file
bugs in our bug tracker</link>.</p>
- </section>
-
+ <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://phabricator.freedesktop.org/maniphest/task/create/?projects=pitivi,pitivi_documentation">file
bugs in our bug tracker</link>.</p>
+ </section>
</page>
diff --git a/help/C/cheatsheet.page b/help/C/cheatsheet.page
index b1cca91..6b67a00 100644
--- a/help/C/cheatsheet.page
+++ b/help/C/cheatsheet.page
@@ -1,8 +1,5 @@
-<page xmlns="http://projectmallard.org/1.0/"
- xmlns:e="http://projectmallard.org/experimental/"
- type="topic"
- id="cheatsheet">
-
+<?xml version="1.0" encoding="UTF-8"?>
+<page xmlns="http://projectmallard.org/1.0/" xmlns:e="http://projectmallard.org/experimental/" type="topic"
id="cheatsheet">
<info>
<link type="topic" xref="index"/>
<link type="seealso" xref="movearoundtimeline"/>
@@ -15,48 +12,83 @@
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
-
- <title>Keyboard shortcuts and cheatsheet</title>
-
- <p>This page is a list of important shortcuts to access commonly used or hidden features. Take the time
to get familiar with them as they will improve your productivity tremendously.</p>
-
- <section id="general">
- <title>General</title>
- <list>
- <item><p><keyseq><key>Ctrl</key><key>N</key></keyseq>: Create a new project</p></item>
- <item><p><keyseq><key>Ctrl</key><key>O</key></keyseq>: Open a project file</p></item>
- <item><p><keyseq><key>Ctrl</key><key>S</key></keyseq>: Save the current project</p></item>
- <item><p><keyseq><key>Ctrl</key><key>Q</key></keyseq>: Quit the application</p></item>
- <item><p><keyseq><key>Ctrl</key><key>Z</key></keyseq>: Undo</p></item>
- <item><p><keyseq><key>Ctrl</key><key>Shift</key><key>Z</key></keyseq>: Redo</p></item>
- <item><p><key>F11</key>: Toggle fullscreen mode</p></item>
- <item><p><key>F1</key>: Show the user manual</p></item>
- </list>
- </section>
-
- <section id="medialibrary">
- <title>Media Library</title>
- <list>
- <item><p><key>Enter</key>: Preview (playback) the selected clip</p></item>
- <item><p><key>Insert</key>: Insert the selected clips into the timeline</p></item>
- <item><p><keyseq><key>Ctrl</key><key>Delete</key></keyseq>: Remove the selected clips from the
project</p></item>
- </list>
- </section>
-
- <section id="timeline">
- <title>Timeline</title>
- <list>
- <item><p><key>Spacebar</key>: Toggle playback.</p></item>
- <item><p><key>S</key>: Split the clips at the current playhead position. If there are selected
clips, only those will be split.</p></item>
- <item><p><key>Delete</key>: Remove selected clips from the timeline.</p></item>
- <item><p><key>←</key> and <key>→</key>: Seek one frame backwards or forwards. This depends on your
project framerate.</p></item>
- <item><p><keyseq><key>Shift</key><key>←</key></keyseq> and
<keyseq><key>Shift</key><key>→</key></keyseq>: Seek one second backwards or forwards.</p></item>
- <item><p><keyseq><key>Ctrl</key><key>+</key></keyseq> and
<keyseq><key>Ctrl</key><key>-</key></keyseq>: Zoom in or zoom out. You can also use <key>Ctrl</key> with the
mouse wheel to control the zoom more efficiently.</p></item>
- <item><p><keyseq><key>Ctrl</key><key>0</key></keyseq>: Adjust the zoom to fit the
timeline.</p></item>
- <item><p><key>Shift</key>+drag: Ripple edit.</p></item>
- <item><p><key>Ctrl</key>+drag: Roll edit.</p></item>
- <!--item><p><key>K</key>: Add a property keyframe at the current playhead position.</p></item-->
- <!--item><p><key>.</key> and <key>,</key>: Go to the next or previous property
keyframe.</p></item-->
- </list>
- </section>
+ <title>Keyboard shortcuts and cheatsheet</title>
+ <p>This page is a list of important shortcuts to access commonly used or hidden features. Take the time to
get familiar with them as they will improve your productivity tremendously.</p>
+ <section id="general">
+ <title>General</title>
+ <list>
+ <item>
+ <p><keyseq><key>Ctrl</key><key>N</key></keyseq>: Create a new project</p>
+ </item>
+ <item>
+ <p><keyseq><key>Ctrl</key><key>O</key></keyseq>: Open a project file</p>
+ </item>
+ <item>
+ <p><keyseq><key>Ctrl</key><key>S</key></keyseq>: Save the current project</p>
+ </item>
+ <item>
+ <p><keyseq><key>Ctrl</key><key>Q</key></keyseq>: Quit the application</p>
+ </item>
+ <item>
+ <p><keyseq><key>Ctrl</key><key>Z</key></keyseq>: Undo</p>
+ </item>
+ <item>
+ <p><keyseq><key>Ctrl</key><key>Shift</key><key>Z</key></keyseq>: Redo</p>
+ </item>
+ <item>
+ <p><key>F11</key>: Toggle fullscreen mode</p>
+ </item>
+ <item>
+ <p><key>F1</key>: Show the user manual</p>
+ </item>
+ </list>
+ </section>
+ <section id="medialibrary">
+ <title>Media Library</title>
+ <list>
+ <item>
+ <p><key>Enter</key>: Preview (playback) the selected clip</p>
+ </item>
+ <item>
+ <p><key>Insert</key>: Insert the selected clips into the timeline</p>
+ </item>
+ <item>
+ <p><keyseq><key>Ctrl</key><key>Delete</key></keyseq>: Remove the selected clips from the project</p>
+ </item>
+ </list>
+ </section>
+ <section id="timeline">
+ <title>Timeline</title>
+ <list>
+ <item>
+ <p><key>Spacebar</key>: Toggle playback.</p>
+ </item>
+ <item>
+ <p><key>S</key>: Split the clips at the current playhead position. If there are selected clips, only
those will be split.</p>
+ </item>
+ <item>
+ <p><key>Delete</key>: Remove selected clips from the timeline.</p>
+ </item>
+ <item>
+ <p><key>←</key> and <key>→</key>: Seek one frame backwards or forwards. This depends on your project
framerate.</p>
+ </item>
+ <item>
+ <p><keyseq><key>Shift</key><key>←</key></keyseq> and <keyseq><key>Shift</key><key>→</key></keyseq>:
Seek one second backwards or forwards.</p>
+ </item>
+ <item>
+ <p><keyseq><key>Ctrl</key><key>+</key></keyseq> and <keyseq><key>Ctrl</key><key>-</key></keyseq>:
Zoom in or zoom out. You can also use <key>Ctrl</key> with the mouse wheel to control the zoom more
efficiently.</p>
+ </item>
+ <item>
+ <p><keyseq><key>Ctrl</key><key>0</key></keyseq>: Adjust the zoom to fit the timeline.</p>
+ </item>
+ <item>
+ <p><key>Shift</key>+drag: Ripple edit.</p>
+ </item>
+ <item>
+ <p><key>Ctrl</key>+drag: Roll edit.</p>
+ </item>
+ <!--item><p><key>K</key>: Add a property keyframe at the current playhead position.</p></item-->
+ <!--item><p><key>.</key> and <key>,</key>: Go to the next or previous property keyframe.</p></item-->
+ </list>
+ </section>
</page>
diff --git a/help/C/codecscontainers.page b/help/C/codecscontainers.page
index 16cb8bd..a3db748 100644
--- a/help/C/codecscontainers.page
+++ b/help/C/codecscontainers.page
@@ -1,8 +1,5 @@
-<page xmlns="http://projectmallard.org/1.0/"
- xmlns:e="http://projectmallard.org/experimental/"
- type="topic"
- id="codecscontainers">
-
+<?xml version="1.0" encoding="UTF-8"?>
+<page xmlns="http://projectmallard.org/1.0/" xmlns:e="http://projectmallard.org/experimental/" type="topic"
id="codecscontainers">
<info>
<link type="guide" xref="index#rendering"/>
<revision pkgversion="0.93" version="0.1" date="2014-04-06" status="complete"/>
@@ -19,13 +16,12 @@
</license>
<desc>What is the difference between OGG and Vorbis? AVI and DivX? x264 and H.264? Learn about codecs
and container formats here.</desc>
</info>
-
- <title>Understanding codecs and containers</title>
- <p>The distinction between codecs and container file formats is often ambiguous. This is in part due to
the general lack of standardization, confusing marketing terms and filename extensions. This page attempts to
clarify this distinction briefly and without going into technical details. If you want to learn more about
containers and codecs, you should probably look at Wikipedia's page on <link
href="http://en.wikipedia.org/wiki/Digital_container_format">containers</link> and <link
href="http://en.wikipedia.org/wiki/Codec">codecs</link>.</p>
- <p><em>Container</em> is what we typically associate with the file format. Containers "contain" the
various components of a video: the stream of images, the sound, and anything else. For example, you could
have multiple soundtracks and subtitles included in a video file, if the container format allows it. Example
of popular containers are OGG, Matroska, AVI, MPEG.</p>
- <p><em>Codecs</em> are ways of "coding" and "decoding" streams. Their job is typically to compress data
(and decompress it when playing it back) so that you can store and transmit files with a smaller filesize.
There are many codecs available out there, each with their strengths, weaknesses and peculiarities, and
choosing the right codec with the right settings for the right situation is close to be a form of art in
itself.</p>
- <figure>
- <title>The relationship between containers and codecs</title>
- <media type="image" mime="image/jpg" src="figures/codecscontainers.jpg" width="780"/>
- </figure>
+ <title>Understanding codecs and containers</title>
+ <p>The distinction between codecs and container file formats is often ambiguous. This is in part due to
the general lack of standardization, confusing marketing terms and filename extensions. This page attempts to
clarify this distinction briefly and without going into technical details. If you want to learn more about
containers and codecs, you should probably look at Wikipedia's page on <link
href="http://en.wikipedia.org/wiki/Digital_container_format">containers</link> and <link
href="http://en.wikipedia.org/wiki/Codec">codecs</link>.</p>
+ <p><em>Container</em> is what we typically associate with the file format. Containers "contain" the
various components of a video: the stream of images, the sound, and anything else. For example, you could
have multiple soundtracks and subtitles included in a video file, if the container format allows it. Example
of popular containers are OGG, Matroska, AVI, MPEG.</p>
+ <p><em>Codecs</em> are ways of "coding" and "decoding" streams. Their job is typically to compress data
(and decompress it when playing it back) so that you can store and transmit files with a smaller filesize.
There are many codecs available out there, each with their strengths, weaknesses and peculiarities, and
choosing the right codec with the right settings for the right situation is close to be a form of art in
itself.</p>
+ <figure>
+ <title>The relationship between containers and codecs</title>
+ <media type="image" mime="image/jpg" src="figures/codecscontainers.jpg" width="780"/>
+ </figure>
</page>
diff --git a/help/C/effects.page b/help/C/effects.page
index 96860c9..5d9a66c 100644
--- a/help/C/effects.page
+++ b/help/C/effects.page
@@ -1,8 +1,5 @@
-<page xmlns="http://projectmallard.org/1.0/"
- xmlns:e="http://projectmallard.org/experimental/"
- type="topic"
- id="effects">
-
+<?xml version="1.0" encoding="UTF-8"?>
+<page xmlns="http://projectmallard.org/1.0/" xmlns:e="http://projectmallard.org/experimental/" type="topic"
id="effects">
<info>
<link type="guide" xref="index#effectstransitions"/>
<link type="seealso" xref="gstreamer"/>
@@ -18,30 +15,37 @@
<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.
Available effects depend on the software installed on your computer. If you don't see anything (or only a
handful of effects) in the effect library, make sure that the <app>gnome-video-effects</app> package is
installed on your system. Alternatively, you can look for packages containing GStreamer or frei0r effect
plugins that are available in the repositories of your distribution.</p>
- <note>
- <p>Effects are non-destructive: they are only applied to the resulting rendered movie and do not
affect your source files.</p>
- </note>
-
- <section id="adding">
- <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>Double-click an effect in the effect library</p></item>
- </steps>
- <p>To remove an effect:</p>
- <steps>
- <item><p>Select an existing clip on the timeline</p></item>
- <item><p>Select the effect you want to remove in the <guiseq><gui>middle pane</gui><gui>Clip
configuration</gui> <gui>Effects</gui></guiseq></p></item>
- <item><p>Click the <gui>Remove effect</gui> button</p></item>
- </steps>
- </section>
- <section id="toggling">
- <title>Toggling effects</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 <guiseq><gui>middle pane</gui><gui>Clip
configuration</gui> <gui>Effects</gui></guiseq>.</p>
- </section>
+ <title>Introduction to effects</title>
+ <p><app>Pitivi</app> offers a wide variety of video and audio effects to spice up your movies. Available
effects depend on the software installed on your computer. If you don't see anything (or only a handful of
effects) in the effect library, make sure that the <app>gnome-video-effects</app> package is installed on
your system. Alternatively, you can look for packages containing GStreamer or frei0r effect plugins that are
available in the repositories of your distribution.</p>
+ <note>
+ <p>Effects are non-destructive: they are only applied to the resulting rendered movie and do not affect
your source files.</p>
+ </note>
+ <section id="adding">
+ <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>Double-click an effect in the effect library</p>
+ </item>
+ </steps>
+ <p>To remove an effect:</p>
+ <steps>
+ <item>
+ <p>Select an existing clip on the timeline</p>
+ </item>
+ <item>
+ <p>Select the effect you want to remove in the <guiseq><gui>middle pane</gui><gui>Clip
configuration</gui><gui>Effects</gui></guiseq></p>
+ </item>
+ <item>
+ <p>Click the <gui>Remove effect</gui> button</p>
+ </item>
+ </steps>
+ </section>
+ <section id="toggling">
+ <title>Toggling effects</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 <guiseq><gui>middle pane</gui><gui>Clip
configuration</gui><gui>Effects</gui></guiseq>.</p>
+ </section>
</page>
diff --git a/help/C/gstreamer.page b/help/C/gstreamer.page
index ed2ba49..ec61dc4 100644
--- a/help/C/gstreamer.page
+++ b/help/C/gstreamer.page
@@ -1,8 +1,5 @@
-<page xmlns="http://projectmallard.org/1.0/"
- xmlns:e="http://projectmallard.org/experimental/"
- type="topic"
- id="gstreamer">
-
+<?xml version="1.0" encoding="UTF-8"?>
+<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.93" version="0.2" date="2014-04-06" status="complete"/>
@@ -23,49 +20,47 @@
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
-
- <title>Gstreamer and compatibility</title>
-
- <p>A great strength of <app>Pitivi</app> lies in the fact that it uses 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>For <app>Pitivi</app> users, this essentially means two things:</p>
- <list>
+ <title>Gstreamer and compatibility</title>
+ <p>A great strength of <app>Pitivi</app> lies in the fact that it uses 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>For <app>Pitivi</app> users, this essentially means two things:</p>
+ <list>
+ <item>
+ <p>You can, in theory, import pretty much any media file supported by <app>GStreamer</app> (see the
sections below for more details).</p>
+ </item>
+ <item>
+ <p>You can render your projects using any supported container and codec combination from
<app>GStreamer</app>.</p>
+ </item>
+ </list>
+ <note style="tip">
+ <p>To maximize <app>Pitivi</app>'s capabilities and reduce the possibilities of bugs, a very recent
version of <app>GStreamer</app> is recommended. This is because <app>Pitivi</app> developers work hard on
fixing problems directly in <app>GStreamer</app> instead of putting temporary workarounds inside
<app>Pitivi</app>.</p>
+ </note>
+ <section id="friendlycodecs">
+ <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 id="goodbadugly">
+ <title>The Good, the Bad and the Ugly</title>
+ <p><app>GStreamer</app> plugins come into three categories: good, bad and ugly. You may need to install
plugins from any category 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. An overview of gstreamer
plugins and their classification into categories can be found on the <link
href="http://gstreamer.freedesktop.org/documentation/plugins.html">Gstreamer website</link>.</p>
+ <list>
<item>
- <p>You can, in theory, import pretty much any media file supported by <app>GStreamer</app> (see the
sections below for more details).</p>
+ <p>The "Good" plugins are high quality plugins under the LGPL license. These plugins are considered
safe and recommended at any time. To install them, search for packages containing gstreamer plugins good in
your distribution's repositories.</p>
</item>
<item>
- <p>You can render your projects using any supported container and codec combination from
<app>GStreamer</app>.</p>
+ <p>The "Bad" plugins are plugins whose code quality is not good enough, or are not considered tested
well enough. The licensing may or may not be LGPL. To install them, search for packages containing gstreamer
plugins bad in your distribution's repositories.</p>
</item>
- </list>
- <note style="tip">
- <p>To maximize <app>Pitivi</app>'s capabilities and reduce the possibilities of bugs, a very recent
version of <app>GStreamer</app> is recommended. This is because <app>Pitivi</app> developers work hard on
fixing problems directly in <app>GStreamer</app> instead of putting temporary workarounds inside
<app>Pitivi</app>.</p>
- </note>
-
- <section id="friendlycodecs">
- <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 id="goodbadugly">
- <title>The Good, the Bad and the Ugly</title>
- <p><app>GStreamer</app> plugins come into three categories: good, bad and ugly. You may need to
install plugins from any category 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. An overview of
gstreamer plugins and their classification into categories can be found on the <link
href="http://gstreamer.freedesktop.org/documentation/plugins.html">Gstreamer website</link>.</p>
- <list>
- <item><p>The "Good" plugins are high quality plugins under the LGPL license. These plugins are
considered safe and recommended at any time. To install them, search for packages containing gstreamer
plugins good in your distribution's repositories.</p></item>
- <item><p>The "Bad" plugins are plugins whose code quality is not good enough, or are not
considered tested well enough. The licensing may or may not be LGPL. To install them, search for packages
containing gstreamer plugins bad in your distribution's repositories.</p></item>
- <item><p>The "Ugly" plugins are good quality plugins whose license is not LGPL or with licensing
issues. To install them, search for packages containing containing gstreamer plugins ugly in your
distribution's repositories.</p></item>
- </list>
- <note style="tip">
+ <item>
+ <p>The "Ugly" plugins are good quality plugins whose license is not LGPL or with licensing issues.
To install them, search for packages containing containing gstreamer plugins ugly in your distribution's
repositories.</p>
+ </item>
+ </list>
+ <note style="tip">
<p>In addition to the Good, Bad and Ugly plugins, you may want to install the
<em>gstreamer-ffmpeg</em> package to have access to ffmpeg's set of codecs.</p>
- </note>
- <p></p>
- </section>
-
- <section id="imageformats">
- <title>Image file formats</title>
- <p>While it is not feasible to list every possible combination of supported video or audio formats,
it is however possible to list the static image formats that can be imported: JPEG, PNG, JPEG 2000, PNM and
SVG.</p>
- <!-- Note: this is obtained by doing:
+ </note>
+ </section>
+ <section id="imageformats">
+ <title>Image file formats</title>
+ <p>While it is not feasible to list every possible combination of supported video or audio formats, it
is however possible to list the static image formats that can be imported: JPEG, PNG, JPEG 2000, PNM and
SVG.</p>
+ <!-- Note: this is obtained by doing:
gst-inspect -a | grep Decoder/Image | cut -d : -f1 | sed -e s/dec$//g
-->
- </section>
-
-
+ </section>
</page>
diff --git a/help/C/importing.page b/help/C/importing.page
index 43b8a0c..d39d7b0 100644
--- a/help/C/importing.page
+++ b/help/C/importing.page
@@ -1,8 +1,5 @@
-<page xmlns="http://projectmallard.org/1.0/"
- xmlns:e="http://projectmallard.org/experimental/"
- type="topic"
- id="importing">
-
+<?xml version="1.0" encoding="UTF-8"?>
+<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.96" version="0.5" date="2016-02-17" status="complete"/>
@@ -23,40 +20,36 @@
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
-
- <title>Getting media</title>
-
- <p>Pitivi allows importing media files from your computer's hard drive.</p>
- <note>
- <p>When you create a new project and import the first video file, its properties are transposed to
the <link xref="workwithprojects#projectsettings">project settings</link>, unless you changed them yourself
already. An infobar appears when this happens. Click the <gui>Project Settings</gui> button in the infobar
for details.</p>
- </note>
- <note>
- <p>Due to our limited resources and the rapid evolution of filmmaking hardware in the past few
years, and to ensure <app>Pitivi</app> remains robust and simple to use, we do not attempt to support every
possible hardware device out there. As a result, you currently cannot use <app>Pitivi</app> to capture
directly from a camcorder; specialized applications are better suited for this task. For example, for DV/HDV
camcorders using an IEEE 1394 connection, you may use <app>Kino</app> or <app>dvgrab</app> to capture
footage.</p>
- </note>
-
- <section id="filechooser">
- <title>Importing files 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 <gui>Import</gui>
button in the <gui>Media Library</gui> header.</p>
- <p>A file chooser dialog window will appear. You can press <key>Ctrl</key> or <key>Shift</key> to
select multiple files at the same time.</p>
- </section>
- <section id="dragdrop">
- <title>Importing files 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 multiple 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>
-
+ <title>Getting media</title>
+ <p>Pitivi allows importing media files from your computer's hard drive.</p>
+ <note>
+ <p>When you create a new project and import the first video file, its properties are transposed to the
<link xref="workwithprojects#projectsettings">project settings</link>, unless you changed them yourself
already. An infobar appears when this happens. Click the <gui>Project Settings</gui> button in the infobar
for details.</p>
+ </note>
+ <note>
+ <p>Due to our limited resources and the rapid evolution of filmmaking hardware in the past few years,
and to ensure <app>Pitivi</app> remains robust and simple to use, we do not attempt to support every possible
hardware device out there. As a result, you currently cannot use <app>Pitivi</app> to capture directly from a
camcorder; specialized applications are better suited for this task. For example, for DV/HDV camcorders using
an IEEE 1394 connection, you may use <app>Kino</app> or <app>dvgrab</app> to capture footage.</p>
+ </note>
+ <section id="filechooser">
+ <title>Importing files 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 <gui>Import</gui> button
in the <gui>Media Library</gui> header.</p>
+ <p>A file chooser dialog window will appear. You can press <key>Ctrl</key> or <key>Shift</key> to select
multiple files at the same time.</p>
+ </section>
+ <section id="dragdrop">
+ <title>Importing files 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 multiple 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>
</page>
diff --git a/help/C/importingmpegts.page b/help/C/importingmpegts.page
index 63784a0..1ba38bb 100644
--- a/help/C/importingmpegts.page
+++ b/help/C/importingmpegts.page
@@ -1,8 +1,5 @@
-<page xmlns="http://projectmallard.org/1.0/"
- xmlns:e="http://projectmallard.org/experimental/"
- type="topic"
- id="importingmpegts">
-
+<?xml version="1.0" encoding="UTF-8"?>
+<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"/>
@@ -18,10 +15,8 @@
<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>
-
+ <!-- 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
index 7c17df6..0dff9ce 100644
--- a/help/C/index.page
+++ b/help/C/index.page
@@ -1,8 +1,5 @@
-<page xmlns="http://projectmallard.org/1.0/"
- xmlns:e="http://projectmallard.org/experimental/"
- type="guide"
- id="index">
-
+<?xml version="1.0" encoding="UTF-8"?>
+<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>
@@ -19,34 +16,24 @@
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
-
- <title>
- <media type="image" mime="image/png" src="figures/logo.png">Pitivi logo</media>
+ <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>
-
+ <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="effectstransitions" style="2column">
<title>Effects and Transitions</title>
</section>
-
<section id="rendering" style="2column">
<title>Exporting Your Finished Movie</title>
</section>
-
-
</page>
diff --git a/help/C/keyframecurves.page b/help/C/keyframecurves.page
index e50ea48..18a6194 100644
--- a/help/C/keyframecurves.page
+++ b/help/C/keyframecurves.page
@@ -1,8 +1,5 @@
-<page xmlns="http://projectmallard.org/1.0/"
- xmlns:e="http://projectmallard.org/experimental/"
- type="topic"
- id="keyframecurves">
-
+<?xml version="1.0" encoding="UTF-8"?>
+<page xmlns="http://projectmallard.org/1.0/" xmlns:e="http://projectmallard.org/experimental/" type="topic"
id="keyframecurves">
<info>
<link type="guide" xref="index#timeline"/>
<link type="seealso" xref="usingeffects"/>
@@ -31,35 +28,46 @@
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
-
+ <title>Keyframe curves</title>
+ <p>By using keyframe curves, you can change the value of a property over time, instead of having a fixed
value for the entire duration of a clip. This can be used to change opacity or volume just as well as effect
properties at any point in the clip's duration.</p>
+ <figure>
<title>Keyframe curves</title>
-
- <p>By using keyframe curves, you can change the value of a property over time, instead of having a
fixed value for the entire duration of a clip. This can be used to change opacity or volume just as well as
effect properties at any point in the clip's duration.</p>
- <figure>
- <title>Keyframe curves</title>
- <media type="image" src="figures/keyframecurves.png" mime="image/png" style="right"></media>
- </figure>
- <p>A terminological note:</p>
- <list>
- <item><p><em>Keyframes</em> are the points that are used to determine the property value at a
specific point in time.</p></item>
- <item><p><em>Keyframe curves</em> are the lines connecting the points providing smooth transitions
between them.</p></item>
- </list>
- <p>By default, the keyframe curves on an audio clip control the volume (on a scale from 0 to 200%) and
the keyframe curves on a video clip control the alpha (opacity) of the video (on a scale from 0 to 100%). See
the <link xref="layers">Understanding layers</link> page for more details on opacity. The default alpha or
volume keyframe curves are an intrinsic property of clips and cannot be removed.</p>
- <note style="tip"><p>You can create fade-in and fade-out transitions by controlling opacity and volume.
See an example in the <link xref="transitions#fades">Transitions</link> page.</p></note>
- <p>Besides volume and alpha, you can use keyframes to control effect properties. See the <link
xref="usingeffects#keyframes">Using effects</link> page for details.</p>
-
- <section id="usage">
- <title>General usage</title>
- <p>The start and end keyframes are fixed to the start and end points of the clip and cannot be
removed. The curve between these two keyframes is initially a flat horizontal line, indicating that the value
of the controlled property is the same at each point in time within the clip's duration. To change the value
(and the rate of its change) at any point, you can add one or more keyframes to the clip and drag them to
appropriate vertical positions representing their values.</p>
- <p>You can:</p>
- <list>
- <item><p>Add a new keyframe by clicking on the line.</p></item>
- <item><p>Remove a keyframe by double-clicking on it.</p></item>
- <item><p>Adjust the time and value of a keyframe by moving it with the mouse.</p></item>
- <item><p>Click-and-drag on a segment of a curve between two keyframes to adjust the vertical position
of the segment.</p></item>
- </list>
- <note>
- <p>Currently only linear keyframe curves are supported.</p>
- </note>
- </section>
+ <media type="image" src="figures/keyframecurves.png" mime="image/png" style="right"/>
+ </figure>
+ <p>A terminological note:</p>
+ <list>
+ <item>
+ <p><em>Keyframes</em> are the points that are used to determine the property value at a specific point
in time.</p>
+ </item>
+ <item>
+ <p><em>Keyframe curves</em> are the lines connecting the points providing smooth transitions between
them.</p>
+ </item>
+ </list>
+ <p>By default, the keyframe curves on an audio clip control the volume (on a scale from 0 to 200%) and the
keyframe curves on a video clip control the alpha (opacity) of the video (on a scale from 0 to 100%). See the
<link xref="layers">Understanding layers</link> page for more details on opacity. The default alpha or volume
keyframe curves are an intrinsic property of clips and cannot be removed.</p>
+ <note style="tip">
+ <p>You can create fade-in and fade-out transitions by controlling opacity and volume. See an example in
the <link xref="transitions#fades">Transitions</link> page.</p>
+ </note>
+ <p>Besides volume and alpha, you can use keyframes to control effect properties. See the <link
xref="usingeffects#keyframes">Using effects</link> page for details.</p>
+ <section id="usage">
+ <title>General usage</title>
+ <p>The start and end keyframes are fixed to the start and end points of the clip and cannot be removed.
The curve between these two keyframes is initially a flat horizontal line, indicating that the value of the
controlled property is the same at each point in time within the clip's duration. To change the value (and
the rate of its change) at any point, you can add one or more keyframes to the clip and drag them to
appropriate vertical positions representing their values.</p>
+ <p>You can:</p>
+ <list>
+ <item>
+ <p>Add a new keyframe by clicking on the line.</p>
+ </item>
+ <item>
+ <p>Remove a keyframe by double-clicking on it.</p>
+ </item>
+ <item>
+ <p>Adjust the time and value of a keyframe by moving it with the mouse.</p>
+ </item>
+ <item>
+ <p>Click-and-drag on a segment of a curve between two keyframes to adjust the vertical position of
the segment.</p>
+ </item>
+ </list>
+ <note>
+ <p>Currently only linear keyframe curves are supported.</p>
+ </note>
+ </section>
</page>
diff --git a/help/C/layers.page b/help/C/layers.page
index 8a8fb1c..6748b75 100644
--- a/help/C/layers.page
+++ b/help/C/layers.page
@@ -1,8 +1,5 @@
-<page xmlns="http://projectmallard.org/1.0/"
- xmlns:e="http://projectmallard.org/experimental/"
- type="topic"
- id="layers">
-
+<?xml version="1.0" encoding="UTF-8"?>
+<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.96" version="0.2" date="2016-02-17" status="complete"/>
@@ -23,39 +20,31 @@
<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. 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 id="opacity">
- <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 id="ui">
- <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>
- <figure>
- <desc>Diagram illustrating the <em>pieces of glass</em> (left) and how they are show as
<em>layers</em> in <app>Pitivi</app>'s user interface (right).</desc>
- <media type="image" src="figures/layers.png" mime="image/png" width="720" height="217"/>
- </figure>
- <note>
- <p>Clips located on a layer above will block the clips below from view, unless they have an opacity
value lower than 100% (as shown with the two topmost layers in the previous illustration).</p>
- </note>
- </section>
-
- <section id="adding">
- <title>Adding and removing layers</title>
- <p>To create a layer, drag a clip to the middle space between two existing layers or just above the
top layer or just below the bottom layer. Once the thin space between the layers is highlighted, release the
clip.</p>
- <p>To remove a layer, click <guiseq><gui>Layer icon</gui><gui>Delete layer</gui></guiseq>. The
<gui>Layer icon</gui> can be found at the right of the layer name field.</p>
- </section>
-
- <section id="audio">
- <title>What about audio layers?</title>
- <p>Unlike in vision, multiple sounds do not “block” each other. 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>
-
-
+ <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. 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 id="opacity">
+ <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 id="ui">
+ <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>
+ <figure>
+ <desc>Diagram illustrating the <em>pieces of glass</em> (left) and how they are show as
<em>layers</em> in <app>Pitivi</app>'s user interface (right).</desc>
+ <media type="image" src="figures/layers.png" mime="image/png" width="720" height="217"/>
+ </figure>
+ <note>
+ <p>Clips located on a layer above will block the clips below from view, unless they have an opacity
value lower than 100% (as shown with the two topmost layers in the previous illustration).</p>
+ </note>
+ </section>
+ <section id="adding">
+ <title>Adding and removing layers</title>
+ <p>To create a layer, drag a clip to the middle space between two existing layers or just above the top
layer or just below the bottom layer. Once the thin space between the layers is highlighted, release the
clip.</p>
+ <p>To remove a layer, click <guiseq><gui>Layer icon</gui><gui>Delete layer</gui></guiseq>. The
<gui>Layer icon</gui> can be found at the right of the layer name field.</p>
+ </section>
+ <section id="audio">
+ <title>What about audio layers?</title>
+ <p>Unlike in vision, multiple sounds do not “block” each other. 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
index 4f8ab8c..62b3b46 100644
--- a/help/C/license.page
+++ b/help/C/license.page
@@ -1,16 +1,12 @@
-<page xmlns="http://projectmallard.org/1.0/"
- type="topic"
- id="license">
-
+<?xml version="1.0" encoding="UTF-8"?>
+<page xmlns="http://projectmallard.org/1.0/" type="topic" id="license">
<info>
<link type="seealso" xref="index"/>
<revision pkgversion="0.92" version="0.1" date="2013-12-19" status="complete"/>
<desc>Legal information.</desc>
</info>
-
<title>License</title>
- <p>
- <!--
+ <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.
-->
@@ -22,27 +18,34 @@
</p>
<terms>
<item>
- <title><em>To share</em></title>
+ <title>
+ <em>To share</em>
+ </title>
<p>To copy, distribute and transmit the work.</p>
</item>
<item>
- <title><em>To remix</em></title>
+ <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>
+ <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>
+ <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. -->
+ <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>
<p>For the license of Pitivi itself, see the <link href="http://www.gnu.org/licenses/lgpl-2.1.html">GNU
Lesser General Public License</link>.</p>
diff --git a/help/C/mainwindow.page b/help/C/mainwindow.page
index dc4b28a..e4fdbe0 100644
--- a/help/C/mainwindow.page
+++ b/help/C/mainwindow.page
@@ -1,8 +1,5 @@
-<page xmlns="http://projectmallard.org/1.0/"
- xmlns:e="http://projectmallard.org/experimental/"
- type="topic"
- id="mainwindow">
-
+<?xml version="1.0" encoding="UTF-8"?>
+<page xmlns="http://projectmallard.org/1.0/" xmlns:e="http://projectmallard.org/experimental/" type="topic"
id="mainwindow">
<info>
<link type="guide" xref="index#intro"/>
<link type="seealso" xref="medialibrary"/>
@@ -23,117 +20,148 @@
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
-
- <title>The main window</title>
-
- <p>The main window, as the name implies, is the window containing the main components of the
<app>Pitivi</app> user interface, namely: the header bar, the toolbars, the timeline and various customizable
components (media library, previewer, effects library, transitions library, etc.).</p>
- <media type="image" src="figures/mainwindow.jpg" mime="image/jpg" style="right" width="780" />
- <p>In the figure above, the following areas can be observed:</p>
- <list type="numbered">
- <item><p>Header bar and main toolbar buttons</p></item>
- <item><p>Main menu button</p></item>
- <item><p>Primary tabs: media library and effects library</p></item>
- <item><p>Contextual tabs: clip properties, transitions, titles</p></item>
- <item><p>Viewer</p></item>
- <item><p>Ruler</p></item>
- <item><p>Timeline</p></item>
- </list>
-
- <note style="tip">
+ <title>The main window</title>
+ <p>The main window, as the name implies, is the window containing the main components of the
<app>Pitivi</app> user interface, namely: the header bar, the toolbars, the timeline and various customizable
components (media library, previewer, effects library, transitions library, etc.).</p>
+ <media type="image" src="figures/mainwindow.jpg" mime="image/jpg" style="right" width="780"/>
+ <p>In the figure above, the following areas can be observed:</p>
+ <list type="numbered">
+ <item>
+ <p>Header bar and main toolbar buttons</p>
+ </item>
+ <item>
+ <p>Main menu button</p>
+ </item>
+ <item>
+ <p>Primary tabs: media library and effects library</p>
+ </item>
+ <item>
+ <p>Contextual tabs: clip properties, transitions, titles</p>
+ </item>
+ <item>
+ <p>Viewer</p>
+ </item>
+ <item>
+ <p>Ruler</p>
+ </item>
+ <item>
+ <p>Timeline</p>
+ </item>
+ </list>
+ <note style="tip">
<title>Resizing the components of the main window</title>
<p>The spaces between components can be clicked and dragged to proportionally resize the respective
adjacent components.</p>
- </note>
- <note style="tip">
+ </note>
+ <note style="tip">
<title>Hovering for more information</title>
<p>Hovering the mouse cursor over an element in the main window usually reveals an information tooltip
regarding its function.</p>
+ </note>
+ <section id="headerbar">
+ <title>Header bar</title>
+ <p>The header bar is a place where basic functions such as <gui>Undo</gui>, <gui>Redo</gui>,
<gui>Save</gui>, or <gui>Render</gui> can be directly accessed. It also contains the main <gui>menu
button</gui> where you can find further functions such as <gui>New project</gui>, <gui>Open project</gui>,
<gui>Project settings</gui> or <gui>Preferences</gui>.</p>
+ <note style="tip">
+ <p>The <gui>menu button</gui>'s contents can be accessed by pressing <key>F10</key>.</p>
+ </note>
+ </section>
+ <section id="ruler">
+ <title>Ruler</title>
+ <p>The ruler plays a crucial role in your interaction with the timeline. First, it represents a time
scale providing time measurements (in seconds) for overall orientation. Second, it constitutes the primary
surface on which you can move the playhead (and thus, change your position in time). To move your position,
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 section on <link xref="movearoundtimeline">scrubbing</link> for
more details.</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"/>
+ </figure>
+ <note>
+ <p>When zoomed in, frames are visually represented as alternating light and dark areas in the bottom
part of the ruler. Hovering the mouse cursor over the ruler in this state will reveal an information tooltip
with frame number. The amount of time the individual frames take up is based on the project framerate
settings.</p>
</note>
-
- <section id="headerbar">
- <title>Header bar</title>
- <p>The header bar is a place where basic functions such as <gui>Undo</gui>, <gui>Redo</gui>,
<gui>Save</gui>, or <gui>Render</gui> can be directly accessed. It also contains the main <gui>menu
button</gui> where you can find further functions such as <gui>New project</gui>, <gui>Open project</gui>,
<gui>Project settings</gui> or <gui>Preferences</gui>.</p>
- <note style="tip">
- <p>The <gui>menu button</gui>'s contents can be accessed by pressing <key>F10</key>.</p>
- </note>
- </section>
-
- <section id="ruler">
- <title>Ruler</title>
- <p>The ruler plays a crucial role in your interaction with the timeline. First, it represents a time
scale providing time measurements (in seconds) for overall orientation. Second, it constitutes the primary
surface on which you can move the playhead (and thus, change your position in time). To move your position,
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 section on <link xref="movearoundtimeline">scrubbing</link> for
more details.</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 as alternating light and dark areas in the bottom
part of the ruler. Hovering the mouse cursor over the ruler in this state will reveal an information tooltip
with frame number. The amount of time the individual frames take up is based on the project framerate
settings.</p>
- </note>
- </section>
-
- <section id="timeline">
- <title>Timeline</title>
- <p>The timeline is the core user interface component that you will use for editing. Vertically, it is
divided into layers that can be filled with audio and video clips. Horizontally, it constitutes a
time-proportional representation of your project's chronology. Various levels of zoom can be applied to the
timeline. However, these apply only to the horizontal (chronological) dimension of the timeline.</p>
- <p>See the <link xref="layers">Understanding layers</link> and <link xref="movearoundtimeline">Moving
around the timeline</link> pages for more information on how to work with the timeline.</p>
- </section>
-
- <section id="timelinetoolbar">
- <title>Timeline toolbar</title>
- <p>The timeline toolbar is located at the right edge of the timeline. It contains basic actions for
editing in timeline:</p>
- <list>
- <item><p>Split clip at playhead position</p></item>
- <item><p>Delete selected</p></item>
- <item><p>Group clips</p></item>
- <item><p>Ungroup clips</p></item>
- <item><p>Copy</p></item>
- <item><p>Paste</p></item>
+ </section>
+ <section id="timeline">
+ <title>Timeline</title>
+ <p>The timeline is the core user interface component that you will use for editing. Vertically, it is
divided into layers that can be filled with audio and video clips. Horizontally, it constitutes a
time-proportional representation of your project's chronology. Various levels of zoom can be applied to the
timeline. However, these apply only to the horizontal (chronological) dimension of the timeline.</p>
+ <p>See the <link xref="layers">Understanding layers</link> and <link xref="movearoundtimeline">Moving
around the timeline</link> pages for more information on how to work with the timeline.</p>
+ </section>
+ <section id="timelinetoolbar">
+ <title>Timeline toolbar</title>
+ <p>The timeline toolbar is located at the right edge of the timeline. It contains basic actions for
editing in timeline:</p>
+ <list>
+ <item>
+ <p>Split clip at playhead position</p>
+ </item>
+ <item>
+ <p>Delete selected</p>
+ </item>
+ <item>
+ <p>Group clips</p>
+ </item>
+ <item>
+ <p>Ungroup clips</p>
+ </item>
+ <item>
+ <p>Copy</p>
+ </item>
+ <item>
+ <p>Paste</p>
+ </item>
<!--item><p>Align clips based on their soundtracks</p></item-->
- <item><p>Toggle gapless mode</p></item>
- </list>
- <note>
+ <item>
+ <p>Toggle gapless mode</p>
+ </item>
+ </list>
+ <note>
<p>Note that most of the actions become available only once a clip is selected (see <link
xref="selectiongrouping">Selection and grouping</link> for more details). When there is no subject for the
action to be performed on, it remains shaded (indicating its unavailability).</p>
- </note>
- </section>
-
- <section id="playbacktoolbar">
- <title>Playback toolbar</title>
- <p>This toolbar, located below the previewer, contains buttons controlling the playback of the
timeline. Options provided by the toolbar are the following:</p>
- <list>
- <item><p>Play/Pause</p></item>
- <item><p>Go forward one second</p></item>
- <item><p>Go back one second</p></item>
- <item><p>Go to the end of the timeline</p></item>
- <item><p>Go to the beginning of the timeline</p></item>
- </list>
- <p>For more information on how to move on the timeline, see the <em>Moving the playhead</em> and
<em>Scrubbing</em> sections on the <link xref="movearoundtimeline">Moving around the timeline</link> page.</p>
- </section>
-
- <section id="viewer">
- <title>Previewer</title>
- <p>The previewer displays:</p>
- <list>
- <item><p>The video frame at the current position of the playhead.</p></item>
- <item><p>Your project's video when playing back.</p></item>
- <item><p>A <em>live preview</em> when trimming a clip's beginning/end point.</p>
- </item>
- </list>
- <note style="tip">
+ </note>
+ </section>
+ <section id="playbacktoolbar">
+ <title>Playback toolbar</title>
+ <p>This toolbar, located below the previewer, contains buttons controlling the playback of the timeline.
Options provided by the toolbar are the following:</p>
+ <list>
+ <item>
+ <p>Play/Pause</p>
+ </item>
+ <item>
+ <p>Go forward one second</p>
+ </item>
+ <item>
+ <p>Go back one second</p>
+ </item>
+ <item>
+ <p>Go to the end of the timeline</p>
+ </item>
+ <item>
+ <p>Go to the beginning of the timeline</p>
+ </item>
+ </list>
+ <p>For more information on how to move on the timeline, see the <em>Moving the playhead</em> and
<em>Scrubbing</em> sections on the <link xref="movearoundtimeline">Moving around the timeline</link> page.</p>
+ </section>
+ <section id="viewer">
+ <title>Previewer</title>
+ <p>The previewer displays:</p>
+ <list>
+ <item>
+ <p>The video frame at the current position of the playhead.</p>
+ </item>
+ <item>
+ <p>Your project's video when playing back.</p>
+ </item>
+ <item>
+ <p>A <em>live preview</em> when trimming a clip's beginning/end point.</p>
+ </item>
+ </list>
+ <note style="tip">
<title>Detaching the previewer into a separate window</title>
- <p>You can detach the previewer into a separate window by clicking the <gui>Detach the
viewer</gui> button in the <gui>Playback toolbar</gui>. From the separate window, you can play the preview in
fullscreen. This will also allow other parts of the main window to take up the space the previewer occupied.
You can attach the previewer back by closing the separate window.</p>
- </note>
- <note>
- <p><app>Pitivi</app> inhibits the screensaver while playing the video preview.</p>
- </note>
- </section>
-
- <section id="left">
- <title>Left pane</title>
- <p>The left pane contains media and effect libraries. You can switch between them by selecting the
appropriate tab. The <gui>Media Library</gui> displays the imported media files in your project and allows
you to manage them. The <gui>Effect library</gui> contains number of audio and video effects applicable to
clips.</p>
- <note style="tip">
+ <p>You can detach the previewer into a separate window by clicking the <gui>Detach the viewer</gui>
button in the <gui>Playback toolbar</gui>. From the separate window, you can play the preview in fullscreen.
This will also allow other parts of the main window to take up the space the previewer occupied. You can
attach the previewer back by closing the separate window.</p>
+ </note>
+ <note>
+ <p><app>Pitivi</app> inhibits the screensaver while playing the video preview.</p>
+ </note>
+ </section>
+ <section id="left">
+ <title>Left pane</title>
+ <p>The left pane contains media and effect libraries. You can switch between them by selecting the
appropriate tab. The <gui>Media Library</gui> displays the imported media files in your project and allows
you to manage them. The <gui>Effect library</gui> contains number of audio and video effects applicable to
clips.</p>
+ <note style="tip">
<p>You can search the libraries by using the text box in the header of each library.</p>
- </note>
- </section>
-
- <section id="middle">
- <title>Middle pane</title>
- <p>The middle pane contains <gui>Clip configuration</gui>, <gui>Transitions</gui> and <gui>Title
editor</gui>. You can switch between them by selecting the appropriate tab. The <gui>Clip configuration</gui>
allows you to activate, deactivate or configure settings of effects applied to a selected clip.
<gui>Transitions</gui> let you pick and configure the transition type when two clips overlap in the timeline.
With <gui>Title editor</gui> you can create new clips with titles or add titles to existing ones.</p>
- </section>
-
+ </note>
+ </section>
+ <section id="middle">
+ <title>Middle pane</title>
+ <p>The middle pane contains <gui>Clip configuration</gui>, <gui>Transitions</gui> and <gui>Title
editor</gui>. You can switch between them by selecting the appropriate tab. The <gui>Clip configuration</gui>
allows you to activate, deactivate or configure settings of effects applied to a selected clip.
<gui>Transitions</gui> let you pick and configure the transition type when two clips overlap in the timeline.
With <gui>Title editor</gui> you can create new clips with titles or add titles to existing ones.</p>
+ </section>
</page>
diff --git a/help/C/medialibrary.page b/help/C/medialibrary.page
index bc24687..17bc392 100644
--- a/help/C/medialibrary.page
+++ b/help/C/medialibrary.page
@@ -1,8 +1,5 @@
-<page xmlns="http://projectmallard.org/1.0/"
- xmlns:e="http://projectmallard.org/experimental/"
- type="topic"
- id="medialibrary">
-
+<?xml version="1.0" encoding="UTF-8"?>
+<page xmlns="http://projectmallard.org/1.0/" xmlns:e="http://projectmallard.org/experimental/" type="topic"
id="medialibrary">
<info>
<link type="guide" xref="index#gettingstarted"/>
<revision pkgversion="0.96" version="0.4" date="2016-02-17" status="complete"/>
@@ -25,51 +22,64 @@
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
-
- <title>Using the Media Library</title>
-
- <section id="importing">
- <title>Importing a file to the <gui>Media Library</gui></title>
- <p>There are two ways to import files into the <gui>Media Library</gui>. The first way is to click
on the <gui>Import</gui> button in the upper left corner. This will open a file chooser in which you can
preview selected files or select multiple files (by holding <key>Shift</key> or <key>Control</key> while
selecting them). The second way is to drag and drop the files from a file browser to the <gui>Media
Library</gui>. <em>Files</em> imported into the <gui>Media Library</gui> are called <em>clips</em>.</p>
- <note>
- <p>The clips in the <gui>Media Library</gui> are sorted alphabetically.</p>
- </note>
- </section>
- <section id="previewing">
- <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>. This will open the clip in a window that automatically closes whenever you click
outside the window.</p>
- </section>
- <section id="searching">
- <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 id="modes">
- <title>View modes</title>
- <p>The <gui>Media Library</gui> can display your clips in a list or in an icon view. The default
mode is icon view because it display more clips without needing to scroll down. However, the list view mode
shows more details about each clip. To activate/deactivate it, click on the <gui>Show clips as a detailed
list</gui> button next to the search bar.</p>
- </section>
- <section id="selectingunused">
- <title>Selecting unused clips</title>
- <p>You may sometimes find that you have imported more clips that you needed in your project.
<app>Pitivi</app> allows you to select clips that are present in the media library but not in the timeline.
There are various reasons to do this:</p>
- <list>
- <item><p>Improving performance when loading the project</p></item>
- <item><p>Simplifying your editing workflow</p></item>
- <item><p>Check which clips you may have forgot to use in your movie</p></item>
- <item><p>Backup or share your project more easily</p></item>
- </list>
- <p>To identify which clips are not being used in your project, use the <gui>Select clips that have
not been used in the project</gui> button at the left side of the search bar. Unused clips will then be
selected in the media library.</p>
- <note><p>If there are no unused clips in your project, nothing will be selected in the media
library.</p></note>
- </section>
- <section id="otheractions">
- <title>Other actions</title>
- <p>There are three further actions you can perform with clips. Each is represented by a button in
the upper right part of the <gui>Media Library</gui>:</p>
- <list type="numbered">
- <item><p><gui>Remove selected clips from the project</gui> (this can also be performed by pressing
<keyseq><key>Control</key><key>Delete</key></keyseq>).</p></item>
- <item><p><gui>Clip properties...</gui> opens a new window with information on <em>video size</em>,
<em>frame rate</em> and <em>aspect ratio</em>. Clicking the <gui>Apply to project</gui> button adjusts the
project settings to the clip properties. You can select which properties to apply by leaving them
ticked/unticked.</p></item>
- <item><p><gui>Insert selected clips at the end of the timeline</gui> inserts the selected clips
one after another into the longest layer of the timeline where the last clip on that layer ends.</p></item>
- </list>
- <note>
- <p>In order for these actions to become available, one or more clips must be selected.</p>
- </note>
- </section>
-
+ <title>Using the Media Library</title>
+ <section id="importing">
+ <title>Importing a file to the <gui>Media Library</gui></title>
+ <p>There are two ways to import files into the <gui>Media Library</gui>. The first way is to click on
the <gui>Import</gui> button in the upper left corner. This will open a file chooser in which you can preview
selected files or select multiple files (by holding <key>Shift</key> or <key>Control</key> while selecting
them). The second way is to drag and drop the files from a file browser to the <gui>Media Library</gui>.
<em>Files</em> imported into the <gui>Media Library</gui> are called <em>clips</em>.</p>
+ <note>
+ <p>The clips in the <gui>Media Library</gui> are sorted alphabetically.</p>
+ </note>
+ </section>
+ <section id="previewing">
+ <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>. This will open the clip in a window that automatically closes whenever you click outside the
window.</p>
+ </section>
+ <section id="searching">
+ <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 id="modes">
+ <title>View modes</title>
+ <p>The <gui>Media Library</gui> can display your clips in a list or in an icon view. The default mode is
icon view because it display more clips without needing to scroll down. However, the list view mode shows
more details about each clip. To activate/deactivate it, click on the <gui>Show clips as a detailed
list</gui> button next to the search bar.</p>
+ </section>
+ <section id="selectingunused">
+ <title>Selecting unused clips</title>
+ <p>You may sometimes find that you have imported more clips that you needed in your project.
<app>Pitivi</app> allows you to select clips that are present in the media library but not in the timeline.
There are various reasons to do this:</p>
+ <list>
+ <item>
+ <p>Improving performance when loading the project</p>
+ </item>
+ <item>
+ <p>Simplifying your editing workflow</p>
+ </item>
+ <item>
+ <p>Check which clips you may have forgot to use in your movie</p>
+ </item>
+ <item>
+ <p>Backup or share your project more easily</p>
+ </item>
+ </list>
+ <p>To identify which clips are not being used in your project, use the <gui>Select clips that have not
been used in the project</gui> button at the left side of the search bar. Unused clips will then be selected
in the media library.</p>
+ <note>
+ <p>If there are no unused clips in your project, nothing will be selected in the media library.</p>
+ </note>
+ </section>
+ <section id="otheractions">
+ <title>Other actions</title>
+ <p>There are three further actions you can perform with clips. Each is represented by a button in the
upper right part of the <gui>Media Library</gui>:</p>
+ <list type="numbered">
+ <item>
+ <p><gui>Remove selected clips from the project</gui> (this can also be performed by pressing
<keyseq><key>Control</key><key>Delete</key></keyseq>).</p>
+ </item>
+ <item>
+ <p><gui>Clip properties...</gui> opens a new window with information on <em>video size</em>,
<em>frame rate</em> and <em>aspect ratio</em>. Clicking the <gui>Apply to project</gui> button adjusts the
project settings to the clip properties. You can select which properties to apply by leaving them
ticked/unticked.</p>
+ </item>
+ <item>
+ <p><gui>Insert selected clips at the end of the timeline</gui> inserts the selected clips one after
another into the longest layer of the timeline where the last clip on that layer ends.</p>
+ </item>
+ </list>
+ <note>
+ <p>In order for these actions to become available, one or more clips must be selected.</p>
+ </note>
+ </section>
</page>
diff --git a/help/C/movearoundtimeline.page b/help/C/movearoundtimeline.page
index 6298d84..5a1d4b1 100644
--- a/help/C/movearoundtimeline.page
+++ b/help/C/movearoundtimeline.page
@@ -1,8 +1,5 @@
-<page xmlns="http://projectmallard.org/1.0/"
- xmlns:e="http://projectmallard.org/experimental/"
- type="topic"
- id="movearoundtimeline">
-
+<?xml version="1.0" encoding="UTF-8"?>
+<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.96" version="0.2" date="2016-02-17" status="complete"/>
@@ -25,63 +22,77 @@
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
-
- <title>Moving around the timeline</title>
-
- <section id="activating">
- <title>Activating the timeline toolbar</title>
- <p>The timeline toolbar contains many tools, which become active once a clip is selected in the
timeline. To select a clip, simply click on the desired clip in the timeline. When selected, the clip will
become darker and the timeline toolbar items will now be clickable.</p>
- </section>
-
- <section id="scrolling">
- <title>Scrolling</title>
- <p>You can scroll by:</p>
- <list>
- <item><p>Using the mouse wheel anywhere over the timeline to scroll horizontally, or hold down the
<key>Shift</key> key while using the mouse wheel to scroll the timeline layers vertically</p></item>
- <item><p>Clicking anywhere over the timeline with the middle button and dragging the
timeline</p></item>
- <item><p>Using the scrollbars located on the right and bottom of the timeline</p></item>
- </list>
- </section>
-
- <section id="zooming">
- <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:</p>
- <list>
- <item><p>Holding the <key>Ctrl</key> key while using the mousewheel over the timeline, to keep
the timeline point where the mouse cursor is in place if possible</p></item>
- <item><p>Holding the <key>Alt</key> key while using the mousewheel over the timeline, to keep the
playhead in view</p></item>
- <item><p>Dragging the zoom slider on the left of the ruler</p></item>
- <item><p>Using keyboard shortcuts such as <keyseq><key>Ctrl</key><key>-</key></keyseq> to zoom
out or <keyseq><key>Ctrl</key><key>=</key></keyseq> (<keyseq><key>Ctrl</key><key>+</key></keyseq> on the
numeric keypad) to zoom in</p></item>
- </list>
- <p>To get a global overview of your timeline, you may click the <gui>Zoom</gui> button on the left of
the zoom slider. Another way to do this is by pressing <keyseq><key>Ctrl</key><key>0</key></keyseq></p>.
-
- <note style="tip">
- <title><em>Warping</em> between zoom levels</title>
- <p>Using your mouse, you can also <em>warp</em> instantly from any zoom level to another in a single
click. To do that, click 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 with the right mouse button anywhere on
the ruler or on the timeline.</p>
- <note style="tip">
- <title>Jumping to an exact position</title>
- <p>You can jump to an exact position in the timeline by editing the time value shown in the playback
toolbar (see description of <link xref="mainwindow">The main window</link>). To edit it, simply click on the
widget, overwrite the value and hit <key>enter</key>. The value can represent either timecode or a frame
number. Timecode has the following form: <em>hh:mm:ss.milisec</em> where hours are optional. To insert a
frame number, overwrite the timecode with a plain number of the desired frame.</p>
- </note>
- </section>
-
- <section id="scrubbing">
- <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 with the right mouse button and move the mouse with the button still
held down.</p>
- </section>
-
+ <title>Moving around the timeline</title>
+ <section id="activating">
+ <title>Activating the timeline toolbar</title>
+ <p>The timeline toolbar contains many tools, which become active once a clip is selected in the
timeline. To select a clip, simply click on the desired clip in the timeline. When selected, the clip will
become darker and the timeline toolbar items will now be clickable.</p>
+ </section>
+ <section id="scrolling">
+ <title>Scrolling</title>
+ <p>You can scroll by:</p>
+ <list>
+ <item>
+ <p>Using the mouse wheel anywhere over the timeline to scroll horizontally, or hold down the
<key>Shift</key> key while using the mouse wheel to scroll the timeline layers vertically</p>
+ </item>
+ <item>
+ <p>Clicking anywhere over the timeline with the middle button and dragging the timeline</p>
+ </item>
+ <item>
+ <p>Using the scrollbars located on the right and bottom of the timeline</p>
+ </item>
+ </list>
+ </section>
+ <section id="zooming">
+ <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:</p>
+ <list>
+ <item>
+ <p>Holding the <key>Ctrl</key> key while using the mousewheel over the timeline, to keep the
timeline point where the mouse cursor is in place if possible</p>
+ </item>
+ <item>
+ <p>Holding the <key>Alt</key> key while using the mousewheel over the timeline, to keep the playhead
in view</p>
+ </item>
+ <item>
+ <p>Dragging the zoom slider on the left of the ruler</p>
+ </item>
+ <item>
+ <p>Using keyboard shortcuts such as <keyseq><key>Ctrl</key><key>-</key></keyseq> to zoom out or
<keyseq><key>Ctrl</key><key>=</key></keyseq> (<keyseq><key>Ctrl</key><key>+</key></keyseq> on the numeric
keypad) to zoom in</p>
+ </item>
+ </list>
+ <p>To get a global overview of your timeline, you may click the <gui>Zoom</gui> button on the left of
the zoom slider. Another way to do this is by pressing <keyseq><key>Ctrl</key><key>0</key></keyseq>.</p>
+ <note style="tip">
+ <title><em>Warping</em> between zoom levels</title>
+ <p>Using your mouse, you can also <em>warp</em> instantly from any zoom level to another in a single
click. To do that, click 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 with the right mouse button anywhere on the
ruler or on the timeline.</p>
+ <note style="tip">
+ <title>Jumping to an exact position</title>
+ <p>You can jump to an exact position in the timeline by editing the time value shown in the playback
toolbar (see description of <link xref="mainwindow">The main window</link>). To edit it, simply click on the
widget, overwrite the value and hit <key>enter</key>. The value can represent either timecode or a frame
number. Timecode has the following form: <em>hh:mm:ss.milisec</em> where hours are optional. To insert a
frame number, overwrite the timecode with a plain number of the desired frame.</p>
+ </note>
+ </section>
+ <section id="scrubbing">
+ <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 with the right mouse button and move the mouse with the button still
held down.</p>
+ </section>
</page>
diff --git a/help/C/presets.page b/help/C/presets.page
index 8239b7c..760c869 100644
--- a/help/C/presets.page
+++ b/help/C/presets.page
@@ -1,8 +1,5 @@
-<page xmlns="http://projectmallard.org/1.0/"
- xmlns:e="http://projectmallard.org/experimental/"
- type="topic"
- id="presets">
-
+<?xml version="1.0" encoding="UTF-8"?>
+<page xmlns="http://projectmallard.org/1.0/" xmlns:e="http://projectmallard.org/experimental/" type="topic"
id="presets">
<info>
<link type="guide" xref="index#gettingstarted"/>
<link type="seealso" xref="codecscontainers"/>
@@ -13,8 +10,8 @@
<email>nekohayo gmail com</email>
</credit>
<credit type="contributor">
- <name>Tomáš Karger</name>
- <email>tomkarger gmail com</email>
+ <name>Tomáš Karger</name>
+ <email>tomkarger gmail com</email>
</credit>
<desc>
Using presets in rendering and project settings.
@@ -23,29 +20,41 @@
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
-
- <title>Presets</title>
- <p>Both the <gui>Project settings</gui> dialog and the <gui>Rendering</gui> dialog allow you to save
presets for later use. If you often deal with the same kind of project settings, with different cameras or
target devices for rendering, you may want to create custom presets.</p>
- <note><p>In project settings, video presets and audio presets are independent of each other.</p></note>
- <section id="adding">
- <title>Creating and editing presets</title>
- <p>To create a preset:</p>
- <steps>
- <item><p>Change the settings to your liking.</p></item>
- <item><p>At the right of the presets combobox click <guiseq><gui>Menu
button</gui><gui>New</gui></guiseq>. If this option is deactivated, skip to the next step.</p></item>
- <item><p>Give your preset a unique name: click on the combobox to edit the name. 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 presets combobox.</p></item>
- <item><p>Change the settings to your liking.</p></item>
- <item><p>Click at the right of the presets combobox <guiseq><gui>Menu
button</gui><gui>Save</gui></guiseq>.</p></item>
- </steps>
- <p>To remove a preset, simply select it in the presets combobox and click <guiseq><gui>Menu
button</gui><gui>Remove</gui></guiseq>.</p>
- </section>
- <section id="limiting">
- <title>Limiting the resolution of a rendering preset</title>
- <p>If you want to make a preset with a fixed maximum resolution, you need to edit the preset file
with a text editor. Presets files are typically stored in ~/.local/share/pitivi/ ; since many devices don't
have a maximum resolution, the width/height are set to 0 (unlimited) by default. You can change these values
to the maximum resolution of your target device.</p>
- </section>
-
+ <title>Presets</title>
+ <p>Both the <gui>Project settings</gui> dialog and the <gui>Rendering</gui> dialog allow you to save
presets for later use. If you often deal with the same kind of project settings, with different cameras or
target devices for rendering, you may want to create custom presets.</p>
+ <note>
+ <p>In project settings, video presets and audio presets are independent of each other.</p>
+ </note>
+ <section id="adding">
+ <title>Creating and editing presets</title>
+ <p>To create a preset:</p>
+ <steps>
+ <item>
+ <p>Change the settings to your liking.</p>
+ </item>
+ <item>
+ <p>At the right of the presets combobox click <guiseq><gui>Menu button</gui><gui>New</gui></guiseq>.
If this option is deactivated, skip to the next step.</p>
+ </item>
+ <item>
+ <p>Give your preset a unique name: click on the combobox to edit the name. 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 presets combobox.</p>
+ </item>
+ <item>
+ <p>Change the settings to your liking.</p>
+ </item>
+ <item>
+ <p>Click at the right of the presets combobox <guiseq><gui>Menu
button</gui><gui>Save</gui></guiseq>.</p>
+ </item>
+ </steps>
+ <p>To remove a preset, simply select it in the presets combobox and click <guiseq><gui>Menu
button</gui><gui>Remove</gui></guiseq>.</p>
+ </section>
+ <section id="limiting">
+ <title>Limiting the resolution of a rendering preset</title>
+ <p>If you want to make a preset with a fixed maximum resolution, you need to edit the preset file with a
text editor. Presets files are typically stored in ~/.local/share/pitivi/ ; since many devices don't have a
maximum resolution, the width/height are set to 0 (unlimited) by default. You can change these values to the
maximum resolution of your target device.</p>
+ </section>
</page>
diff --git a/help/C/rendering.page b/help/C/rendering.page
index 98dade8..605de25 100644
--- a/help/C/rendering.page
+++ b/help/C/rendering.page
@@ -1,8 +1,5 @@
-<page xmlns="http://projectmallard.org/1.0/"
- xmlns:e="http://projectmallard.org/experimental/"
- type="topic"
- id="rendering">
-
+<?xml version="1.0" encoding="UTF-8"?>
+<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.96" version="0.2" date="2016-02-17" status="incomplete"/>
@@ -25,25 +22,34 @@
<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>Click <guiseq><gui>Headerbar</gui><gui>Render</gui></guiseq>.</p></item>
- <item><p>Choose the location and name of the exported file.</p></item>
- <item><p>Optionally choose a preset.</p></item>
- <item><p>Choose a container. See the <link xref="codecscontainers">codecs and containers</link> page
for details.</p></item>
- <item><p>Adjust the various encoding settings.</p></item>
- <item><p>Click the <gui>Render</gui> button.</p></item>
- </steps>
- <p>While rendering, you can pause the process by clicking the <gui>Pause</gui> button and unpause it by
clicking it again. You can also stop rendering either by clicking the <gui>Cancel</gui> button or by pressing
<key>Esc</key>. If you stop the rendering process, the already rendered part of the project will be saved at
the specified location. You might be able to use a partially rendered file, depending on the specified
container format. A new render operation cannot resume from a partially rendered file.</p>
- <note style="tip">
- <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.</p>
- </note>
- <section id="differences">
- <title>Project settings and the rendering dialog</title>
- <p>The <gui>Project Settings</gui> are a base on which the <gui>Rendering dialog</gui> settings are
applied when performing a render. The <gui>Project Settings</gui> are kept separate because they also
determine how you preview the project while editing it. The values specified in the <gui>Rendering
dialog</gui> are temporary and used only at render time. Because they are so closely related, the
<gui>Rendering dialog</gui> has a button which opens the <gui>Project Settings</gui>.</p>
- </section>
-
+ <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>Click <guiseq><gui>Headerbar</gui><gui>Render</gui></guiseq>.</p>
+ </item>
+ <item>
+ <p>Choose the location and name of the exported file.</p>
+ </item>
+ <item>
+ <p>Optionally choose a preset.</p>
+ </item>
+ <item>
+ <p>Choose a container. See the <link xref="codecscontainers">codecs and containers</link> page for
details.</p>
+ </item>
+ <item>
+ <p>Adjust the various encoding settings.</p>
+ </item>
+ <item>
+ <p>Click the <gui>Render</gui> button.</p>
+ </item>
+ </steps>
+ <p>While rendering, you can pause the process by clicking the <gui>Pause</gui> button and unpause it by
clicking it again. You can also stop rendering either by clicking the <gui>Cancel</gui> button or by pressing
<key>Esc</key>. If you stop the rendering process, the already rendered part of the project will be saved at
the specified location. You might be able to use a partially rendered file, depending on the specified
container format. A new render operation cannot resume from a partially rendered file.</p>
+ <note style="tip">
+ <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.</p>
+ </note>
+ <section id="differences">
+ <title>Project settings and the rendering dialog</title>
+ <p>The <gui>Project Settings</gui> are a base on which the <gui>Rendering dialog</gui> settings are
applied when performing a render. The <gui>Project Settings</gui> are kept separate because they also
determine how you preview the project while editing it. The values specified in the <gui>Rendering
dialog</gui> are temporary and used only at render time. Because they are so closely related, the
<gui>Rendering dialog</gui> has a button which opens the <gui>Project Settings</gui>.</p>
+ </section>
</page>
diff --git a/help/C/savescreenshot.page b/help/C/savescreenshot.page
index 91465bd..2dee230 100644
--- a/help/C/savescreenshot.page
+++ b/help/C/savescreenshot.page
@@ -1,8 +1,5 @@
-<page xmlns="http://projectmallard.org/1.0/"
- xmlns:e="http://projectmallard.org/experimental/"
- type="topic"
- id="savescreenshot">
-
+<?xml version="1.0" encoding="UTF-8"?>
+<page xmlns="http://projectmallard.org/1.0/" xmlns:e="http://projectmallard.org/experimental/" type="topic"
id="savescreenshot">
<info>
<link type="topic" xref="index"/>
<revision pkgversion="0.96" version="0.2" date="2016-02-17" status="complete"/>
@@ -14,10 +11,7 @@
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
-
- <title>Saving a snapshot of the current frame</title>
-
- <p>You can use <guiseq><gui>Menu button</gui><gui>Export current frame...</gui></guiseq> to save a copy
of the current frame as an image file.</p>
- <p>Currently, PNG and JPEG are supported as file formats. The image resolution will match the project
settings and any effect or transformation will also be applied to the resulting image.</p>
-
+ <title>Saving a snapshot of the current frame</title>
+ <p>You can use <guiseq><gui>Menu button</gui><gui>Export current frame...</gui></guiseq> to save a copy of
the current frame as an image file.</p>
+ <p>Currently, PNG and JPEG are supported as file formats. The image resolution will match the project
settings and any effect or transformation will also be applied to the resulting image.</p>
</page>
diff --git a/help/C/selectiongrouping.page b/help/C/selectiongrouping.page
index 8bf871a..1da877f 100644
--- a/help/C/selectiongrouping.page
+++ b/help/C/selectiongrouping.page
@@ -1,8 +1,5 @@
-<page xmlns="http://projectmallard.org/1.0/"
- xmlns:e="http://projectmallard.org/experimental/"
- type="topic"
- id="selectiongrouping">
-
+<?xml version="1.0" encoding="UTF-8"?>
+<page xmlns="http://projectmallard.org/1.0/" xmlns:e="http://projectmallard.org/experimental/" type="topic"
id="selectiongrouping">
<info>
<link type="guide" xref="index#timeline"/>
<revision pkgversion="0.96" version="0.2" date="2016-02-17" status="complete"/>
@@ -25,44 +22,58 @@
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
-
- <title>Selection and grouping</title>
-
- <section id="selection">
- <title>Making selections</title>
- <p>By selecting a clip, you specify what item should the subsequent actions be applied to. Selecting
multiple clips allows you to apply actions (dragging, deleting, grouping, etc.) to all of them at once. To
select an individual clip, simply click it.</p>
- <p>To select multiple adjacent clips you can click the timeline anywhere in an empty region and drag.
Alternatively, you can:</p>
- <steps>
- <item><p>Click the first clip.</p></item>
- <item><p>Hold the <key>Shift</key> key.</p></item>
- <item><p>Click the last clip.</p></item>
- </steps>
- <p>When selecting a clip by clicking or when selecting multiple adjacent clips, the selection is
reset. The rest of the clips become deselected if they were previously selected. Selecting or deselecting
specific clips without resetting the selection can be done by toggling individually a clip's selection:</p>
- <steps>
- <item><p>Hold down the <key>Ctrl</key> key.</p></item>
- <item><p>Click on each clip you want to toggle the selection.</p></item>
- </steps>
- <p>To clear the selection, click anywhere on the timeline in an empty region.</p>
- <note style="tip">
- <p>By default, clicking in the timeline changes the selection and also moves the playhead. To have
a better control of the playhead you can disable seeking when left-clicking. This way left-clicking only
changes the selection and the playhead position won't be lost when you make selections. This can be specified
at <guiseq><gui>Menu button</gui><gui>Preferences</gui><gui>Left click also seeks</gui></guiseq>. You can
still use right-click to move the playhead, as before, see <link
xref="movearoundtimeline#movingplayhead"></link> for details.</p>
- </note>
- </section>
-
- <section id="grouping">
- <title>Grouping and ungrouping clips</title>
- <p>The grouping and ungrouping functions are useful when you want to add or separate audio tracks
from video clips, or when you want to create a block of clips that you can select, edit and move all at
once.</p>
- <p>Grouping clips in timeline:</p>
- <steps>
- <item><p>Select multiple clips in the timeline.</p></item>
- <item><p>Click the <gui>Group clips</gui> button on the timeline toolbar, or press
<keyseq><key>Ctrl</key><key>G</key></keyseq>.</p></item>
- </steps>
- <p>You can now select, edit and move the clips all at once.</p>
- <p>Ungrouping clips in timeline:</p>
- <steps>
- <item><p>Select a group of clips in the timeline.</p></item>
- <item><p>Click the <gui>Ungroup clips</gui> button on the timeline toolbar, or press
<keyseq><key>Ctrl</key><key>Shift</key><key>G</key></keyseq>.</p></item>
- </steps>
- <p>You can now select, edit and move the clips independently.</p>
- </section>
-
+ <title>Selection and grouping</title>
+ <section id="selection">
+ <title>Making selections</title>
+ <p>By selecting a clip, you specify what item should the subsequent actions be applied to. Selecting
multiple clips allows you to apply actions (dragging, deleting, grouping, etc.) to all of them at once. To
select an individual clip, simply click it.</p>
+ <p>To select multiple adjacent clips you can click the timeline anywhere in an empty region and drag.
Alternatively, you can:</p>
+ <steps>
+ <item>
+ <p>Click the first clip.</p>
+ </item>
+ <item>
+ <p>Hold the <key>Shift</key> key.</p>
+ </item>
+ <item>
+ <p>Click the last clip.</p>
+ </item>
+ </steps>
+ <p>When selecting a clip by clicking or when selecting multiple adjacent clips, the selection is reset.
The rest of the clips become deselected if they were previously selected. Selecting or deselecting specific
clips without resetting the selection can be done by toggling individually a clip's selection:</p>
+ <steps>
+ <item>
+ <p>Hold down the <key>Ctrl</key> key.</p>
+ </item>
+ <item>
+ <p>Click on each clip you want to toggle the selection.</p>
+ </item>
+ </steps>
+ <p>To clear the selection, click anywhere on the timeline in an empty region.</p>
+ <note style="tip">
+ <p>By default, clicking in the timeline changes the selection and also moves the playhead. To have a
better control of the playhead you can disable seeking when left-clicking. This way left-clicking only
changes the selection and the playhead position won't be lost when you make selections. This can be specified
at <guiseq><gui>Menu button</gui><gui>Preferences</gui><gui>Left click also seeks</gui></guiseq>. You can
still use right-click to move the playhead, as before, see <link xref="movearoundtimeline#movingplayhead"/>
for details.</p>
+ </note>
+ </section>
+ <section id="grouping">
+ <title>Grouping and ungrouping clips</title>
+ <p>The grouping and ungrouping functions are useful when you want to add or separate audio tracks from
video clips, or when you want to create a block of clips that you can select, edit and move all at once.</p>
+ <p>Grouping clips in timeline:</p>
+ <steps>
+ <item>
+ <p>Select multiple clips in the timeline.</p>
+ </item>
+ <item>
+ <p>Click the <gui>Group clips</gui> button on the timeline toolbar, or press
<keyseq><key>Ctrl</key><key>G</key></keyseq>.</p>
+ </item>
+ </steps>
+ <p>You can now select, edit and move the clips all at once.</p>
+ <p>Ungrouping clips in timeline:</p>
+ <steps>
+ <item>
+ <p>Select a group of clips in the timeline.</p>
+ </item>
+ <item>
+ <p>Click the <gui>Ungroup clips</gui> button on the timeline toolbar, or press
<keyseq><key>Ctrl</key><key>Shift</key><key>G</key></keyseq>.</p>
+ </item>
+ </steps>
+ <p>You can now select, edit and move the clips independently.</p>
+ </section>
</page>
diff --git a/help/C/splitting.page b/help/C/splitting.page
index 70e7cb8..8673820 100644
--- a/help/C/splitting.page
+++ b/help/C/splitting.page
@@ -1,8 +1,5 @@
-<page xmlns="http://projectmallard.org/1.0/"
- xmlns:e="http://projectmallard.org/experimental/"
- type="topic"
- id="splitting">
-
+<?xml version="1.0" encoding="UTF-8"?>
+<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.96" version="0.2" date="2016-02-17" status="complete"/>
@@ -25,28 +22,33 @@
<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="movearoundtimeline">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>For example, to split a single clip:</p>
- <steps>
- <item><p>Click on the clip to select it.</p></item>
- <item><p>Reposition the playhead where you want to split (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>Only the clips under the playhead can be split, depending on the current selection:</p>
- <list>
- <item><p>If clips are selected, only the selected clips under the playhead are split.</p></item>
- <item><p>If the selection is empty, all the clips under the playhead are split.</p></item>
- </list>
- <p>See how to select clips in <link xref="selectiongrouping#selection">Selection and
grouping</link>.</p>
-
- <note style="tip">
- <title>Cutting out the middle</title>
- <p>When you want to cut out a middle section of a clip, split the clip twice on the positions where
the part you want to remove begins and ends. Select the middle part and hit <key>Delete</key>. Now, eliminate
the empty space between the remaining two parts by moving one of them towards the other until they snap.</p>
- </note>
-
+ <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="movearoundtimeline">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>For example, to split a single clip:</p>
+ <steps>
+ <item>
+ <p>Click on the clip to select it.</p>
+ </item>
+ <item>
+ <p>Reposition the playhead where you want to split (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>Only the clips under the playhead can be split, depending on the current selection:</p>
+ <list>
+ <item>
+ <p>If clips are selected, only the selected clips under the playhead are split.</p>
+ </item>
+ <item>
+ <p>If the selection is empty, all the clips under the playhead are split.</p>
+ </item>
+ </list>
+ <p>See how to select clips in <link xref="selectiongrouping#selection">Selection and grouping</link>.</p>
+ <note style="tip">
+ <title>Cutting out the middle</title>
+ <p>When you want to cut out a middle section of a clip, split the clip twice on the positions where the
part you want to remove begins and ends. Select the middle part and hit <key>Delete</key>. Now, eliminate the
empty space between the remaining two parts by moving one of them towards the other until they snap.</p>
+ </note>
</page>
diff --git a/help/C/sysreq.page b/help/C/sysreq.page
index afd0609..3be35c9 100644
--- a/help/C/sysreq.page
+++ b/help/C/sysreq.page
@@ -1,8 +1,5 @@
-<page xmlns="http://projectmallard.org/1.0/"
- xmlns:e="http://projectmallard.org/experimental/"
- type="topic"
- id="sysreq">
-
+<?xml version="1.0" encoding="UTF-8"?>
+<page xmlns="http://projectmallard.org/1.0/" xmlns:e="http://projectmallard.org/experimental/" type="topic"
id="sysreq">
<info>
<link type="guide" xref="index#intro"/>
<revision pkgversion="0.96" version="0.2" date="2016-02-17" status="incomplete"/>
@@ -23,21 +20,26 @@
<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. 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>Here are some general hardware recommendations:</p>
- <list>
- <item><p>Modern quad core CPU</p></item>
- <item><p>Solid state drive</p></item>
- <item><p>Intel graphic cards tend to work without problems</p></item>
- <item><p>Full HD (1920x1080) capable monitor (resolutions below 1024x768 are not
supported)</p></item>
- </list>
- <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>
- <note style="bug">
- <p>You can track the state of proxy editing in <app>Pitivi</app> through <link
href="https://phabricator.freedesktop.org/T2455">task T2455</link>.</p>
- </note>
- <p>Software requirements are covered in <link xref="gstreamer">Gstreamer and compatibility</link> and
<link xref="effects">Introduction to effects</link>.</p>
-
+ <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. 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>Here are some general hardware recommendations:</p>
+ <list>
+ <item>
+ <p>Modern quad core CPU</p>
+ </item>
+ <item>
+ <p>Solid state drive</p>
+ </item>
+ <item>
+ <p>Intel graphic cards tend to work without problems</p>
+ </item>
+ <item>
+ <p>Full HD (1920x1080) capable monitor (resolutions below 1024x768 are not supported)</p>
+ </item>
+ </list>
+ <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>
+ <note style="bug">
+ <p>You can track the state of proxy editing in <app>Pitivi</app> through <link
href="https://phabricator.freedesktop.org/T2455">task T2455</link>.</p>
+ </note>
+ <p>Software requirements are covered in <link xref="gstreamer">Gstreamer and compatibility</link> and
<link xref="effects">Introduction to effects</link>.</p>
</page>
diff --git a/help/C/transitions.page b/help/C/transitions.page
index 5c8395b..97c8a15 100644
--- a/help/C/transitions.page
+++ b/help/C/transitions.page
@@ -1,8 +1,5 @@
-<page xmlns="http://projectmallard.org/1.0/"
- xmlns:e="http://projectmallard.org/experimental/"
- type="topic"
- id="transitions">
-
+<?xml version="1.0" encoding="UTF-8"?>
+<page xmlns="http://projectmallard.org/1.0/" xmlns:e="http://projectmallard.org/experimental/" type="topic"
id="transitions">
<info>
<link type="guide" xref="index#effectstransitions"/>
<revision pkgversion="0.96" version="0.2" date="2016-02-17" status="draft"/>
@@ -25,56 +22,65 @@
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
-
- <title>Transitions</title>
-
- <section id="crossfading">
- <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 as a space for transition between the two
clips. You can adjust the length of the transition either by moving the clips or by trimming them. If you
want to apply other types of transitions than the default (crossfade), see the <em>Other types of
transitions</em> section on this page.</p>
- <note>
- <p>Crossfades are achieved using <app>Pitivi</app>'s video mixing features, which use keyframes to
control the opacity of clips. This means that if you set opacity keyframes for a clip, they will be taken
into account for the crossfade.</p>
- </note>
- </section>
- <section id="types">
- <title>Other types of transitions</title>
- <p>Assuming that you have two overlapping clips in your timeline, you can achieve other types of
transitions by following these steps:</p>
- <steps>
- <item><p>Select the overlapping region by clicking on it.</p></item>
- <item><p>Select the <gui>Transition</gui> tab in the middle pane.</p></item>
- <item><p>Select one of the offered transitions.</p></item>
- </steps>
- <p>The transitions can be further adjusted with the following options from the bottom of the
<gui>Transition</gui> tab:</p>
- <list>
- <item><p><em>Normal mode</em> will apply the transition in a linear fashion over the whole
overlapping region. When in normal mode, you can adjust the degree of sharpness/smoothenss of the
transition.</p></item>
- <item><p><em>Loop</em> mode will apply the transition in a circular manner. When in loop mode, you
can adjust the speed with which the transition will repeat itself.</p></item>
- <item><p>In both modes, you can apply the transition in <em>reverse direction</em> by ticking the
corresponding checkbox.</p></item>
- </list>
- <note style="tip">
- <p>Each transition has its name and description. They are displayed when you hover the cursor over
the transition icon. You can also filter the transitions by typing into the search entry at the top of the
<gui>Transition</gui> tab. This will show only transitions whose name or description match your search
terms.</p>
- </note>
- </section>
- <section id="fades">
- <title>Fade-ins and fade-outs</title>
- <p>You can create fade-in and fade-out transitions in single clips by using keyframes controlling the
clip's opacity. For more information on keyframes, see <link xref="keyframecurves">Keyframe curves</link>. To
understand opacity, see <link xref="layers">Understanding layers</link>. The following images illustrate how
to fade a clip to black:</p>
- <figure>
- <title>Keyframe curves controlling the video opacity</title>
- <media type="image" src="figures/fadestep1.png" mime="image/png" style="right"></media>
- <desc>The default curve is flat indicating the same opacity at any position within the clip.</desc>
- </figure>
- <figure>
- <title>Adding a new keyframe</title>
- <media type="image" src="figures/fadestep2.png" mime="image/png" style="right"></media>
- <desc>Create a new keyframe by clicking the curve in a position where you want to start the
fade-out.</desc>
- </figure>
- <figure>
- <title>Moving the keyframe</title>
- <media type="image" src="figures/fadestep3.png" mime="image/png" style="right"></media>
- <desc>Click and drag the last keyframe downwards.</desc>
- </figure>
- <p>To achieve a fade-in, simply create a mirroring keyframe curve (new keyframe in a position where
the fade-in should end and the first keyframe dragged down) at the beginning of the clip.</p>
- <note style="tip">
- <p>Fades and crossfading as described here can be applied to both audio and video clips.</p>
+ <title>Transitions</title>
+ <section id="crossfading">
+ <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 as a space for transition between the two clips. You
can adjust the length of the transition either by moving the clips or by trimming them. If you want to apply
other types of transitions than the default (crossfade), see the <em>Other types of transitions</em> section
on this page.</p>
+ <note>
+ <p>Crossfades are achieved using <app>Pitivi</app>'s video mixing features, which use keyframes to
control the opacity of clips. This means that if you set opacity keyframes for a clip, they will be taken
into account for the crossfade.</p>
</note>
- </section>
-
+ </section>
+ <section id="types">
+ <title>Other types of transitions</title>
+ <p>Assuming that you have two overlapping clips in your timeline, you can achieve other types of
transitions by following these steps:</p>
+ <steps>
+ <item>
+ <p>Select the overlapping region by clicking on it.</p>
+ </item>
+ <item>
+ <p>Select the <gui>Transition</gui> tab in the middle pane.</p>
+ </item>
+ <item>
+ <p>Select one of the offered transitions.</p>
+ </item>
+ </steps>
+ <p>The transitions can be further adjusted with the following options from the bottom of the
<gui>Transition</gui> tab:</p>
+ <list>
+ <item>
+ <p><em>Normal mode</em> will apply the transition in a linear fashion over the whole overlapping
region. When in normal mode, you can adjust the degree of sharpness/smoothenss of the transition.</p>
+ </item>
+ <item>
+ <p><em>Loop</em> mode will apply the transition in a circular manner. When in loop mode, you can
adjust the speed with which the transition will repeat itself.</p>
+ </item>
+ <item>
+ <p>In both modes, you can apply the transition in <em>reverse direction</em> by ticking the
corresponding checkbox.</p>
+ </item>
+ </list>
+ <note style="tip">
+ <p>Each transition has its name and description. They are displayed when you hover the cursor over the
transition icon. You can also filter the transitions by typing into the search entry at the top of the
<gui>Transition</gui> tab. This will show only transitions whose name or description match your search
terms.</p>
+ </note>
+ </section>
+ <section id="fades">
+ <title>Fade-ins and fade-outs</title>
+ <p>You can create fade-in and fade-out transitions in single clips by using keyframes controlling the
clip's opacity. For more information on keyframes, see <link xref="keyframecurves">Keyframe curves</link>. To
understand opacity, see <link xref="layers">Understanding layers</link>. The following images illustrate how
to fade a clip to black:</p>
+ <figure>
+ <title>Keyframe curves controlling the video opacity</title>
+ <media type="image" src="figures/fadestep1.png" mime="image/png" style="right"/>
+ <desc>The default curve is flat indicating the same opacity at any position within the clip.</desc>
+ </figure>
+ <figure>
+ <title>Adding a new keyframe</title>
+ <media type="image" src="figures/fadestep2.png" mime="image/png" style="right"/>
+ <desc>Create a new keyframe by clicking the curve in a position where you want to start the
fade-out.</desc>
+ </figure>
+ <figure>
+ <title>Moving the keyframe</title>
+ <media type="image" src="figures/fadestep3.png" mime="image/png" style="right"/>
+ <desc>Click and drag the last keyframe downwards.</desc>
+ </figure>
+ <p>To achieve a fade-in, simply create a mirroring keyframe curve (new keyframe in a position where the
fade-in should end and the first keyframe dragged down) at the beginning of the clip.</p>
+ <note style="tip">
+ <p>Fades and crossfading as described here can be applied to both audio and video clips.</p>
+ </note>
+ </section>
</page>
diff --git a/help/C/trimming.page b/help/C/trimming.page
index 0ae8c11..ccaa08b 100644
--- a/help/C/trimming.page
+++ b/help/C/trimming.page
@@ -1,8 +1,5 @@
-<page xmlns="http://projectmallard.org/1.0/"
- xmlns:e="http://projectmallard.org/experimental/"
- type="topic"
- id="trimming">
-
+<?xml version="1.0" encoding="UTF-8"?>
+<page xmlns="http://projectmallard.org/1.0/" xmlns:e="http://projectmallard.org/experimental/" type="topic"
id="trimming">
<info>
<link type="guide" xref="index#timeline"/>
<revision pkgversion="0.96" version="0.2" date="2016-02-17" status="complete"/>
@@ -25,72 +22,77 @@
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
-
- <title>Trimming</title>
-
- <p><em>Trimming</em> is the act of changing the length of a clip by moving its beginning or end point
in the timeline. Move the mouse cursor over the edge of a clip and a trimming handle will appear. Drag the
trimming handle in an appropriate direction to either reduce or increase the length of the clip.</p>
- <figure>
- <title>Trimming handle</title>
- <desc>The mouse cursor transforms into trimming handle when hovering over the edge of a clip.</desc>
- <media type="image" src="figures/trimming-individual.png" mime="image/png" style="right"></media>
- </figure>
- <p>Clips that are grouped together, such as corresponding audio and video clips, will trim in unison
when you drag the trimming handle. To trim only the audio or only the video clip, you need to ungroup them
first (see the <link xref="selectiongrouping">Selection and grouping</link> page for instructions on how to
do that).</p>
-
- <section id="ripple">
- <title>Ripple editing</title>
- <p>Ripple editing is a variant of basic trimming which, in addition to trimming a clip, also moves
the following clips (the clips that start after the one you're directly editing) so that their relative
position to the edited clip stays the same.</p>
- <figure>
- <title>Before</title>
- <desc>Relative position of two adjacent clips before ripple editing</desc>
- <media type="image" src="figures/ripple-before.png" mime="image/png" style="right"
width="780"></media>
- </figure>
- <figure>
- <title>After</title>
- <desc>Relative position of two adjacent clips after ripple editing</desc>
- <media type="image" src="figures/ripple-after.png" mime="image/png" style="right"></media>
- </figure>
- <note>
- <p>Note that if there is a gap between the clips, the following clip moves toward the edited so
that the gap length stays the same.</p>
- </note>
- <note>
- <p>Ripple editing affects all following clips, regardless of whether or not they are on the same
layer.</p>
- </note>
- <p>To do a ripple edit:
+ <title>Trimming</title>
+ <p><em>Trimming</em> is the act of changing the length of a clip by moving its beginning or end point in
the timeline. Move the mouse cursor over the edge of a clip and a trimming handle will appear. Drag the
trimming handle in an appropriate direction to either reduce or increase the length of the clip.</p>
+ <figure>
+ <title>Trimming handle</title>
+ <desc>The mouse cursor transforms into trimming handle when hovering over the edge of a clip.</desc>
+ <media type="image" src="figures/trimming-individual.png" mime="image/png" style="right"/>
+ </figure>
+ <p>Clips that are grouped together, such as corresponding audio and video clips, will trim in unison when
you drag the trimming handle. To trim only the audio or only the video clip, you need to ungroup them first
(see the <link xref="selectiongrouping">Selection and grouping</link> page for instructions on how to do
that).</p>
+ <section id="ripple">
+ <title>Ripple editing</title>
+ <p>Ripple editing is a variant of basic trimming which, in addition to trimming a clip, also moves the
following clips (the clips that start after the one you're directly editing) so that their relative position
to the edited clip stays the same.</p>
+ <figure>
+ <title>Before</title>
+ <desc>Relative position of two adjacent clips before ripple editing</desc>
+ <media type="image" src="figures/ripple-before.png" mime="image/png" style="right" width="780"/>
+ </figure>
+ <figure>
+ <title>After</title>
+ <desc>Relative position of two adjacent clips after ripple editing</desc>
+ <media type="image" src="figures/ripple-after.png" mime="image/png" style="right"/>
+ </figure>
+ <note>
+ <p>Note that if there is a gap between the clips, the following clip moves toward the edited so that
the gap length stays the same.</p>
+ </note>
+ <note>
+ <p>Ripple editing affects all following clips, regardless of whether or not they are on the same
layer.</p>
+ </note>
+ <p>To do a ripple edit:
</p>
- <steps>
- <item><p>Place the mouse cursor on a trimming handle.</p></item>
- <item><p>Press and hold <key>Shift</key>.</p></item>
- <item><p>Drag the trimming handle.</p></item>
- </steps>
- <note style="tip">
- <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="usingclips#ripple">Using ripple editing while
moving clips</link>.</p>
- </note>
- </section>
-
- <section id="rollediting">
- <title>Roll editing</title>
- <p>Roll editing is a variant of basic trimming which, in addition to trimming a clip, <em>trims</em>
the adjacent clips in a complementary way to prevent creating gaps.</p>
- <figure>
- <title>Before</title>
- <desc>Relative position of two adjacent clips before roll editing</desc>
- <media type="image" src="figures/roll-before.png" mime="image/png" style="right" width="780"></media>
- </figure>
- <figure>
- <title>After</title>
- <desc>Relative position of two adjacent clips after roll editing</desc>
- <media type="image" src="figures/roll-after.png" mime="image/png" style="right" width="780"></media>
- </figure>
- <note>
- <p>Roll editing affects all adjacent clips, regardless of whether or not they are on the same
layer.</p>
- </note>
- <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>
-
-
-
+ <steps>
+ <item>
+ <p>Place the mouse cursor on a trimming handle.</p>
+ </item>
+ <item>
+ <p>Press and hold <key>Shift</key>.</p>
+ </item>
+ <item>
+ <p>Drag the trimming handle.</p>
+ </item>
+ </steps>
+ <note style="tip">
+ <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="usingclips#ripple">Using ripple editing while moving
clips</link>.</p>
+ </note>
+ </section>
+ <section id="rollediting">
+ <title>Roll editing</title>
+ <p>Roll editing is a variant of basic trimming which, in addition to trimming a clip, <em>trims</em> the
adjacent clips in a complementary way to prevent creating gaps.</p>
+ <figure>
+ <title>Before</title>
+ <desc>Relative position of two adjacent clips before roll editing</desc>
+ <media type="image" src="figures/roll-before.png" mime="image/png" style="right" width="780"/>
+ </figure>
+ <figure>
+ <title>After</title>
+ <desc>Relative position of two adjacent clips after roll editing</desc>
+ <media type="image" src="figures/roll-after.png" mime="image/png" style="right" width="780"/>
+ </figure>
+ <note>
+ <p>Roll editing affects all adjacent clips, regardless of whether or not they are on the same
layer.</p>
+ </note>
+ <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
index ae0188a..56b82c6 100644
--- a/help/C/usingclips.page
+++ b/help/C/usingclips.page
@@ -1,8 +1,5 @@
-<page xmlns="http://projectmallard.org/1.0/"
- xmlns:e="http://projectmallard.org/experimental/"
- type="topic"
- id="usingclips">
-
+<?xml version="1.0" encoding="UTF-8"?>
+<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.96" version="0.2" date="2016-02-17" status="complete"/>
@@ -25,47 +22,52 @@
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
-
- <title>Using clips</title>
-
- <section id="clipsfiles">
- <title>Clips vs files</title>
- <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>
- <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 <gui>Media Library</gui> 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>
- <note>
- <p>Since Pitivi is a non-destructive editor, clips are edited, not files. As such, your files stay
intact.</p>
- </note>
- </section>
-
- <section id="inserting">
- <title>Inserting clips</title>
- <p>From the <gui>Media Library</gui>, you can insert one or more clips by selecting them (use the
<key>Ctrl</key> or <key>Shift</key> keys to select multiple clips) and doing one of the following:</p>
- <list>
- <item><p>Dragging and dropping them onto a place in the timeline.</p></item>
- <item><p>Clicking the <gui>Insert the selected clips at the end of the timeline</gui> button in the
<gui>Media Library</gui> header.</p></item>
- <item><p>Pressing the <key>Insert</key> key.</p></item>
- </list>
- <p>
- When following the second and third options (clicking or pressing insert), the new clips will be
inserted one after another on the longest layer of the timeline where the last clip ends.
- </p>
- </section>
-
- <section id="moving">
- <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
(see <link xref="layers">Understanding layers</link> for more information).</p>
- <p>To move a clip to an existing layer, drag it on the layer at the desired position and release it.
To move a clip to a new layer, drag it to the middle space between two existing layers. Once the space
between the respective layers is highlighted, release it.</p>
- <p>To move multiple clips at the same time, use the <key>Ctrl</key> or <key>Shift</key> keys to
select multiple clips (see <link xref="selectiongrouping">Selection and grouping</link> for more details).
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 id="ripple">
- <title>Using ripple editing while moving clips</title>
- <p>While dragging clips around in the timeline, you can use the <link xref="trimming#ripple">ripple
technique</link> to move the <em>following</em> clips (the clips that start after the one you're directly
editing) in sync with the moved clip.</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>You can release and press <key>Shift</key> at any time during the drag operation to disable or
enable ripple editing.</p>
- </section>
- </section>
-
+ <title>Using clips</title>
+ <section id="clipsfiles">
+ <title>Clips vs files</title>
+ <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>
+ <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
<gui>Media Library</gui> 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>
+ <note>
+ <p>Since Pitivi is a non-destructive editor, clips are edited, not files. As such, your files stay
intact.</p>
+ </note>
+ </section>
+ <section id="inserting">
+ <title>Inserting clips</title>
+ <p>From the <gui>Media Library</gui>, you can insert one or more clips by selecting them (use the
<key>Ctrl</key> or <key>Shift</key> keys to select multiple clips) and doing one of the following:</p>
+ <list>
+ <item>
+ <p>Dragging and dropping them onto a place in the timeline.</p>
+ </item>
+ <item>
+ <p>Clicking the <gui>Insert the selected clips at the end of the timeline</gui> button in the
<gui>Media Library</gui> header.</p>
+ </item>
+ <item>
+ <p>Pressing the <key>Insert</key> key.</p>
+ </item>
+ </list>
+ <p>When following the second and third options (clicking or pressing insert), the new clips will be
inserted one after another on the longest layer of the timeline where the last clip ends.</p>
+ </section>
+ <section id="moving">
+ <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
(see <link xref="layers">Understanding layers</link> for more information).</p>
+ <p>To move a clip to an existing layer, drag it on the layer at the desired position and release it. To
move a clip to a new layer, drag it to the middle space between two existing layers. Once the space between
the respective layers is highlighted, release it.</p>
+ <p>To move multiple clips at the same time, use the <key>Ctrl</key> or <key>Shift</key> keys to select
multiple clips (see <link xref="selectiongrouping">Selection and grouping</link> for more details). 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 id="ripple">
+ <title>Using ripple editing while moving clips</title>
+ <p>While dragging clips around in the timeline, you can use the <link xref="trimming#ripple">ripple
technique</link> to move the <em>following</em> clips (the clips that start after the one you're directly
editing) in sync with the moved clip.</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>You can release and press <key>Shift</key> at any time during the drag operation to disable or
enable ripple editing.</p>
+ </section>
+ </section>
</page>
diff --git a/help/C/usingeffects.page b/help/C/usingeffects.page
index 56d6c21..0e85d2d 100644
--- a/help/C/usingeffects.page
+++ b/help/C/usingeffects.page
@@ -1,8 +1,5 @@
-<page xmlns="http://projectmallard.org/1.0/"
- xmlns:e="http://projectmallard.org/experimental/"
- type="topic"
- id="usingeffects">
-
+<?xml version="1.0" encoding="UTF-8"?>
+<page xmlns="http://projectmallard.org/1.0/" xmlns:e="http://projectmallard.org/experimental/" type="topic"
id="usingeffects">
<info>
<link type="guide" xref="index#effectstransitions"/>
<revision pkgversion="0.96" version="0.2" date="2016-02-17" status="draft"/>
@@ -19,24 +16,22 @@
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
-
- <title>Using effects</title>
-
- <section id="library">
- <title>Effect Library</title>
- <p>The <gui>Effect Library</gui> contains all audio and video effects available on the system. The
library shows either audio or video effects depending on which button (<gui>Show video effects</gui> or
<gui>Show audio effects</gui>) in its upper left corner is activated. Once you choose audio or video effects
you can further sort them by choosing one of the categories from the drop down list next to the two buttons.
By default, the list is set to show all effects.</p>
- <p>Alternatively, you can use the <gui>Search Bar</gui> that is shown at the top of the <gui>Effect
Library</gui>. Typing into the search entry filters the contents of the <gui>Effect Library</gui> to show
only effects whose name or description match your search terms. To reset the search entry, click the
<gui>Clear</gui> icon in the search entry.</p>
- </section>
- <section id="configuring">
- <title>Configuring effects</title>
- <p>To configure an effect, simply select it in the <guiseq><gui>middle pane</gui><gui>Clip
configuration</gui><gui>Effects</gui></guiseq>. The properties that can be adjusted will appear below in the
same tab. Each variable can be put back to its original value by clicking the corresponding <gui>Reset to
default value</gui> button.</p>
- </section>
- <section id="keyframes">
- <title>Animating effects with keyframes</title>
- <p>The effect properties which can be controlled using keyframe curves have a <gui>Show keyframes
for this property</gui> button. When you click it, the keyframe curves on the clip start controlling the
respective property. You can now edit the keyframes to achieve the desired effect. Once you are done with
editing, you can click the button again and the keyframe curve disappears from the clip. However, the effect
property is still controlled by the adjusted keyframe curve (which is indicated by the filled shape on the
button).</p>
- <p>Once a property becomes controlled, the widget for editing the property value directly is
disabled. To remove the keyframes and be able to set again directly a constant value using the widget, you
have to click the <gui>Reset to default value</gui> button. For more information on how to use keyframes see
the <link xref="keyframecurves">Keyframe curves</link> page.</p>
- <note>
- <p>If there is no <gui>Show keyframes for this value</gui> button next to the effect variable,
it cannot be controlled with keyframes.</p>
- </note>
- </section>
+ <title>Using effects</title>
+ <section id="library">
+ <title>Effect Library</title>
+ <p>The <gui>Effect Library</gui> contains all audio and video effects available on the system. The
library shows either audio or video effects depending on which button (<gui>Show video effects</gui> or
<gui>Show audio effects</gui>) in its upper left corner is activated. Once you choose audio or video effects
you can further sort them by choosing one of the categories from the drop down list next to the two buttons.
By default, the list is set to show all effects.</p>
+ <p>Alternatively, you can use the <gui>Search Bar</gui> that is shown at the top of the <gui>Effect
Library</gui>. Typing into the search entry filters the contents of the <gui>Effect Library</gui> to show
only effects whose name or description match your search terms. To reset the search entry, click the
<gui>Clear</gui> icon in the search entry.</p>
+ </section>
+ <section id="configuring">
+ <title>Configuring effects</title>
+ <p>To configure an effect, simply select it in the <guiseq><gui>middle pane</gui><gui>Clip
configuration</gui><gui>Effects</gui></guiseq>. The properties that can be adjusted will appear below in the
same tab. Each variable can be put back to its original value by clicking the corresponding <gui>Reset to
default value</gui> button.</p>
+ </section>
+ <section id="keyframes">
+ <title>Animating effects with keyframes</title>
+ <p>The effect properties which can be controlled using keyframe curves have a <gui>Show keyframes for
this property</gui> button. When you click it, the keyframe curves on the clip start controlling the
respective property. You can now edit the keyframes to achieve the desired effect. Once you are done with
editing, you can click the button again and the keyframe curve disappears from the clip. However, the effect
property is still controlled by the adjusted keyframe curve (which is indicated by the filled shape on the
button).</p>
+ <p>Once a property becomes controlled, the widget for editing the property value directly is disabled.
To remove the keyframes and be able to set again directly a constant value using the widget, you have to
click the <gui>Reset to default value</gui> button. For more information on how to use keyframes see the
<link xref="keyframecurves">Keyframe curves</link> page.</p>
+ <note>
+ <p>If there is no <gui>Show keyframes for this value</gui> button next to the effect variable, it
cannot be controlled with keyframes.</p>
+ </note>
+ </section>
</page>
diff --git a/help/C/welcomedialog.page b/help/C/welcomedialog.page
index 9c28e59..750438c 100644
--- a/help/C/welcomedialog.page
+++ b/help/C/welcomedialog.page
@@ -1,8 +1,5 @@
-<page xmlns="http://projectmallard.org/1.0/"
- xmlns:e="http://projectmallard.org/experimental/"
- type="topic"
- id="welcomedialog">
-
+<?xml version="1.0" encoding="UTF-8"?>
+<page xmlns="http://projectmallard.org/1.0/" xmlns:e="http://projectmallard.org/experimental/" type="topic"
id="welcomedialog">
<info>
<link type="guide" xref="index#intro"/>
<revision pkgversion="0.96" version="0.3" date="2016-02-17" status="complete"/>
@@ -21,17 +18,24 @@
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
-
- <title>The welcome dialog</title>
- <p>When you launch <app>Pitivi</app>, a startup assistant appears, allowing you to create a new
project or open an existing project in a few clicks. If you want to skip this dialog, press the
<key>Escape</key> key on your keyboard or click the window's close button. Skipping the dialog will open a
new project with default settings.</p>
- <p>The dialog offers you projects that are found among the recently used files. Double-click one of
them to load it or use one of the following buttons:</p>
- <list type="numbered">
- <item><p><gui>New</gui> opens a new project with the default settings.</p></item>
- <item><p><gui>Browse projects...</gui> opens file chooser in the last used directory.</p></item>
- <item><p><gui>Help</gui> opens the user documenation on the index page.</p></item>
- <item><p><gui>Keyboard shortcuts</gui> opens the user documentation on the Keyboard shortcuts and
cheatsheet page.</p></item>
- </list>
- <note style="tip">
- <p>By right-clicking the individual projects offered by the <gui>Welcome dialog</gui> you can get more
options: copy project's location, remove project from the list, clear the list, or show private resources.</p>
- </note>
+ <title>The welcome dialog</title>
+ <p>When you launch <app>Pitivi</app>, a startup assistant appears, allowing you to create a new project or
open an existing project in a few clicks. If you want to skip this dialog, press the <key>Escape</key> key on
your keyboard or click the window's close button. Skipping the dialog will open a new project with default
settings.</p>
+ <p>The dialog offers you projects that are found among the recently used files. Double-click one of them
to load it or use one of the following buttons:</p>
+ <list type="numbered">
+ <item>
+ <p><gui>New</gui> opens a new project with the default settings.</p>
+ </item>
+ <item>
+ <p><gui>Browse projects...</gui> opens file chooser in the last used directory.</p>
+ </item>
+ <item>
+ <p><gui>Help</gui> opens the user documenation on the index page.</p>
+ </item>
+ <item>
+ <p><gui>Keyboard shortcuts</gui> opens the user documentation on the Keyboard shortcuts and cheatsheet
page.</p>
+ </item>
+ </list>
+ <note style="tip">
+ <p>By right-clicking the individual projects offered by the <gui>Welcome dialog</gui> you can get more
options: copy project's location, remove project from the list, clear the list, or show private resources.</p>
+ </note>
</page>
diff --git a/help/C/workwithprojects.page b/help/C/workwithprojects.page
index 3474a3c..1c6e92a 100644
--- a/help/C/workwithprojects.page
+++ b/help/C/workwithprojects.page
@@ -1,8 +1,5 @@
-<page xmlns="http://projectmallard.org/1.0/"
- xmlns:e="http://projectmallard.org/experimental/"
- type="topic"
- id="workwithprojects">
-
+<?xml version="1.0" encoding="UTF-8"?>
+<page xmlns="http://projectmallard.org/1.0/" xmlns:e="http://projectmallard.org/experimental/" type="topic"
id="workwithprojects">
<info>
<link type="guide" xref="index#gettingstarted"/>
<revision pkgversion="0.96" version="0.5" date="2016-02-17" status="complete"/>
@@ -25,38 +22,34 @@
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
-
- <title>Working with projects</title>
-
- <section id="saving">
+ <title>Working with projects</title>
+ <section id="saving">
<title>Saving a project</title>
- <p>To save your project work, use the <gui>Save</gui> button in the header bar or press
<keyseq><key>Ctrl</key><key>S</key></keyseq>. 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>
- <note style="tip">
+ <p>To save your project work, use the <gui>Save</gui> button in the header bar or press
<keyseq><key>Ctrl</key><key>S</key></keyseq>. 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>
+ <note style="tip">
<p>If you want to save your project to a different file, use <guiseq><gui>App menu</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>
- </note>
- </section>
- <section id="undoing">
- <title>Undoing and reverting changes</title>
- <p>To undo a change, simply click on the <gui>Undo</gui> button in the header bar or press
<keyseq><key>Ctrl</key><key>Z</key></keyseq>. In addition to undoing individual changes, you can also decide
to revert all the changes you have made since the last time you saved your project. To do so, use
<guiseq><gui>App menu</gui><gui>Revert to saved version</gui></guiseq>.</p>
- <note style="tip">
- <p>To redo changes that were undone, click on the <gui>Redo</gui> button in the header bar or
press <keyseq><key>Ctrl</key><key>Shift</key><key>Z</key></keyseq>.</p>
- </note>
- </section>
-
- <section id="projectsettings">
- <title>Editing the project settings</title>
- <p>The project settings define mainly how the video appears while you edit the project. The video
resolution and aspect ratio affect the appearance of the previewer. If the resolution and aspect ratio do not
match those of your footage, the video may look squished or letterboxed. These settings can be changed at any
time by using <guiseq><gui>App menu</gui><gui>Project Settings</gui></guiseq>.</p>
- <note>
- <p>When you import the first video file the project settings are automatically changed to match. See
<link xref="importing">Getting media</link> for details.</p>
- </note>
- </section>
-
- <section id="pardar">
- <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. 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
through 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>
- <note>
- <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>
- </note>
- </section>
+ </note>
+ </section>
+ <section id="undoing">
+ <title>Undoing and reverting changes</title>
+ <p>To undo a change, simply click on the <gui>Undo</gui> button in the header bar or press
<keyseq><key>Ctrl</key><key>Z</key></keyseq>. In addition to undoing individual changes, you can also decide
to revert all the changes you have made since the last time you saved your project. To do so, use
<guiseq><gui>App menu</gui><gui>Revert to saved version</gui></guiseq>.</p>
+ <note style="tip">
+ <p>To redo changes that were undone, click on the <gui>Redo</gui> button in the header bar or press
<keyseq><key>Ctrl</key><key>Shift</key><key>Z</key></keyseq>.</p>
+ </note>
+ </section>
+ <section id="projectsettings">
+ <title>Editing the project settings</title>
+ <p>The project settings define mainly how the video appears while you edit the project. The video
resolution and aspect ratio affect the appearance of the previewer. If the resolution and aspect ratio do not
match those of your footage, the video may look squished or letterboxed. These settings can be changed at any
time by using <guiseq><gui>App menu</gui><gui>Project Settings</gui></guiseq>.</p>
+ <note>
+ <p>When you import the first video file the project settings are automatically changed to match. See
<link xref="importing">Getting media</link> for details.</p>
+ </note>
+ </section>
+ <section id="pardar">
+ <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. 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 through
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>
+ <note>
+ <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>
+ </note>
+ </section>
</page>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]