]> Shamusworld >> Repos - ardour-manual/commitdiff
Documenting the Region and Track menus
authorEd Ward <edwsaintesprit@hotmail.com>
Mon, 16 Jan 2017 14:33:37 +0000 (15:33 +0100)
committerEd Ward <edwsaintesprit@hotmail.com>
Mon, 16 Jan 2017 14:33:37 +0000 (15:33 +0100)
_manual/05_ardours-interface/01_main-menu/03_Edit-menu.html
_manual/05_ardours-interface/01_main-menu/04_Region-menu.html
_manual/05_ardours-interface/01_main-menu/05_Track-menu.html

index 12d4f2d226264454a65cbd077ebfd4572477eaee..440e991f0d7402651d6887a1f4156258ebd23003 100644 (file)
@@ -46,7 +46,7 @@ title: The Edit Menu
 
        <dt>Delete</dt><dd>Deletes all that is currently selected</dd>
        <dt>Crop</dt><dd>Cuts the parts of the regions that are outside the range boundaries. Only applies on the regions that belong at least in part to the range.</dd>
-       <dt>Split/Separate</dt><dd>Cuts the selected regions at the edit points, separating them in two regions</dd>
+       <dt>Split/Separate</dt><dd>Cuts the selected regions at the Edit point, separating them in two regions</dd>
        <dt>Separate</dt>
                <dt class="sub1">Separate Under</dt><dd>Removes all the parts of the regions that are under the selected one. Once done, the selected region is alone on its part of the track.</dd>
                <dt class="sub1">Separate Using Loop Range</dt><dd>Cuts the selected regions or the regions on the selected tracks along the Loop range's start and end markers. If nothing is selected, acts on all tracks at once.</dd>
index 613782152135ab58722c764050163e6ddb288de5..94e6aee66601712070af3201cca3e92c135a9021 100644 (file)
@@ -2,87 +2,89 @@
 title: The Region Menu
 ---
 
-<p class="fixme">Describe the items</p>
+<p>
+       The <kbd class="menu">Region</kbd> Menu is where the user can tweak its regions, the parts of audio or MIDI that sit on the timeline.
+</p>
 
