diff --git a/ChangeLog b/ChangeLog index bcc0dc4a..db3f7c44 100644 --- a/ChangeLog +++ b/ChangeLog @@ -16187,3 +16187,6 @@ Operations Guide. 2017-10-19 Fred Gleason * Added sectionalized id tags to the Ops Guide. +2017-10-19 Fred Gleason + * Applied structural markup to the first 'rdcatch' chapter of the + Operations Guide. diff --git a/docs/opsguide/opsguide.xml b/docs/opsguide/opsguide.xml index 962c0d40..834b0fe3 100644 --- a/docs/opsguide/opsguide.xml +++ b/docs/opsguide/opsguide.xml @@ -45,7 +45,7 @@ --> - + Introducing Rivendell Rivendell is a digital audio content management and delivery system @@ -166,7 +166,7 @@ chapters that follow. However, we first need to cover some basic concepts common to all Rivendell modules. - + The Rivendell Security Paradigm All Rivendell modules make use of the following four classes of @@ -191,7 +191,7 @@ We'll cover each of these concepts in turn. - + Hosts Every physical computer within a given network that is running @@ -207,7 +207,7 @@ of these functions. - + Users Every host on a Rivendell network has one or more @@ -223,7 +223,7 @@ module. - + Groups A Rivendell group is a system of categories @@ -242,7 +242,7 @@ detail in the chapters devoted to the RDLibrary and RDAdmin modules. - + Services Every facility at which Rivendell is deployed is presumed to have @@ -257,7 +257,7 @@ - + The Rivendell Hardware Paradigm In addition to the core computer hardware (CPU, motherboard, etc), @@ -267,7 +267,7 @@ audio adapters, serial ports and GPIO/switcher devices. We'll cover each below. - + Audio Adapters An audio adapter in Rivendell is simply a @@ -328,7 +328,7 @@ - + Serial Ports Commonly known in the DOS/Windows world as 'COM ports', @@ -338,7 +338,7 @@ can be accessed simultaneously by each Rivendell host. - + GPIO/Switcher Devices Because these capabilities are often (although not always) @@ -367,7 +367,7 @@ Managing the Current User with RDLogin - + RDLogin Rivendell uses a sophisticated system of user privileges to keep track @@ -415,7 +415,7 @@ Content Management with RDLibrary - + The Rivendell Library Structure and RDLibrary Carts @@ -467,7 +467,7 @@ Schedule Cuts. When set to By Weight (the default), this will allow cut rotation to be managed by means of daypart settings (see - ). When set to + ). When set to By Specified Order, the precise rotation of the cuts within the cart can be set manually. @@ -523,7 +523,7 @@ within the cart. - + Cuts Each audio cart can contain one or more cuts. @@ -538,7 +538,7 @@ The weighting value for the cut. see - for discussion. + for discussion. @@ -547,7 +547,7 @@ The order value for the cut. see - for discussion. + for discussion. @@ -657,7 +657,7 @@ - + Multiple Cuts in a Cart What happens when more than one cut is placed into a cart? The @@ -690,7 +690,7 @@ audition any recording already made. - + Cut Dayparting For carts for which Schedule Cuts @@ -761,7 +761,7 @@ other Rivendell modules. - + Cart and Cut Color Coding Each cart or cut in RDLibrary is assigned a color to indicate @@ -810,7 +810,7 @@ is being viewed. - + Recording and Auditioning a Cut in the Record Dialog The lower third of the Record Dialog is used both to audition and @@ -868,7 +868,7 @@ - + Alternative Methods of Audio Ingestion In addition to manually recording material in realtime, RDLibrary @@ -940,7 +940,7 @@ and can now be auditioned and otherwise processed in the usual way. - + Ripping Audio from a CD Track To rip audio directly off of a CD into a cut, we again start by @@ -976,7 +976,7 @@ closing the Dialog. - + Ripping Multiple CD Tracks at a Time Sometimes, when transferring multiple audio tracks from CD, @@ -1016,7 +1016,7 @@ - + Macro Carts A macro cart is a cart that contains one or more commands written in @@ -1043,7 +1043,7 @@ lines both within a given cart or between carts. - + Navigating the Audio Library The uppermost section of RDLibrary's main window contains tools @@ -1052,7 +1052,7 @@ containing thousands of carts. It's possible to control what carts are listed, as well as how they are sorted. - + Changing the Cart Sort Order The order in which carts are displayed in the cart list can be @@ -1072,7 +1072,7 @@ parameter shown in the cart list. - + Selecting Carts by the Filter Field Very often, one will want to find a cart or set of carts whose @@ -1085,7 +1085,7 @@ the Clear button. - + Selecting Carts by Group It's possible to limit the list of carts to only those in a @@ -1094,7 +1094,7 @@ desired group name. - + Selecting Carts by Type You can tell RDLibrary what type of carts to list by checking the @@ -1108,7 +1108,7 @@ sorting methods. - + Selecting and Opening Carts Once the desired cart has been located on the cart list, load it @@ -1118,9 +1118,9 @@ - + Library Maintenance - + Editing Markers Rivendell uses a system of cue points within audio cuts, referred @@ -1306,7 +1306,7 @@ respectively. - + Copying and Pasting Audio from Cut to Cut It's possible to make copies of existing an audio cut on the system @@ -1319,7 +1319,7 @@ - + Generating Library Reports Various Library reports can be generated by touching the @@ -1328,21 +1328,21 @@ report and touching the Generate button. The following reports are available: - + The Cart Report The cart report consists of a list of all selected carts on the system, with their attributes. - + The Cut Report The cut report consists of a list of all cuts contained by the selected carts on the system, with their attributes. - + The Cart Data Dump (fixed width) The fixed-width cart data dump is a special type of report that @@ -1353,7 +1353,7 @@ external system (such as a music scheduling system). - + The Cart Data Dump (CSV) The CSV cart data dump is a special type of report that @@ -1369,11 +1369,12 @@ Automating Tasks with RDCatch - + Choosing the Correct Automation Tool Rivendell includes two modules specially optimized for performing - automatic operations: The RDCatch and RDAirPlay modules. The two + automatic operations: the RDCatch and RDAirPlay modules. However, + these two modules take radically different approaches in how they go about organizing and controlling operations, so a few words regarding each may be in order here. @@ -1381,8 +1382,11 @@ RDCatch is aimed at executing actions on the basis of a strict time-based schedule, referred to as an event list. Each action - (which can be a recording, a play out, an up- or download, a macro - execution or an operation on an audio switcher device) executes on + (which can be a recording, a + play out, an + upload or download, + a macro execution or an operation on an audio + switcher device) executes on the basis of its scheduled time in the event list, independently of all other actions. As such, RDCatch is often best suited for use in settings such as network head end operations or 'auxiliary' roles at @@ -1391,7 +1395,7 @@ RDAirPlay takes a very different approach, in that most events are - organized into one or more playlists or logs. A Rivendell log is a + organized into one or more playlists or logs. A Rivendell log is a list of one or more carts, organized in chronological order. As the name implies, RDAirPlay is optimized for use in situations where the transitions between the various program elements are a key part of @@ -1401,43 +1405,48 @@ Of course, it's entirely possible to use both modules, even together on the same machine at the same time – the Linux OS makes for a very - robust and capable multitasking system. + robust and capable multitasking system. In this chapter, we will + take a look at the capabilities of RDCatch. - + The RDCatch Main Window - After starting up RDCatch, you should see the main RDCatch window, - looking something like Illustration 11. The window consists of four + After starting up RDCatch, you will see the main RDCatch window, + looking something like Illustration 11. The window consists of four areas: the record / play out decks at the top, the filter areas just below the decks, the events list and the audition buttons and other - buttons at the bottom. We'll cover each of these in turn. + buttons at the bottom. We'll cover each of these in turn. - + The Record / Play Out Deck Area If the system administrator has configured one or more RDCatch record or play out decks, they will be visible at the top of the RDCatch main window. A record deck is a virtual 'recorder' that can be used to make automated recordings, while a play out deck - can be used to automatically play out audio. It does not matter - on which particular host a particular deck 'resides' – all + can be used to automatically play out audio. It does not matter + on which particular host a particular deck resides – all Rivendell decks throughout the system are visible in RDCatch, regardless of which host it is run upon. Starting at the left-hand edge of each deck, there is the deck's name, consisting of the name of the deck's host machine followed - by a number and a letter, an 'R' to indicate a record deck and a - 'P' to indicate a play out deck. Next, for record decks, there is - a MON button, used to monitor the audio present at the deck input, - followed by an ABORT button, used to manually stop an event + by a number and a letter, an R + to indicate a record deck and a + P to indicate a play out deck. + Next, for record decks, there is + a MON button, used to monitor the + audio present at the deck input, + followed by an ABORT button, used + to manually stop an event running in the deck. A description of the currently running event next appears (this area will be blank if no event is currently active), followed by the deck's status, which could be any of the - values shown in Table 2. + values in . - +
RDCatch Event States @@ -1510,24 +1519,28 @@ to verify audio levels in realtime. - + The Filter Area Immediately below the decks is the filter area, consisting of the - Show Only Active Events, Show Only Today's Events and Show DayOfWeek - controls. These controls are used to select which events will be + Show Only Active Events, + Show Only Today's Events + Show DayOfWeek and + Show Event Type + controls, which are used to select which events will be visible in the events list area immediately below. - + The Event List The event list is a system wide list of all events to be executed by RDCatch on all of the various hosts on the Rivendell network, with each event occupying a single line. The status of each event - is indicated by its background color, as shown in Table 3. + is indicated by its background color, as shown in + -
+
RDCatch Event State Colors @@ -1588,9 +1601,10 @@
Each entry in the event list starts with an icon that indicates - the type of the event, as shown in Table 4. + the type of the event, as shown in + - +
RDCatch Event Icons @@ -1648,9 +1662,13 @@
- Next on each line comes the description (settable by the user) and - location for the event, the location being the name of the host/deck - where the event will run. Then, comes the start and end parameters. + Next on each line comes the + Description (settable by the user) and + Location for the event, the + location being the name of the host/deck + where the event will run. Then comes the + Start and + End parameters. These time-based parameters come in one of three different forms: a hard time, which is simply an absolute time (in twenty-four hour 'military' format), a length (in HH:MM format, relative to an @@ -1714,60 +1732,70 @@ minute [01:00] after receiving the GPI before starting the event. - Next come the source and destination fields. The uses of these will + Next come the Source and + Destination fields. + The uses of these will vary depending upon what type of event is being listed, but should - normally be fairly self-evident. For example, for a record event, + normally be fairly self-evident. For example, for a record event, the source field indicates the audio source from which the recording is to be made, while the destination indicates the cat/cut combo to - which the recording should be made. Some events may leave one or the + which the recording should be made. Some events may leave one or the other of these fields blank. - Now come the day of the week fields. These indicate on which days + Now come the day of the week fields. These indicate on which days of the week the listed event should be executed, followed by the - origin field, which is simply a readout of the Origin data of the - events underlying cut. There are a number of other fields which + Origin field, which is simply a + readout of the Origin data of the + events underlying cut. There are a number of other fields which follow, but these are less important for understanding the operation of RDCatch. - + The Button Area - At the bottom of the main window are various buttons. On the - left-hand side, the Add, Edit and Delete buttons are used to manage - events in the event list. Clicking the Scroll button toggles - RDCatch into and out of 'scroll mode'. In this mode, the event + At the bottom of the main window are various buttons. On the + left-hand side, the Add, + Edit and + Delete buttons are used to manage + events in the event list. Clicking the + Scroll button toggles + RDCatch into and out of 'scroll mode'. In this mode, the event list display will be advanced automatically so as to keep the first actively running event centered within the event list area. - On the right hand side, in addition to Close, are three audition - buttons. These buttons can be used to audition the head and tail + On the right hand side, in addition to + Close, are three audition + buttons. These buttons can be used to audition the head and tail of each cut referenced by an event, thus making it possible to quickly verify that a set of automatic recordings were properly executed. - + Adding New Events A new event can be added to the event list by simply clicking the - Add button to bring up the Add Event Dialog (see Illustration 12). + Add button to bring up the Add + Event Dialog (see Illustration 12). Simply clicking the button that correspond to the desired type of event will create it. - + Automating Recordings Automated recordings are configured by means of the Edit Recording dialog (see Illustration 13), which can be accessed either by clicking - the Recording button in the Add Event dialog to create a new record - event or by touching the Edit button to modify an existing event. + the Recording button in the Add Event + dialog to create a new record + event or by touching the Edit button + to modify an existing event. - + The 'Start Parameters' Section The start parameters of each recording are configured in the @@ -1775,139 +1803,170 @@ on the basis of the wall clock time, referred to the hard start time, or upon reception of a general-purpose input, or GPI event originated by a satellite receiver, tone decoder or other external - device. Programming a hard start time is merely a matter of + device. Programming a hard start time is merely a matter of entering the desired start time, in 24 hour 'military' format. Programming a GPI start involves, in addition to entry of the GPI - parameters themselves (matrix and GPI line numbers) that Window - Start and Windows End times be entered, that define the 'window' + parameters themselves (matrix and GPI line numbers) that + Window Start and + Windows End times be entered, + that define the 'window' during which reception of the appropriate GPI event will be - 'recognized' by RDCatch. It is also optionally possible to specify - a Start Delay between reception of the GPI event and the actual - start of the recording. + 'recognized' by RDCatch. It is also optionally possible to specify + a Start Delay between reception of + the GPI event and the actual start of the recording. - + The 'End Parameters' Section The end parameters of each recording are configured in the - 'End Parameters' section. A recording can be programmed to end on + 'End Parameters' section. A recording can be programmed to end on the basis of a hard time, its absolute length or in response to a - GPI event. Programming of the Hard Time and Length parameters + GPI event. Programming of the + Hard Time and + Length parameters should be fairly self-explanatory, while the parameters needed to program a GPI event are similar to those used for the start - parameters, with the exception of the 'Max Record Length' setting, + parameters, with the exception of the + Max Record Length setting, which limits the maximum length of the recording in the event that the expected GPI event is never received. - + Programming Multiple Recordings in a Single Event If a record event is configured to use GPI for its start and Length or GPI for its end parameter, then it is possible to configure the event to make repeated, multiple recordings within a single event - by checking the 'Allow Multiple Recordings Within This Window' box - in the 'Start Parameters' section. This can significantly reduce + by checking the + Allow Multiple Recordings Within This Window + box in the 'Start Parameters' section. This can significantly reduce the amount of required record events when capturing material with high on-air turnover, such as newscasts or traffic reports. - + Selecting a Record Source - If the selected record deck (chosen in the Location drop-down menu + If the selected record deck (chosen in the + Location drop-down menu at the top of the dialog) as been configured to operate with an audio switcher device, the appropriate audio input can be chosen - from the Source drop-down menu. + from the Source drop-down menu. - + Selecting a Record Destination Each programmed recording must have a 'destination', a designated Cart/Cut which will hold the audio. The currently programmed destination is shown in the Destination field, and can be changed - by clicking the Select button. + by clicking the Select button. - + Setting the Active Days for a Recording A check should be placed next to each day of the week for which a - recording should be made in the Active Days box. If no days are + recording should be made in the + Active Days box. If no days are checked, then no recordings at all will be made. - + Record List Management with Event Active and Make OneShot - The record event will be actually executed only if Event Active - (in the upper left corner of the dialog box) is checked. By + The record event will be actually executed only if + Event Active check box + (in the upper left corner of the dialog box) is ticked. By clearing this box, it's possible to 'bank' a record event without actually having it run, useful for events that are only used sporadically. - For events that need to be executed only once, the Make OneShot - box can be checked. Such an event will execute just once, and + For events that need to be executed only once, the + Make OneShot + box can be ticked. Such an event will execute just once, and then automatically delete itself from the event list. - + Automating Playouts Automated playouts are configured by means of the Edit Playout dialog (see Illustration 14), which can be accessed either by - clicking the Playout button in the Add Event dialog to create a new - record event or by touching the Edit button to modify an existing - event. The process of configuring a playout is very similar to that - for configuring a recording – see the relevant part of Section 3.3, - 'Automating Recordings' above for details. + clicking the Playout button in + the Add Event dialog to create a new + record event or by touching the + Edit button to modify an existing + event. The process of configuring a playout is very similar to that + for configuring a recording – see the + + above for details. - + Automating Uploads/Downloads It's possible to use RDCatch to automatically upload and download - material from both local and Internet-based servers. Automated + material from both local and Internet-based servers. Automated downloads are configured by means of the Edit Download dialog, which - can be accessed either by clicking the Download button in the Add + can be accessed either by clicking the + Download button in the Add Event dialog (see Illustration 15) to create a new record event or - by touching the Edit button to modify an existing event. + by touching the Edit button to + modify an existing event. - With the exception of the Url, Username and Password controls, + With the exception of the Url, + Username and + Password controls, the process of configuring a download is very similar to that for - configuring a recording – see the relevant part of Section 3.3, - 'Automating Recordings' above for details. + configuring a recording – see the + above for + details. - The Url control is used to specify the Uniform Resource Locater for - the material to be downloaded. The following download types are - supported: http, ftp, smb and file. The URL field can also include + The Url control is used to specify + the Uniform Resource Locater for + the material to be downloaded. The following download types are + supported: http:, + ftp:, sftp: and + file:. The Url + field can also include wildcard characters that can be used to construct date-based URLs, - as shown in Table 5. + as shown in FIXME. - The Username and Password fields are used to indicate the username - and password required for access to the server referenced in the URL. + The Username and + Password fields are used to + indicate the username + and password required for access to the server referenced in the + Url. For public web pages and anonymous FTP servers, these fields can be left blank. Automated uploads are configured by means of the Edit Upload dialog (see Illustration 16), which can be accessed either by clicking the - Upload button in the Add Event dialog to create a new record event or - by touching the Edit button to modify an existing event. The - following upload types are supported: ftp, smb and file. As with - downloads, the URL field can also include wildcard characters that - can be used to construct date-based URLs, as shown in Table 5. + Upload button in the Add Event + dialog to create a new record event or + by touching the Edit button to + modify an existing event. The + following upload types are supported: ftp:, + sftp: and file:. As with + downloads, the Url field can also + include wildcard characters that + can be used to construct date-based URLs, as shown in FIXME. Configuration of an upload event is very similar to that of a download, - with the addition of the Export Format control. This is used to set - what file format should be used for the upload. Depending upon what + with the addition of the + Export Format control. + This is used to set + what file format should be used for the upload. Depending upon what software encoders have been installed by the system administrator, the following export types may be available: @@ -1931,36 +1990,44 @@ - The desired upload format and parameters are set by clicking the Set - button. + The desired upload format and parameters are set by clicking the + Set button. - + Automating Macro Execution It's possible to configure the automatic execution of a Macro Cart by means of the Edit Cart Event dialog (see Illustration 17), which - can be accessed either by clicking the Macro Cart button in the Add + can be accessed either by clicking the + Macro Cart button in the Add Event dialog to create a new Macro Cart event or by touching the - Edit button to modify an existing event. The process of configuring + Edit button to modify an existing + event. The process of configuring a macro cart event is very similar to that for configuring a - recording – see the relevant part of Section 3.3, 'Automating - Recordings' above for details. + recording – see + above for details. - + Automating Switcher Operations It's possible to configure an automatic operation on a switcher device by means of the Edit Switcher Event dialog (see Illustration - 18), which can be accessed either by clicking the Switch Event button - in the Add Event dialog to create a new switch event or by touching - the Edit button to modify an existing event. + 18), which can be accessed either by clicking the + Switch Event button + in the Add Event dialog to create a new switch event or by touching + the Edit button to modify an + existing event. - In addition to the usual fields, a switch event has Switch Matrix + In addition to the usual fields, a switch event has + Switch Matrix (the name of one of the switch matrices associated with the selected - Location), Switch Input and Switch Output controls. When executed, a + Location), + Switch Input and + Switch Output controls. + When executed, a switch events causes a take operation to be performed on the specified switcher device between the specified input and output. It is possible to specify the input and output either by their alphanumeric @@ -1970,7 +2037,7 @@ Generating and Maintaining Logs with RDLogEdit - + Logs and Log Events A Rivendell log is a sequence of one or more events to be executed by @@ -2050,7 +2117,7 @@ icons). The following types of events can be incorporated into a Rivendell log: - + Audio Carts The first, and usually most common type of log event is an audio cart. @@ -2059,7 +2126,7 @@ detail in Chapter Two in the discussion about RDLibrary. - + Macro Carts A macro cart is a cart from the Library that contains one or more @@ -2068,7 +2135,7 @@ about RDLibrary, and will be discussed in detail in Chapter Seven. - + Note Markers A note marker is an entry in the log that contains text intended to @@ -2085,7 +2152,7 @@ to others who may be executing the log. - + Track Markers A track marker is another meta event that is very similar in operation @@ -2096,7 +2163,7 @@ markers have absolutely no effect on the execution of a log. - + Chain Events Each event in a log has a transition type, shown in the @@ -2106,7 +2173,7 @@ transition types can exist in a Rivendell log: PLAY, SEGUE and STOP. - + Import Links An import link is a placeholder event that shows where events imported @@ -2121,7 +2188,7 @@ - + Event Transitions Each event in a log has a transition type, shown in the "TRANS" @@ -2202,7 +2269,7 @@ - + The PLAY Transition If an event has a PLAY transition, then it will begin playing when @@ -2211,7 +2278,7 @@ as when playing two voice-only announcements back-to-back). - + The SEGUE Transition SEGUE transitions are similar to PLAY transitions, with one key @@ -2224,7 +2291,7 @@ musical material. - + The STOP Transition As the name implies, STOP transitions cause execution of the log to @@ -2236,7 +2303,7 @@ - + Time and Time Types All Rivendell log events have an associated time type, which controls @@ -2245,7 +2312,7 @@ the hard time type has several additional options that further modify its behavior. - + The Relative Time Type The default time type for log events, a relative time type simply @@ -2254,7 +2321,7 @@ or whenever it is started (if it has a STOP transition). - + The Hard Time Type A hard time type causes the event to be executed or otherwise acted @@ -2287,7 +2354,7 @@ - + Start Immediately As implied by the name, if the event is set to start immediately, @@ -2295,7 +2362,7 @@ currently playing events in the log will be stopped down. - + Cue to the Event ("Make Next") If set to 'Make Next', the event will be cued up to become the @@ -2304,7 +2371,7 @@ hard timed one. Any currently playing events are unaffected. - + Wait up to N Seconds, then start the event Very similar to "start immediately", with the @@ -2315,9 +2382,9 @@ - + Editing Log Event Parameters - + Specifying a Cart The cart number to use for an event can be specified by touching @@ -2329,7 +2396,7 @@ from the cart's label. - + Specifying Meta Event Parameters Note marker and track marker events each take only a single @@ -2341,7 +2408,7 @@ assigned transition and time types just the same as cart events. - + Rearranging Log Events Existing events in a log can be cut, copied, pasted or rearranged @@ -2350,7 +2417,7 @@ log event(s) to be removed from the log. - + Saving or Abandoning Changes to a Log Any changes made to a log can be saved by touching either the Save @@ -2359,7 +2426,7 @@ touching Cancel will abandon any changes made since the last save. - + Missing/Invalid Cart Events If a given event has a problem (such as referencing a cart that @@ -2372,27 +2439,27 @@ - + Generating Log Reports Various Log reports can be generated by touching the Reports button on the Edit Log dialog and then selecting the desired report and touching the Generate button. The following reports are available: - + Log Listing A chronological listing of all events in the log. - + Log Exception Report A list of missing/unplayable carts referenced in the log. - + Auditioning Audio The audio referenced by an audio event can be sampled in the Edit @@ -2406,7 +2473,7 @@ Running Logs with RDAirPlay - + Overview RDAirPlay is the Rivendell module used to run logs generated by the @@ -2416,7 +2483,7 @@ environments. - + Log Machines Fundamental to the operation of RDAirPlay is the concept of a log @@ -2428,7 +2495,7 @@ machines. - + Layout As shown in Illustration 24, the RDAirPlay main screen consists of @@ -2442,7 +2509,7 @@ The top area contains the following indicators: - + The Wall Clock In the upper left-hand corner is wall clock indicator, which indicates @@ -2454,7 +2521,7 @@ of master clock synchronization. - + The Post Point Counter Immediately to the right of the wall clock is the Post Point Counter. @@ -2490,7 +2557,7 @@ much material would need to be removed to make the join on time. - + The Audio Meter Immediately beneath the wall clock and post point counter is the audio @@ -2498,7 +2565,7 @@ out of RDAirPlay, with '0' level referenced to -16 dBFS. - + The Pie Wedge Widget In the top center of the top area is the pie wedge widget. This @@ -2513,7 +2580,7 @@ talk time (if talk time markers have been set in the underlying cart). - + The Next Stop Counter Immediately to the right of the pie wedge widget is the next stop @@ -2523,7 +2590,7 @@ stopped, then the counter simply displays 'Stopped'. - + The Mode Indicator In the upper right-hand corner of the top area is the mode indicator, @@ -2539,7 +2606,7 @@ indicator until the desired mode is indicated. - + The Label Area Immediately below the next stop counter and mode indicator is the @@ -2548,7 +2615,7 @@ system or need to take some kind of action. - + The Right-Hand Side Directly below the label area is the right-hand side. The right-hand @@ -2560,7 +2627,7 @@ system). - + The Full Log Widget As the name implies, the full log widget can be used to view the @@ -2600,7 +2667,7 @@ button on (blue background). - + The Button Log Widget To the left of the full log widget is the button log widget, @@ -2623,14 +2690,14 @@ - + Editing a Log It is possible to edit the log loaded into any of the three log machines by means of the log edit buttons in the lower left-hand corner of the screen. - + Adding an Event To add an event, touch the ADD button to open the Select Cart dialog, @@ -2643,7 +2710,7 @@ to cancel the operation (see Illustration 39). - + Deleting an Event To delete an event, touch the DEL button, then touch one of the @@ -2652,7 +2719,7 @@ simply touch the DEL button again (see Illustration 40). - + Moving an Event To move an event, touch the Move button, then touch one of the violet @@ -2664,7 +2731,7 @@ between two different log machines. - + Copying an Event To copy an event, touch the Copy button, then touch one of the @@ -2676,7 +2743,7 @@ copy an event between two different log machines. - + The SoundPanel The SoundPanel is an array of buttons that appears in the right-hand @@ -2688,7 +2755,7 @@ drop in some piece of audio on a live, improvised basis. - + Panel Types The SoundPanel has multiple panels or “panes” that can scrolled @@ -2705,7 +2772,7 @@ you). - + Programming a SoundPanel Button To associate a cart with a panel button, first touch the Setup @@ -2730,7 +2797,7 @@ Generating Logs with RDLogManager - + Overview RDLogManager is a tool for generating Rivendell logs. It is different @@ -2758,7 +2825,7 @@ Illustration 42). - + Grids Each Rivendell service has an RDLogManager grid. To see the list of @@ -2788,7 +2855,7 @@ the relevant hour in a grid and selecting Edit Clock. - + Clocks An RDLogManager clock is a collection of RDLogManager events, @@ -2847,7 +2914,7 @@ Enabled Services list and then touch the << Remove button. - + Events An RDLogManager event is a set of rules that define a series of log @@ -2947,7 +3014,7 @@ As buttons. - + Generating Logs After all of the appropriate hours have been populated in a service's @@ -3010,7 +3077,7 @@ indicator lights will be "whited out" accordingly. - + Generating Reports A Rivendell report is a data output that details whether certain @@ -3041,7 +3108,7 @@ as to span more than one day). Once the parameters are set, touch the Generate Report button to write out the report. - + Purging Old Report Data Rivendell keeps the raw data used to generate reports indefinitely, @@ -3062,7 +3129,7 @@ VoiceTracking - + Voicetracking in Rivendell Voicetracking is a capability wherein custom "one-off" @@ -3075,7 +3142,7 @@ The voicetracker module also includes extensive capabilities for allowing customization of the transitions between log elements. - + Prerequisites Before beginning voicetracking for a particular service, a @@ -3084,7 +3151,7 @@ the Rivendell Technical and Administration Guide. - + VoiceTrack Markers A voicetrack marker is a meta event that can be inserted into a log @@ -3095,9 +3162,9 @@ - + Using the Voicetrack Interface - + The VoiceTracker Dialog To voicetrack a log, start the RDLogEdit module (see Illustration 19), @@ -3115,7 +3182,7 @@ buttons occupy the bottom and right-hand edges of the dialog. - + Editing Transitions When an event is selected in the log list, a graphical depiction of @@ -3145,7 +3212,7 @@ type from the menu. - + Inserting and Deleting Track Markers It is possible to insert a new voicetrack marker by selecting the @@ -3154,7 +3221,7 @@ selecting it in the log list and touching the Delete Track button. - + Moving Between Track Markers It is possible to move directly to the next or previous voicetrack @@ -3162,7 +3229,7 @@ respectively. - + Recording a Voicetrack Once the desired voicetrack marker has been selected, the process @@ -3188,7 +3255,7 @@ dragging the appropriate waveforms with the mouse. - + Adjusting Transition Levels It is possible to adjust the audio fade levels applied during @@ -3198,7 +3265,7 @@ desired location. - + Importing Voicetracks In addition to recording in realtime, it's possible to import a @@ -3211,7 +3278,7 @@ recorded. - + Hitting the Post If the event following a voicetrack has its Talk Time markers set, @@ -3226,7 +3293,7 @@ Rivendell Macro Langauge - + Overview Rivendell Macro Language (or RML for short) is a set of commands @@ -3237,7 +3304,7 @@ Rivendell user management. - + Protocol The Normal form of a command takes the following syntax: @@ -3281,7 +3348,7 @@ - + Command Delivery To be executed by a Rivendell system, an appropriate command should be @@ -3293,7 +3360,7 @@ - + Command Reply If delivered to UDP port 5858, each command may receive a reply, @@ -3336,7 +3403,7 @@ - + Specifying Color In places where a color can be specified as a macro argument, the @@ -3363,7 +3430,7 @@ - + Binary Data Certain commands (e.g. SO and UO) @@ -3395,9 +3462,9 @@ - + Commands - + Air Gate [AG] @@ -3424,7 +3491,7 @@ - + Add Next [PX] @@ -3452,7 +3519,7 @@ - + Binary Serial Out [BO] @@ -3482,7 +3549,7 @@ - + Clear Serial Trap [SC] @@ -3525,7 +3592,7 @@ - + Command Send [CC] @@ -3557,7 +3624,7 @@ - + Connect Jack Ports [JC] @@ -3585,7 +3652,7 @@ - + Console Label [CL] @@ -3616,7 +3683,7 @@ - + Copy Cut [CP] @@ -3650,7 +3717,7 @@ - + Cut Event [CE] @@ -3680,7 +3747,7 @@ - + Database Backup [DB] @@ -3707,7 +3774,7 @@ - + Disconnect Jack Ports [JD] @@ -3735,7 +3802,7 @@ - + Duck Panel Button [PD] @@ -3780,7 +3847,7 @@ - + Execute Breakaway [DX] @@ -3812,7 +3879,7 @@ - + Execute Cart [EX] @@ -3838,7 +3905,7 @@ - + Fire Salvo [FS] @@ -3866,7 +3933,7 @@ - + GPI Enable [GE] @@ -3909,7 +3976,7 @@ - + GPI Enable [GE] (old format, deprecated) @@ -3939,7 +4006,7 @@ - + GPI Set [GI] @@ -3985,7 +4052,7 @@ - + GPI Set [GI] (old format, deprecated) @@ -4016,7 +4083,7 @@ - + GPO Set [GO] @@ -4082,7 +4149,7 @@ - + GPO Set [GO] (old format, deprecated) @@ -4114,7 +4181,7 @@ - + Insert Serial Trap [SI] @@ -4145,7 +4212,7 @@ - + Label Panel [PC] @@ -4182,7 +4249,7 @@ - + Load Log [LL] @@ -4217,7 +4284,7 @@ - + Load Panel [PE] @@ -4252,7 +4319,7 @@ - + Load Slot [DL] @@ -4303,7 +4370,7 @@ - + Login [LO] @@ -4332,7 +4399,7 @@ - + Macro Timer [MT] @@ -4365,7 +4432,7 @@ - + Make Next [MN] @@ -4393,7 +4460,7 @@ - + Message Box [MB] @@ -4438,7 +4505,7 @@ - + Pause Panel [PU] @@ -4477,7 +4544,7 @@ - + Play Panel [PP] @@ -4517,7 +4584,7 @@ - + Play Slot [DP] @@ -4545,7 +4612,7 @@ - + Refresh Log [RL] @@ -4572,7 +4639,7 @@ - + Run Shell Command [RN] @@ -4598,7 +4665,7 @@ - + Select Widget [PW] @@ -4625,7 +4692,7 @@ - + Serial Out [SO] @@ -4655,7 +4722,7 @@ - + Serial Reload [SY] @@ -4683,7 +4750,7 @@ - + Set Color Label [LC] @@ -4711,7 +4778,7 @@ - + Set Default Now & Next Cart [SN] @@ -4740,7 +4807,7 @@ - + Set Display [SD] @@ -4851,7 +4918,7 @@ - + Set Duck Level [MD] @@ -4885,7 +4952,7 @@ - + Set Label [LB] @@ -4911,7 +4978,7 @@ - + Set Mode [PM] @@ -4956,7 +5023,7 @@ - + Sleep [SP] @@ -4982,7 +5049,7 @@ - + Start [PL] @@ -5010,7 +5077,7 @@ - + Start Button [PB] @@ -5036,7 +5103,7 @@ - + Start Next [PN] @@ -5070,7 +5137,7 @@ - + Start Record Deck [RS] @@ -5106,7 +5173,7 @@ - + Stop [PS] @@ -5137,7 +5204,7 @@ - + Stop Panel [PT] @@ -5179,7 +5246,7 @@ - + Stop Record Deck [RR] @@ -5205,7 +5272,7 @@ - + Stop Slot [DS] @@ -5233,7 +5300,7 @@ - + Switch Add [SA] @@ -5264,7 +5331,7 @@ - + <command>Switch Add With Gain [SG]</command> @@ -5298,7 +5365,7 @@ - + <command>Switch Crosspoint Gain [SX]</command> @@ -5330,7 +5397,7 @@ - + <command>Switch Level [SL]</command> @@ -5360,7 +5427,7 @@ - + <command>Switch Reload [SZ]</command> @@ -5388,7 +5455,7 @@ - + <command>Switch Remove [SR]</command> @@ -5419,7 +5486,7 @@ - + <command>Switch Take [ST]</command> @@ -5450,7 +5517,7 @@ - + <command>Toggle On Air Flag [TA]</command> @@ -5476,7 +5543,7 @@ - + <command>UDP Out [UO]</command> @@ -5511,7 +5578,7 @@ Interfacing with the Linux Ecosystem: Command-Line Utilities - + RMLSend RMLSend is a small utility that can be used to send RML commands to a @@ -5540,7 +5607,7 @@ page for details. - + RDImport RDImport is a command-line interface (CLI) program that can be used to @@ -5556,7 +5623,7 @@ The GNU General Public License, Version Two - + GNU GENERAL PUBLIC LICENSE Version 2, June 1991 @@ -5567,7 +5634,7 @@ Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. - + Preamble The licenses for most software are designed to take away your @@ -5629,7 +5696,7 @@ modification follow. - + GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION @@ -5914,7 +5981,7 @@ - + NO WARRANTY @@ -5947,11 +6014,11 @@ - + END OF TERMS AND CONDITIONS - + How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest @@ -5965,7 +6032,7 @@ convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. - + <one line to give the program's name and a brief idea of what it does.> @@ -6018,7 +6085,7 @@ under certain conditions; type `show c' for details. your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names: - + Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker.