diff --git a/ChangeLog b/ChangeLog index 4390fd3f..659e649e 100644 --- a/ChangeLog +++ b/ChangeLog @@ -23068,3 +23068,6 @@ 2022-05-11 Fred Gleason * Fixed a regression in rdlibrary(1) that caused the disk free space gauge to be disabled. +2022-05-11 Fred Gleason + * Updated the 'Content Management with RDLibrary' chapter of + the Operations Guide. diff --git a/docs/opsguide/Makefile.am b/docs/opsguide/Makefile.am index cd9afadf..0b049765 100644 --- a/docs/opsguide/Makefile.am +++ b/docs/opsguide/Makefile.am @@ -2,7 +2,7 @@ ## ## docs/opsguide/automake.am for Rivendell ## -## (C) Copyright 2017-2020 Fred Gleason +## (C) Copyright 2017-2022 Fred Gleason ## ## This program is free software; you can redistribute it and/or modify ## it under the terms of the GNU General Public License version 2 as @@ -252,6 +252,7 @@ OPSGUIDE_IMAGES = rdadmin.audio_resource_information_dialog.png\ rdlibrary.edit_cut_info_dialog.png\ rdlibrary.edit_macro_cart_dialog.png\ rdlibrary.edit_marker_dialog.png\ + rdlibrary.edit_marker_dialog.marker_menu.png\ rdlibrary.import_export_dialog.png\ rdlibrary.rdlibrary_screenshot.png\ rdlibrary.rip_disk_dialog.png\ diff --git a/docs/opsguide/rdadmin.xml b/docs/opsguide/rdadmin.xml index 0e2b2446..7833b1c8 100644 --- a/docs/opsguide/rdadmin.xml +++ b/docs/opsguide/rdadmin.xml @@ -1,5 +1,5 @@ - + Configuring Rivendell with RDAdmin Overview diff --git a/docs/opsguide/rdlibrary.edit_cart_dialog.png b/docs/opsguide/rdlibrary.edit_cart_dialog.png index 304c4be2..9e0af4ba 100644 Binary files a/docs/opsguide/rdlibrary.edit_cart_dialog.png and b/docs/opsguide/rdlibrary.edit_cart_dialog.png differ diff --git a/docs/opsguide/rdlibrary.edit_cut_info_dialog.png b/docs/opsguide/rdlibrary.edit_cut_info_dialog.png index 84d1bf75..67669567 100644 Binary files a/docs/opsguide/rdlibrary.edit_cut_info_dialog.png and b/docs/opsguide/rdlibrary.edit_cut_info_dialog.png differ diff --git a/docs/opsguide/rdlibrary.edit_macro_cart_dialog.png b/docs/opsguide/rdlibrary.edit_macro_cart_dialog.png index e5da19ce..888fc85a 100644 Binary files a/docs/opsguide/rdlibrary.edit_macro_cart_dialog.png and b/docs/opsguide/rdlibrary.edit_macro_cart_dialog.png differ diff --git a/docs/opsguide/rdlibrary.edit_marker_dialog.marker_menu.png b/docs/opsguide/rdlibrary.edit_marker_dialog.marker_menu.png new file mode 100644 index 00000000..7f5689b2 Binary files /dev/null and b/docs/opsguide/rdlibrary.edit_marker_dialog.marker_menu.png differ diff --git a/docs/opsguide/rdlibrary.edit_marker_dialog.png b/docs/opsguide/rdlibrary.edit_marker_dialog.png index b16adcf1..3c2872bf 100644 Binary files a/docs/opsguide/rdlibrary.edit_marker_dialog.png and b/docs/opsguide/rdlibrary.edit_marker_dialog.png differ diff --git a/docs/opsguide/rdlibrary.import_export_dialog.png b/docs/opsguide/rdlibrary.import_export_dialog.png index eff2a5ff..43f8feb3 100644 Binary files a/docs/opsguide/rdlibrary.import_export_dialog.png and b/docs/opsguide/rdlibrary.import_export_dialog.png differ diff --git a/docs/opsguide/rdlibrary.rdlibrary_screenshot.png b/docs/opsguide/rdlibrary.rdlibrary_screenshot.png index 9689192e..f88aa34b 100644 Binary files a/docs/opsguide/rdlibrary.rdlibrary_screenshot.png and b/docs/opsguide/rdlibrary.rdlibrary_screenshot.png differ diff --git a/docs/opsguide/rdlibrary.xml b/docs/opsguide/rdlibrary.xml index 8702373b..77496a0d 100644 --- a/docs/opsguide/rdlibrary.xml +++ b/docs/opsguide/rdlibrary.xml @@ -1,4 +1,4 @@ - + Content Management with RDLibrary The Rivendell Library Structure and RDLibrary @@ -6,13 +6,15 @@ Carts The Rivendell Library consists of a set of objects called - carts. - A cart is a data container that holds either one or more pieces - of audio (called an audio cart), or macro + carts (short for "cartridge", a nod to the days + when audio material for radio broadcast was commonly loaded to and + played from physical cartridges). + A Rivendell cart is a data container that holds either one or more + pieces of audio (called an audio cart), or macro commands to the system - (called a macro cart). The cart is the + (called a macro cart). Carts are the fundamental schedule - building block in Rivendell, in that it is the smallest object or + building block in Rivendell, in that they are the smallest object or 'atom' that the outside world (like a traffic or music scheduler) can see. @@ -34,13 +36,22 @@ A number of important attributes of carts can be seen from this illustration. First is the cart's number. Each cart in the Library gets assigned a unique number when it is created. This number can - range between 000001 and 999999, and is the primary 'handle' by which + range between 1 and 999999, and is the primary 'handle' by which both Rivendell and external systems (like traffic or music schedulers) refer to the cart. Very often, sites have specific rules concerning which types of audio (commercials, promos, music, etc) and macros get assigned which numbers. We'll cover this area in some detail when we discuss groups. + + Cart numbers in Rivendell are commonly displayed so that they + always have six digits, even if that means adding leading zeros + to the numbers --e.g. cart '123' will be displayed as '000123'. + This convention is used as a visual reminder that the value in + question is a Rivendell cart number, but it is perfectly valid to use + numbers without the leading zeros when inputting cart numbers into + Rivendell. + Immediately to the left of the cart number is an icon indicating the type of cart. Just to the right of the cart number is the @@ -95,8 +106,7 @@ the audio. Care is needed when implementing timescaling within a facility, as there are limits to how much the length can be altered, while only certain types of audio - adapters support it at all. See the Rivendell Technical - Guide for more information. + adapters support it at all. @@ -105,8 +115,21 @@ This is a pull down menu by which the group ownership for - the cart can be set. The system administrator configures - the list of available groups for each user in RDAdmin. + the cart can be set. Every cart in Rivendell belongs to + precisely one group. The system administrator configures + the list of available groups for each user in RDAdmin, and + may also define limits to which cart numbers are allowed + to belong to particular groups. + + + + + Usage + + + This defines the use to which the material is put. It + is included in records generated by the ASCAP/BMI Electronic + Music Report. @@ -139,7 +162,7 @@ - WT + Wt The weighting value for the cut. see @@ -148,7 +171,7 @@ - ORDER + Order The order value for the cut. see @@ -157,17 +180,17 @@ - DESCRIPTION + Description - n arbitrary name, assignable by the user as an aid in keeping + An arbitrary string, assignable by the user as an aid in keeping track of the content, it is roughly analogous to the 'Title' field in the cart label. - LENGTH + Length The actual, measured play out length of the cut audio. @@ -176,7 +199,7 @@ - LAST PLAYED + Last Played he last date and time that the cut was aired by one of the @@ -185,7 +208,7 @@ - # OF PLAYS + # of Plays The total number of times the cut has been aired by the @@ -194,7 +217,7 @@ - ORIGIN + Origin The name of the host upon which the audio in the cut was last @@ -203,16 +226,16 @@ - OUTCUE + Outcue A user settable field. This line shows up in the RDAirPlay - log when the cut is played. + log display when the cut is played. - START DATE + Start Date The effective start date/time of the cut. @@ -220,7 +243,7 @@ - END DATE + End Date The effective end date/time of the cut. @@ -228,7 +251,7 @@ - START DAYPART + Start Daypart The start time of the cut's daypart. @@ -236,7 +259,7 @@ - END DAYPART + End Daypart The start time of the cut's daypart. @@ -244,7 +267,7 @@ - NAME + Name The internal CUTNAME of the cut as used in Rivendell's @@ -266,11 +289,11 @@ Multiple Cuts in a Cart What happens when more than one cut is placed into a cart? The - answer, in a word, is rotation. Rotation is - the ability to + default answer, in a word, is rotation. + Rotation is the ability to schedule a single cart in a log, but to have that cart play out - different material at different times. This capability has a - myriad of uses. One of the simplest, common in commercial radio + different material at different times. This capability has + myriad uses. One of the simplest, common in commercial radio facilities, is to allow multiple versions of a spot to be placed into the system, while still allowing the traffic department to have to track and schedule only one cart number. A more @@ -330,7 +353,7 @@ While not strictly a dayparting parameter, the - WEIGHT setting of a cut can + Weight setting of a cut can strongly influence the order (and hence placement) of when a particular cut will play. The weight value of each cut in a cart consistutes the numerator @@ -419,11 +442,11 @@ - + It's important to remember that the color displayed for each event indicates playability at the instant that the event is being viewed. - + Recording and Auditioning a Cut in the Record Dialog @@ -689,7 +712,7 @@ selecting it and then touching the Delete button, or modified by touching the Edit button. The RML - can be tested, eight line-by-line + can be tested, either line-by-line or as a whole by touching the Run Line or Run Cart button respectively. It is also possible to @@ -720,7 +743,7 @@ The uppermost section of RDLibrary's main window contains tools designed to allow for fast searching of the entire audio library, making locating a particular piece of audio easy even in a library - containing thousands of carts. It's possible to control what carts + containing thousands of carts. It's possible to control what carts are listed, as well as how they are sorted. @@ -728,18 +751,18 @@ The order in which carts are displayed in the cart list can be changed by simply clicking on the header of the column by which - you want them sorted by. By default, the carts are sorted by Cart - Number. To instead sort them alphabetically by Title, simply click - the TITLE header once. - To sort them by Title in reverse –i.e. - from 'Z' to 'A' – click the TITLE + you want them sorted by. By default, the carts are sorted by Cart + Number. To sort them alphabetically by Title instead, simply click + the Title header once. + To sort them by Title in reverse --i.e. + from 'Z' to 'A' – click the Title header once again. Clicking the - TITLE header a third time restores + Title header a third time restores the sort to normal 'A' to 'Z' again. And so on for all of the columns in the cart list – it's possible to sort the Library by - ARTIST, - LENGTH, or any other + Artist, + Length, or any other parameter shown in the cart list. @@ -834,7 +857,7 @@ Markers are set in the Edit Markers Dialog. To access the Dialog, open an audio cart, select the cut to open on the cut list and then touch the - Edit button. + Edit Markers button. The Dialog is divided into three areas: the waveform area in the @@ -846,9 +869,10 @@ Pause, Stop and Loop buttons along with an - audio meter; - and the marker button area in the lower third of the window, - consisting of controls for selecting and positioning markers. + audio meter and marker position readouts, + and the bottom section containing the usual + OK and + Cancel buttons. @@ -866,7 +890,7 @@ and Time buttons. By default, the waveform is displayed fully 'zoomed-out', thus showing the entire length of - the audio cut. The GoTo buttons + the audio cut. The GoTo buttons can be used to jump directly to the current play out cursor position, start or end of the waveform. @@ -875,151 +899,118 @@ waveform to indicate where play out should start and then clicking the left-hand Play button, causing play out to start from the - selected position, or by clicking the right-hand + selected position, or by clicking the center Play button, which - will cause play out to start from the Start Marker (just as it - would in RDAirPlay). Clicking the - Pause button while playing will - cause audio to stop and the play out cursor (a thin vertical black - line in the waveform area) to freeze at its current position, while - pressing the Stop button will stop - the audio while resetting the - play out cursor to the position it was in when - Play was started. + will cause play out to start from the currently selected start + marker. Clicking the Loop button will cause the audio to play out continuously, looping from end back to start, until either the Stop, - Pause, Save or Cancel buttons are clicked. - To set a marker, click on the corresponding marker button and then - left-click on the waveform area to indicate where on the audio - the marker should be placed. (NOTE: With the exception of the - FadeUp and FadeDown markers, all markers in Rivendell are assigned - in pairs. For example, placing a TalkStart marker will also cause - a TalkEnd marker to be placed.) Markers that have already been - placed can be moved by selecting the appropriate marker button and - then dragging the marker to the desired location. It's also possible - to specify the position of a marker in the form of hh:mm:ss.s - (relative to time after the Start marker) by entering the desired - value next to a selected marker button. It is also possible to - remove a set of markers that have already been placed, either by - accessing the marker menu by doing a right-click on the waveform - display, or by touching the - Remove Marker button and then touch - the marker button corresponding to the marker to be removed. - (NOTE: the exceptions to this are the Start / End markers, which - are always present and hence cannot be removed.) + All cuts have Cut markers, used + to indicate the absolute start and end of the cut when played on-air. + To adjust the position of the markers, position the mouse cursor + over one of the arrows on the marker, press and hold the left-hand + mouse button and drag it to the desired location. The marker's + arrows will become larger to indicate that the marker has been + selected. - - Rivendell Marker Types - - - - - - - - Marker Type - - - Function - - - Color - - - - - - - Start / Stop - - - Indicates start and end points of audio. - - - RED - - - - - TalkStart / Talk Stop - - - Indicates point to start and stop the Talk Counter in RDAirPlay. - - - BLUE - - - - - SegueStart / SegueEnd - - - Indicates the start and end of the audio overlap during - Segue transitions in RDAirPlay. - - - CYAN - - - - - HookStart / HookEnd - - - Indicates "highlighted" audio, used by button - panels and RDCartSlots when placed in Hook Mode. - - - VIOLET - - - - - FadeUp - - - Indicates the point at which audio should be faded up to - full level after starting in RDAirPlay. - - - YELLOW - - - - - FadeDown - - - Indicates the point at which audio should start fading - down to off before ending in RDAirPlay. - - - YELLOW - - - - -
- As an aid for accurately setting the Start and End markers, it's - possible to use the Trim Start - and Trim End buttons to automatically - set the markers to the first and last instances of the level - specified by the Threshold field, - respectively. + Additional markers can be set as follows: + + + + + Fade Down + + + + Indicates the point in the cut play-out to begin a steady + fade down that will continue until the end + Cut marker. + + + + + + Fade Up + + + + Indicates the point in the cut play-out to end a steady + fade up that starts at the start + Cut marker. + + + + + + Hook + + + + Indicates the portion of the cut to be played by a + sound panel when in Hook + mode. + + + + + + Segue + + + + Indicates the portion of the cut to be + overlapped with audio from the following log + event when used with a SEGUE + transition in + rdairplay1. + + + + + + Talk + + + + Indicates the start and end points of the "Pie Widget" + talk timer when the cut is played in + rdairplay1. + + + + + + To add a marker, position the mouse cursor on the waveform, press + the right-hand button and select the desired marker from the pop-up + menu. Once added, a marker can be repositioned in the usual way. + + + To delete a marker, position the mouse cursor on one of the marker's + arrows, press the right-hand button and select + Delete Marker from the pop-up menu. + + + + + + + + The Marker Menu + + Copying and Pasting Audio from Cut to Cut - It's possible to make copies of existing an audio cut on the system + It's possible to make copies of an existing audio cut on the system by opening up the cut's parent cart in the Edit Cart Dialog, selecting it on the cut list and clicking the Copy button. To @@ -1036,7 +1027,11 @@ Reports button on the main RDLibrary screen and then selecting the desired report and touching the Generate - button. The following reports are available: + button. The contents of the resulting report will be filtered + according to RDLibrary's the current search parameters. + + + The following reports are available: The Cart Report