+<dl>
+       <dt>Insert Region from Region List</dt><dd>If a region is selected in the Editor List, add it at the Edit point</dd>
+       <dt>Play</dt><dd>Starts playback at the beginning of the selected region(s), and stops at its(their) end</dd>
+       <dt>Loop</dt><dd>Creates a loop range on the selected region's boundaries, and starts the looped playback</dd>
+       <dt>Rename...</dt><dd>Changes the name of the region, that appears in its top left area</dd>
+       <dt>Properties...</dt><dd>Shows the <kbd class="menu">Region properties</kbd> window, that displays detailed information about the region and allow for some modifications</dd>
+       <dt>Loudness Analysis...</dt><dd>Shows the <kbd class="menu">Audio Report/Analysis</kbd> window, that displays detailed <a href="/meters/">dBFS information</a> as well as a spectrogram (dBFS of frequency against time)</dd>
+       <dt>Spectral Analysis...</dt><dd>Shows the <kbd class="menu">Audio Report/Analysis</kbd> window, that displays a integrated spectral view of the region (dBFS agaisnt frequency)</dd>
+       <dt>Edit</dt>
+               <dt class="sub1">Combine</dt><dd>Creates a new region by joining the selected audio regions in the same track, and replaces those region with the newly created compound. The same rules are applied to create the compound as for playback regarding e.g. layering</dd>
+               <dt class="sub1">Uncombine</dt><dd>Splits back the compound created by <em>combining</em> into its original audio regions</dd>
+               <dt class="sub1">Pitch Shift...</dt><dd>Changes the tune of the audio region, by octave, semitones or percentage, based on spectral analysis. Optionaly, and if they have been set for the region, preserves the formants</dd>
+               <dt class="sub1">Split/Separate</dt><dd>Cuts the selected regions at the Edit point, separating them in two regions</dd>
+               <dt class="sub1">Split at Percussion Onset</dt><dd>Allows splitting the selected regions on its PErcussion Onsets marker as set by the Rhythm Ferret (Not usable as of 5.5)</dd>
+               <dt class="sub1">Make Mono Regions</dt><dd>Creates mono regions out of a stereo or multichannel region by splitting it into its discrete channels. The created regions are added to the Editor List</dd>
+               <dt class="sub1">Close Gaps</dt><dd>Extends (or reduces) the selected regions to be perfecltly aligned. Optionnaly, sets up a crossfade duration, or a pull-back (spacing between regions)</dd>
+               <dt class="sub1">Place Transient</dt><dd>Places a transient at the Edit Point. Used e.g. for the <kbd class="menu">Pitch Shift...</kbd> action</dd>
+               <dt class="sub1">Rhythm Ferret...</dt><dd>Opens the <kbd class="menu">Rhythm Ferret</kbd> which is a powerfull tool to sequence audio files</dd>
+               <dt class="sub1">Strip Silence...</dt><dd>Opens the <kbd class="menu">Strip Silence</kbd> window which is a very handy tool to remove all audio under a user-chosen threshold (with a preview)</dd>
+               <dt class="sub1">Reverse</dt><dd>Mirrors the audio horizontally</dd>
+       <dt>Layering</dt>
+               <dt class="sub1">Raise to Top</dt><dd>On overlapping regions, puts the selected one(s) on top</dd>
+               <dt class="sub1">Raise</dt><dd>On overlapping region, makes the selected one(s) one layer higher</dd>
+               <dt class="sub1">Lower</dt><dd>Makes the selected region(s) one layer lower</dd>
+               <dt class="sub1">Lower to Bottom</dt><dd>Sends the selected region to the background</dd>
+       <dt>MIDI</dt>
+               <dt class="sub1">Transpose...</dt><dd>On a MIDI region, shows the <a href="/editing-and-arranging/edit-midi/transpose-midi/"><kbd class="menu">Transpose MIDI</kbd> window</a>, allowing to shift the pitch of the whole MIDI region by &plusmn; <em>n</em> semitones or octaves</dd>
+               <dt class="sub1">Insert Patch Change...</dt><dd>Inserts a patch change at the Edit Point, allowing a change of patch, channel, program and/or bank</dd>
+               <dt class="sub1">Quantize...</dt><dd>Shows the <a href="/editing-and-arranging/edit-midi/quantize-midi/"><kbd class="menu">Quantize</kbd> window</a>, allowing to perfectly align the MIDI notes to the musical grid</dd>
+               <dt class="sub1">Legatize</dt><dd>Shortens or elongates the MIDI notes to make them perfectly sequentials, i.e. the end of a note is the start of the following one</dd>
+               <dt class="sub1">Remove Overlap</dt><dd>FIXME Shortens or elongates the MIDI notes to make them perfectly sequentials, i.e. the end of a note is the start of the following one</dd>
+               <dt class="sub1">Transform...</dt><dd><a href="/editing-and-arranging/edit-midi/transformation-midi/"><kbd class="menu">Transform</kbd> window</a>, that allows for mathematical operations on the midi notes</dd>
+               <dt class="sub1">Unlink from Other copies</dt><dd>Makes the selected MIDI region independant, e.g. editing this region won't affect any other one.</dd>
+               <dt class="sub1">List Editor...</dt><dd>Shows the <kbd class="menu">List Editor</kbd> which sequentially lists all the MIDI events in the region, and allows for precise modifications</dd>
+       <dt>Gain</dt>
+               <dt class="sub1">[] Opaque</dt><dd>When checked, makes the region opaque audio-wise, i.e., the underlying regions won't be audible</dd>
+               <dt class="sub1">[] Mute</dt><dd>When checked, mutes <em>only</em> the selected region on the track, without muting the track. The muted regions will have <em>!!</em> prepended to their name and will be semi-transparent</dd>
+               <dt class="sub1">Normalize...</dt><dd>Shows the <kbd class="menu">Normalize region</kbd> dialog, which allows to scale the region level by setting its maximum level, optionaly constraining the RMS</dd>
+               <dt class="sub1">Boost Gain</dt><dd>Increases the gain on the selected region by boosting the audio, without touching the enveloppe or automation</dd>
+               <dt class="sub1">Cut Gain</dt><dd>Reduces the gain without touching the enveloppe or automation</dd>
+               <dt class="sub1">Reset Envelope</dt><dd>If the gain enveloppe has been edited, resets it to its initial value (constant at 0 dB)</dd>
+               <dt class="sub1">[] Envelope Active</dt><dd>When unchecked, disables any enveloppe editing that has been made. The enveloppe will be displayed in yellow instead of green.</dd>
+       <dt>Position</dt>
+               <dt class="sub1">Move to Original Position</dt><dd>Moves the region where it was initially recorded or inserted in the session</dd>
+               <dt class="sub1">Snap Position to Grid</dt><dd>If the Grid Mode is set to <em>Grid</em>, snaps the region to the nearest grid line</dd>
+               <dt class="sub1">[] Lock</dt><dd>Blocks the selected regions at their current positions in time and tracks, avoiding any movement on the timeline. The region name will be surrounded by <em>&gt;</em> and <em>&lt;</em> brackets</dd>
+               <dt class="sub1">[] Glue to Bars and Beats</dt><dd>Locks the region position to relative to the musical grid, i.e. a change of tempo will move the region to keep it on the same bar/beat</dd>
+               <dt class="sub1">[] Lock to Video</dt><dd>Same as above, relative to the position in the video</dd>
+               <dt class="sub1">Set Sync Position</dt><dd>Creates or move the Sync position, i.e. the point of the region that will be aligned or snapped to the grid, and that is (by default) the beggining of the region.</dd>
+               <dt class="sub1">Remove Sync</dt><dd>Removes any user defined Sync point, and resets the sync position to the beginning of the region</dd>
+               <dt class="sub1">Nudge Later</dt><dd>Moves the region to the right by the amount shown in the <a href="/ardours-interface/the-editor/the-toolbar/the-nudge-controls/">nudge timer</a></dd>
+               <dt class="sub1">Nudge Earlier</dt><dd>Same as above, to the left</dd>
+               <dt class="sub1">Nudge Later by Capture Offset</dt><dd>Moves the region to the right by the capture latency computed by ardour based on the user's settings regarding latency</dd>
+               <dt class="sub1">Nudge Earlier by Capture Offset</dt><dd>Same as above, to the left</dd>
+               <dt class="sub1">Sequence Regions</dt><dd>Puts the selected regions one after the other, so that the end of one region is the beggining of the next one, removing any overlap or silence. The reference point is the earliest region.</dd>
+       <dt>Trim</dt>
+               <dt class="sub1">Trim Start at Edit Point</dt><dd>If the Edit Point is within the region boundaries, shortens the region to align its start with the Edit Point</dd>
+               <dt class="sub1">Trim End at Edit Point</dt><dd>Same as above, for the end of the region</dd>
+               <dt class="sub1">Trim to Loop</dt><dd>Uses both the start and end Loop markers to shorten the region</dd>
+               <dt class="sub1">Trim to Punch</dt><dd>Same as above with the Punch markers</dd>
+               <dt class="sub1">Trim to Previous</dt><dd>On overlapping regions, shortens the selected one so that the previous region is complete, i.e. the new start point for the selected region is the end point of the previous region on the timeline</dd>
+               <dt class="sub1">Trim to Next</dt><dd>Same as above, with the end of the selected region aligned to the start of the following one.</dd>
+       <dt>Ranges</dt>
+               <dt class="sub1">Set Loop Range</dt><dd>Creates a Loop range based on the selected regions, i.e. the strt of the loop range is the start of the earliest region, and the end of the loop is the end of the latest region.</dd>
+               <dt class="sub1">Set Punch</dt><dd>Same as above, for the Punch range</dd>
+               <dt class="sub1">Add Single Range Marker</dt><dd>Same as above, for the Edit range</dd>
+               <dt class="sub1">Add Range Marker Per Region</dt><dd>For each selected region, creates its own Edit range based on the boundaries of each region</dd>
+               <dt class="sub1">Set Range Selection</dt><dd>Creates a range selection based on the boundaries of the selected regions</dd>
+       <dt>Fades</dt>
+               <dt class="sub1">[] Fade In</dt><dd>Activates/desactivates the Fade In at the start of the region</dd>
+               <dt class="sub1">[] Fade Out</dt><dd>Same as above, for the Fade out at the end of the region</dd>
+               <dt class="sub1">[] Fades</dt><dd>Shortcut to activate/desactivate both the fade in and fade out</dd>
+       <dt>Duplicate</dt>
+               <dt class="sub1">Duplicate</dt><dd>Creates a copy of the selected region(s) and happend it to the original</dd>
+               <dt class="sub1">Multi-Duplicate...</dt><dd>Shows the <kbd class="menu">Duplicate</kbd> dialog, allowing to create multiple copies, or a not-integer number of copies (the last one will then be truncated)</dd>
+               <dt class="sub1">Fill Track</dt><dd>Creates duplicates until it fills the session, i.e. reaches the End marker of the session. The last duplicate may be truncated to fit in</dd>
+       <dt>Export...</dt><dd>Shows the <a href="/exporting/export-dialog/"><kbd class="menu">Export</kbd> dialog</a>, with all parameters set to export only the selected region(s)</dd>
+       <dt>Bounce (without processing)</dt><dd>Creates a bounce, i.e. a version of the region with all the edits (boundaries, enveloppe), as a new region in the Editor List, without any of the effects of the mixer strip</dd>
+       <dt>Bounce (with processing)</dt><dd>Same as above, <em>with</em> the effects of the mixer strip</dd>
 
