GNOME.org
 

[pitivi] help: Update and reorganize keyframes info

commit c5209d1d06ab96a91bcde2f970e011b5c52ed49e
Author: Alexandru Băluț <alexandru balut gmail com>
Date:   Wed Feb 17 17:38:55 2016 +0100

    help: Update and reorganize keyframes info
    
    Differential Revision: https://phabricator.freedesktop.org/D799

 help/C/keyframecurves.page |   41 +++++++++++++++++++++--------------------
 help/C/transitions.page    |   12 +++++++-----
 help/C/usingeffects.page   |   13 +++++++------
 3 files changed, 35 insertions(+), 31 deletions(-)
---
diff --git a/help/C/keyframecurves.page b/help/C/keyframecurves.page
index 4eeebb2..2252b66 100644
--- a/help/C/keyframecurves.page
+++ b/help/C/keyframecurves.page
@@ -7,7 +7,7 @@
     <link type="guide" xref="index#timeline"/>
     <link type="seealso" xref="usingeffects"/>
     <link type="seealso" xref="transitions"/>
-    <revision pkgversion="0.92" version="0.2" date="2014-03-13" status="complete"/>
+    <revision pkgversion="0.96" version="0.3" date="2016-02-17" status="complete"/>
     <credit type="author">
       <name>Jean-François Fortin Tam</name>
       <email>nekohayo gmail com</email>
@@ -15,9 +15,15 @@
     <credit type="contributor">
       <name>Mario Blättermann</name>
       <email>mariobl gnome org</email>
+    </credit>
+    <credit type="contributor">
       <name>Tomáš Karger</name>
       <email>tomkarger gmail com</email>
     </credit>
+    <credit type="contributor">
+      <name>Alexandru Băluț</name>
+      <email>alexandru balut gmail com</email>
+    </credit>
     <desc>
       Changing properties of a clip over time.
     </desc>
@@ -28,37 +34,32 @@
 
     <title>Keyframe curves</title>
      
-     <p>By using keyframe curves, you can change property values of clips over time. This can be used to 
change opacity or volume just as well as control effect variables at any point in the clip's duration.</p>
+     <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 curve</title>
+     <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 given 
point in time.</p></item>
+         <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, keyframe curves are flat: there are two keyframes with the same value, one at the 
beginning and one at the end of the clip. As a result, the curve connecting the two keyframes is a straight 
horizontal line indicating that the vlaue of a given property is the same at each point in time within the 
clip's duration. To change the value (and the rate of it's change) at any point, you can add one or more 
keyframes to the clip and drag them to appropriate positions representing their values.</p>
-     <note>
-         <p>Currently only linear keyframe curves are supported.</p>
-     </note>
+     <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>
       <title>General usage</title>
-      <p>Keyframe curves are an intrinsic property of clips and can not be removed by the user. The start 
and end keyframes are fixed to the start and end points of the clip, and can not be removed by the user 
either. Besides that, you can:</p>
+      <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 double-clicking on an empty portion of a curve</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>
+       <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 style="tip">
-          <p>You can place the keyframe anywhere on the clip, even if this changes the order of the 
keyframes.</p>
+      <note>
+          <p>Currently only linear keyframe curves are supported.</p>
       </note>
      </section>
-
-     <section>
-      <title>Audio and video curves</title>
-       <p>For volume curves the vertical position represents the volume of the clip on a scale from 0 to 
200%. For video curves, the vertical position represents the alpha (opacity) of the clip on a scale from 0 to 
100%. See the <link xref="layers">Understanding layers</link> page for more details on opacity.</p>
-     </section>
 </page>
diff --git a/help/C/transitions.page b/help/C/transitions.page
index 3591b30..63e30c9 100644
--- a/help/C/transitions.page
+++ b/help/C/transitions.page
@@ -5,7 +5,7 @@
 
   <info>
     <link type="guide" xref="index#effectstransitions"/>
-    <revision pkgversion="0.93" version="0.1" date="2014-03-28" status="draft"/>
+    <revision pkgversion="0.96" version="0.2" date="2016-02-17" status="draft"/>
     <credit type="author">
       <name>Tomáš Karger</name>
       <email>tomkarger gmail com</email>
@@ -13,6 +13,8 @@
     <credit type="contributor">
       <name>Jean-François Fortin Tam</name>
       <email>nekohayo gmail com</email>
+    </credit>
+    <credit type="contributor">
       <name>Mario Blättermann</name>
       <email>mariobl gnome org</email>
     </credit>
@@ -51,18 +53,18 @@
           <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>
+    <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. Keyframes and opacity are explained elsewhere in this manual. 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>
+      <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>Default opacity keyframe curve</title>
+        <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 double-clicking the curve in a position where you want to start the 
fade-out.</desc>
+        <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>
diff --git a/help/C/usingeffects.page b/help/C/usingeffects.page
index b310891..1d6e5eb 100644
--- a/help/C/usingeffects.page
+++ b/help/C/usingeffects.page
@@ -5,7 +5,7 @@
 
   <info>
     <link type="guide" xref="index#effectstransitions"/>
-    <revision pkgversion="0.93" version="0.1" date="2014-03-25" status="draft"/>
+    <revision pkgversion="0.96" version="0.2" date="2016-02-17" status="draft"/>
     <credit type="author">
       <name>Tomáš Karger</name>
       <email>tomkarger gmail com</email>
@@ -24,18 +24,19 @@
 
     <section>
         <title>Effect Library</title>
-        <p><gui>Effect Library</gui> is a place where all available audio and video effects are stored. 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>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>
         <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>. Variables that can be adjusted will appear in the lower part 
of the <gui>Clip configuration</gui> tab. Each variable can be put back to it's original value by clicking 
the corresponding <gui>Reset to default value</gui> button.</p>
+        <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>
+    <section id="keyframes">
         <title>Animating effects with keyframes</title>
-        <p>Most effect variables can be controlled with keyframes. In order to access the keyframes, click 
the <gui>Show keyframes for this value</gui> button next to the variable you want to control. On the selected 
clip you will see a keyframe curve that belongs to the variable. 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 variable is still controlled by the adjusted keyframe curve 
(which is indicated by the filled shape on the button). To revert the keyframe curve to the default flat 
state, use 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>
+        <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 can not be controlled with keyframes.</p>
+            <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>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]