-Region
-       Insert Region from Region List
-       Play
-       Loop
-       Rename...
-       Properties...
-       Loudness Analysis...
-       Spectral Analysis...
-       Edit
-               Combine
-               Uncombine
-               Pitch Shift...
-               Split/Separate
-               Split at Percussion Onset
-               Make Mono Regions
-               Close Gaps
-               Place Transient
-               Rhythm Ferret...
-               Strip Silence...
-               Reverse
-       Layering
-               Raide to Top
-               Raise
-               Lower
-               Lower to Bottom
-       MIDI
-               Transpose...
-               Insert Patch Change...
-               Quantize...
-               Legatize
-               Remove Overlap
-               Transform...
-               Unlink from Other copies
-               List Editor...
-       Gain
-               [] Opaque
-               [] Mute
-               Normalize...
-               Boost Gain
-               Cut Gain
-               Reset Envelope
-               [] Envelope Active
-       Position
-               Move to Original Position
-               Snap Position to Grid
-               [] Lock
-               [] Glue to Bars and Beats
-               [] Lock to Video
-               Set Sync Position
-               Remove Sync
-               Nudge Later
-               Nudge Earlier
-               Nudge Later by Capture Offset
-               Nudge Earlier by Capture Offset
-               Sequence Regions
-       Trim
-               Trim Start at Edit Point
-               Trim End at Edit Point
-               Trim to Loop
-               Trim to Punch
-               Trim to Previous
-               Trim to Next
-       Ranges
-               Set Loop Range
-               Set Punch
-               Add Single Range Marker
-               Add Range Marker Per Region
-               Set Range Selection
-       Fades
-               [] Fade In
-               [] Fade Out
-               [] Fades
-       Duplicate
-               Duplicate
-               Multi-Duplicate...
-               Fill Track
-       Export...
-       Bounce (without processing)
-       Bounce (with processing)
-       ---
-       Remove
+       <dt>Remove</dt><dd>Deletes the region from the edit (no file is harmed in the process, and the region stays in the Editor for later use)</dd>
+</dl>
index 028af4f681923266db8c0e7a7e38d2ff2c32229d..eba37d3faf06d821622d95481a76211f114ea638 100644 (file)
@@ -2,28 +2,30 @@
 title: The Track Menu
 ---
 
-<p class="fixme">Describe the items</p>
+<p>
+       The <kbd class="menu">Track</kbd> menu is where one can deal with the tracks, busses and control masters.
+</p>
 
+<dl>
+       <dt>Add Track, Bus or VCA...</dt><dd>Shows the <a href="/working-with-tracks/adding-tracks-and-busses/"><kbd class="menu">Add Track, Bus or VCA...</kbd> window</a>, where one can add one or more tracks, busses or control masters to the session and define its parameters</dd>
+       <dt>Duplicate Tracks/Busses...</dt><dd>Shows the <kbd class="menu">Duplicate Tracks and Busses</kbd> window, allowing to duplicate the selected track(s) and optionnaly, its playlist</dd>
 
-Track
-       Add Track, Bus or VCA...
-       Duplicate Tracks/Busses...
-       ---
-       Toggle Record Enable
-       Toggle Solo
-       Toggle Mute
-       ---
-       Insert Time
-       Remove Time
-       Move Selected Tracks Up
-       Move Selected Tracks Down
-       Height
-               Fit Selection (Vertical)
-               Largest
-               Larger
-               Large
-               Normal
-               Small
-       ---
-       Toggle Active
-       Remove
+       <dt>Toggle Record Enable</dt><dd>Sets the Record Enable mode On on the selected track(s). These tracks will record audio/midi next time the global record is active and playback is started.</dd>
+       <dt>Toggle Solo</dt><dd>Sets the solo On on the selected tracks, so only these tracks will play</dd>
+       <dt>Toggle Mute</dt><dd>Mutes the selected tracks, they wont play until unmuted</dd>
+
+       <dt>Insert Time</dt><dd>Shows the <kbd class="menu">Insert Time</kbd> window, allowing to insert a blank time in the selected tracks' playlist. By default, it'll be inserted at the Edit Point, but that can be changed in the dialog, as does the behaviour of the regions</dd>
+       <dt>Remove Time</dt><dd>Same as above, but to remove time</dd>
+       <dt>Move Selected Tracks Up</dt><dd>Changes the position of the selected tracks one track up towards the top. In the mixer, the tracks will be moved to the left.</dd>
+       <dt>Move Selected Tracks Down</dt><dd>Same as above, towards the bottom</dd>
+       <dt>Height</dt>
+               <dt class="sub1">Fit Selection (Vertical)</dt><dd>Will fit the selected track(s) in the window. If too many tracks are selected, they'll be reduced to their minimum height.</dd>
+               <dt class="sub1">Largest</dt><dd>Sets the selected tracks height to a very high value, hence making the tracks wide on screen</dd>
+               <dt class="sub1">Larger</dt><dd>Same as above, but a little less high</dd>
+               <dt class="sub1">Large</dt><dd>Same as above, but again less high</dd>
+               <dt class="sub1">Normal</dt><dd>Sets the height of the track to its default value which is a trade-off between readability and number of tracks displayed</dd>
+               <dt class="sub1">Small</dt><dd>Reduces the size of the tracks to a low value, increasing the number of on screen tracks</dd>
+
+       <dt>Toggle Active</dt><dd>Toggles the active state of a track. An inactive track will be grayed and wont play any sound. That can be seen in the <kbd class="menu">A</kbd> colomn of the <a href="/ardours-interface/the-editor/the-editor_s-lists/tracks-and-busses-list/">Tracks and Busses List</a></dd>
+       <dt>Remove</dt><dd>Deletes this track and its playlist (no file is harmed in the process, and the regions from the playlist stay in the Editor for later use)</dd>
+</dl>