2020-08-13 Fred Gleason <fredg@paravelsystems.com>

* Added an 'RDCastManager' chapter to the Operations Guide.

Signed-off-by: Fred Gleason <fredg@paravelsystems.com>
This commit is contained in:
Fred Gleason 2020-08-13 18:56:21 -04:00
parent 783ce2fc9a
commit afb3832f72
22 changed files with 524 additions and 3 deletions

View File

@ -20242,3 +20242,5 @@
2020-08-13 Fred Gleason <fredg@paravelsystems.com>
* Removed the 'Unly Show Unexpired Items' checkbox from the
'Podcast Feed Item List' dialog in rdcastmanager(1).
2020-08-13 Fred Gleason <fredg@paravelsystems.com>
* Added an 'RDCastManager' chapter to the Operations Guide.

View File

@ -487,6 +487,25 @@ ln -s ../../icons/traffic.png docs/opsguide/traffic.png
rm -f docs/opsguide/trashcan-32x32.png
ln -s ../../icons/trashcan-32x32.png docs/opsguide/trashcan-32x32.png
rm -f docs/opsguide/blueball.png
ln -s ../../icons/blueball.png docs/opsguide/blueball.png
rm -f docs/opsguide/greenball.png
ln -s ../../icons/greenball.png docs/opsguide/greenball.png
rm -f docs/opsguide/redball.png
ln -s ../../icons/redball.png docs/opsguide/redball.png
rm -f docs/opsguide/whiteball.png
ln -s ../../icons/whiteball.png docs/opsguide/whiteball.png
rm -f docs/opsguide/greencheckmark.png
ln -s ../../icons/greencheckmark.png docs/opsguide/greencheckmark.png
rm -f docs/opsguide/redx.png
ln -s ../../icons/redx.png docs/opsguide/redx.png
AC_CONFIG_FILES([rivendell.spec \
Makefile \
conf/rd-bin.conf \

View File

@ -37,6 +37,7 @@ OPSGUIDE_HTML = appendix.filepath_wildcards.html\
chapter.rdlogedit.html\
chapter.rdlogin.html\
chapter.rdlogmanager.html\
chapter.rdcastmanager.html\
chapter.rml.html\
chapter.utilities.html\
chapter.voicetracking.html\
@ -102,6 +103,9 @@ OPSGUIDE_HTML = appendix.filepath_wildcards.html\
sect.rdcartslots.operation_in_breakaway_mode.html\
sect.rdcartslots.operation_in_cart_deck_mode.html\
sect.rdcartslots.setting_the_slot_options.html\
sect.rdcastmanager.deleting_an_item.html\
sect.rdcastmanager.editing_an_items_metadata.html\
sect.rdcastmanager.posting_creating_a_new_item.html\
sect.rdcatch.adding_new_events.html\
sect.rdcatch_automating_macro_execution.html\
sect.rdcatch.automating_playouts.html\
@ -217,6 +221,15 @@ OPSGUIDE_IMAGES = rdadmin.audio_resource_information_dialog.png\
rdairplay.soundpanel_widget.png\
rdairplay.wallclock_widget.png\
rdairplay.where_to.png\
rdcastmanager.delete_item_dialog.png\
rdcastmanager.editing_item_dialog.png\
rdcastmanager.list_log_events_dialog.png\
rdcastmanager.list_log_select_select_audio_file_dialog.png\
rdcastmanager.log_render_options_dialog.png\
rdcastmanager.podcast_item_list_dialog.png\
rdcastmanager.rdcastmanager_screenshot.png\
rdcastmanager.select_cut_dialog.png\
rdcastmanager.select_log_dialog.png\
rdcartslots.rdcartslots.edit_slot_options_dialog.png\
rdcartslots.rdcartslots_screenshot.png\
rdcartslots.rivendell_services_dialog.png\
@ -274,15 +287,21 @@ OPSGUIDE_IMAGES = rdadmin.audio_resource_information_dialog.png\
voicetracking.voice_tracker_dialog_track_selected.png\
webget.webget_screen.png
OPSGUIDE_ICONS = chain.png\
OPSGUIDE_ICONS = blueball.png\
chain.png\
greenball.png\
greencheckmark.png\
mic16.png\
music.png\
notemarker.png\
play.png\
redball.png\
redx.png\
rml5.png\
track_cart.png\
traffic.png\
trashcan-32x32.png
trashcan-32x32.png\
whiteball.png
OPSGUIDE_DEPS = $(OPSGUIDE_IMAGES) \
$(OPSGUIDE_ICONS) \
@ -297,6 +316,7 @@ OPSGUIDE_DEPS = $(OPSGUIDE_IMAGES) \
rdadmin.xml\
rdairplay.xml\
rdcartslots.xml\
rdcastmanager.xml\
rdcatch.xml\
rddbconfig.xml\
rdlibrary.xml\
@ -345,14 +365,20 @@ CLEANFILES = *~\
*.pdf
DISTCLEANFILES = chain.png \
blueball.png\
greenball.png\
greencheckmark.png\
mic16.png \
music.png \
notemarker.png \
play.png \
redball.png\
redx.png\
rml5.png \
track_cart.png \
traffic.png \
trashcan-32x32.png
trashcan-32x32.png\
whiteball.png
MAINTAINERCLEANFILES = *~\
*.1\

1
docs/opsguide/blueball.png Symbolic link
View File

@ -0,0 +1 @@
../../icons/blueball.png

1
docs/opsguide/greenball.png Symbolic link
View File

@ -0,0 +1 @@
../../icons/greenball.png

View File

@ -0,0 +1 @@
../../icons/greencheckmark.png

View File

@ -12,6 +12,7 @@
<!ENTITY rdcartslots SYSTEM "rdcartslots.xml">
<!ENTITY rdlogmanager SYSTEM "rdlogmanager.xml">
<!ENTITY voicetracking SYSTEM "voicetracking.xml">
<!ENTITY rdcastmanager SYSTEM "rdcastmanager.xml">
<!ENTITY webget SYSTEM "webget.xml">
<!ENTITY rml SYSTEM "rml.xml">
<!ENTITY utilities SYSTEM "utilities.xml">
@ -39,6 +40,7 @@
&rdcartslots;
&rdlogmanager;
&voicetracking;
&rdcastmanager;
&webget;
</part>
<part xml:id="part.rivendell_administration" xmlns="http://docbook.org/ns/docbook" version="5.0">

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 45 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 59 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 62 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 41 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 35 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 37 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

View File

@ -0,0 +1,463 @@
<chapter xmlns="http://docbook.org/ns/docbook" xml:id="chapter.rdcastmanager">
<title>Managing Podcasts with RDCastManager</title>
<sect1 xml:id="sect.rdcastmanager.overview">
<title>Overview</title>
<para>
RDCastManager is a Rivendell module designed for posting items and
managing item metadata for audio podcasts managed by Rivendell.
</para>
<para>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="rdcastmanager.rdcastmanager_screenshot.png" scale="55"/>
</imageobject>
<caption>
<para>The RDCastManager Main Window</para>
</caption>
</mediaobject>
</para>
<para>
When started, RDCastManager will display the list of available podcast
feeds for the currently logged in user. Each line begins with an icon,
indicating the status of the respective podcast feed, as follows:
</para>
<table xml:id="table.rdcastmanager.rdcastmanager_feed_states" frame="all">
<title>RDCastManager Feed States</title>
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colname="Icon" colwidth="1.0*"/>
<colspec colname="Meaning" colwidth="10.0*"/>
<thead>
<row>
<entry>
Status
</entry>
<entry>
Meaning
</entry>
</row>
</thead>
<tbody>
<row>
<entry>
<inlinemediaobject>
<imageobject>
<imagedata fileref="greencheckmark.png" scale="100"/>
</imageobject>
</inlinemediaobject>
</entry>
<entry>
All items in the feed are active.
</entry>
</row>
<row>
<entry>
<inlinemediaobject>
<imageobject>
<imagedata fileref="redx.png" scale="100"/>
</imageobject>
</inlinemediaobject>
</entry>
<entry>
One or more items in the feed are currently inactive.
</entry>
</row>
</tbody>
</tgroup>
</table>
<para>
To see the list of items posted
to a particular feed, select the desired feed on the list and then touch
the <computeroutput>View Feed</computeroutput> button to open the
<computeroutput>Podcast Item List</computeroutput> dialog.
</para>
<para>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="rdcastmanager.podcast_item_list_dialog.png" scale="55"/>
</imageobject>
<caption>
<para>The Podcast Item List Dialog</para>
</caption>
</mediaobject>
</para>
<para>
Each posted item has a <emphasis>status</emphasis>, indicated by the
color of the icon at the beginning of its line on the list.
</para>
<table xml:id="table.rdcastmanager.rdcastmanager_item_states" frame="all">
<title>RDCastManager Item States</title>
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colname="Icon" colwidth="1.0*"/>
<colspec colname="Meaning" colwidth="10.0*"/>
<thead>
<row>
<entry>
Status
</entry>
<entry>
Meaning
</entry>
</row>
</thead>
<tbody>
<row>
<entry>
<inlinemediaobject>
<imageobject>
<imagedata fileref="greenball.png" scale="100"/>
</imageobject>
</inlinemediaobject>
</entry>
<entry>
Item is active and visible to the audience.
</entry>
</row>
<row>
<entry>
<inlinemediaobject>
<imageobject>
<imagedata fileref="redball.png" scale="100"/>
</imageobject>
</inlinemediaobject>
</entry>
<entry>
Item is inactive and not visible to the audience.
</entry>
</row>
<row>
<entry>
<inlinemediaobject>
<imageobject>
<imagedata fileref="blueball.png" scale="100"/>
</imageobject>
</inlinemediaobject>
</entry>
<entry>
Item is active, but currently embargoed and not visible to
the audience.
</entry>
</row>
</tbody>
</tgroup>
</table>
</sect1>
<sect1 xml:id="sect.rdcastmanager.editing_an_items_metadata">
<title>Editing an Item's Metadata</title>
<para>
To view (and possibly modify) an item's metadata, select the item
on the list and then touch the <computeroutput>Edit</computeroutput>
button to open the <computeroutput>Editing Item</computeroutput>
dialog.
</para>
<para>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="rdcastmanager.editing_item_dialog.png" scale="55"/>
</imageobject>
<caption>
<para>The Editing Item Dialog</para>
</caption>
</mediaobject>
</para>
<para>
The following controls are available:
</para>
<para>
<variablelist>
<varlistentry>
<term><computeroutput>Item Active</computeroutput></term>
<listitem>
<para>
When ticked, this makes the item visible to the audience
(but see <computeroutput>Air Date/Time</computeroutput> below).
</para>
<para>
Unticking this is a good way to put an item &quot;on hold&quot;
without permanently deleting it from the feed.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><computeroutput>Posted By</computeroutput></term>
<listitem>
<para>
This is a &quot;read-only&quot; field that provides details on
the provenance of the item.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><computeroutput>Title</computeroutput></term>
<listitem>
<para>
The title of the item.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><computeroutput>Author E-Mail</computeroutput></term>
<listitem>
<para>
The e-mail address (and optionally, full name) of the
author/originator of the item.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><computeroutput>Description</computeroutput></term>
<listitem>
<para>
Text describing the content of the item.
</para>
<para>
The accompanying
<computeroutput>Item contains explicit content</computeroutput>
checkbox should be ticked if the item contains content that
may not be suitable for under-age listeners.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><computeroutput>Image</computeroutput></term>
<listitem>
<para>
The icon that will associated with this item when viewed
by the audience.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><computeroutput>Air Date/Time</computeroutput></term>
<listitem>
<para>
The date/time that the item was/will be published. If this is
set to a value in the future, the item will be
<emphasis>embargoed</emphasis> --i.e. hidden from the audience--
until this date/time.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><computeroutput>Expires</computeroutput></term>
<listitem>
<para>
If this dropdown is set to <userinput>Yes</userinput>, then
the item will be automatically deleted from the feed at the
specified date/time. If set to <userinput>No</userinput>,
the item will never be deleted automatically.
</para>
<warning>
Deleting an item cannot be undone!
</warning>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
To save any changes made to the item's metadata and close the dialog
touch the <computeroutput>OK</computeroutput>. To close the dialog
while abandoning any pending changes, touch
<computeroutput>Cancel</computeroutput>.
</para>
</sect1>
<sect1 xml:id="sect.rdcastmanager.deleting_an_item">
<title>Deleting an Item</title>
<para>
To delete an item and permanently remove it from the feed, select
the desired item and touch the <computeroutput>Delete</computeroutput>
button. The system will prompt for confirmation:
</para>
<para>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="rdcastmanager.delete_item_dialog.png" scale="55"/>
</imageobject>
<caption>
<para>The Delete Item Dialog</para>
</caption>
</mediaobject>
</para>
<para>
then touch the <computeroutput>Yes</computeroutput> button to complete
the operation.
</para>
<warning>
Deletion of an item is permanent; it cannot be undone!
</warning>
<note>
If it is desired to temporarily hide an item, simply untick the
<computeroutput>Item Active</computeroutput> checkbox in the item's
<computeroutput>Editing Item</computeroutput> dialog.
</note>
</sect1>
<sect1 xml:id="sect.rdcastmanager.posting_creating_a_new_item">
<title>Posting: Creating a New Item</title>
<para>
&quot;Posting&quot; is the action by which a new item is added to
a podcast feed. RDCastManager is capable of posting to a feed from
three different sources: a Rivendell cart/cut, a Rivendell log, and
directly from an audio file.
</para>
<sect2 xml:id="sect.rdcastmanager.posting_from_a_rivendell_cart_cut">
<title>Posting from a Rivendell Cart/Cut</title>
<para>
To post the contents of a Rivendell cart/cut, touch the
<computeroutput>Post from Cart/Cut</computeroutput> button to
open the <computeroutput>Select Cut</computeroutput> dialog:
</para>
<para>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="rdcastmanager.select_cut_dialog.png" scale="55"/>
</imageobject>
<caption>
<para>The Select Cut Dialog</para>
</caption>
</mediaobject>
</para>
<para>
Select the desired cart/cut, then touch the
<computeroutput>OK</computeroutput> button. RDCastManager will
upload the audio and then open the
<computeroutput>Editing Item</computeroutput> dialog to allow
the new item's metadata to be set.
</para>
</sect2>
<sect2 xml:id="sect.rdcastmanager.posting_from_a_rivendell_log">
<title>Posting from a Rivendell Log</title>
<para>
To post one or more events from a Rivendell log, touch the
<computeroutput>Post from Log</computeroutput> button to
open the <computeroutput>Select Log</computeroutput> dialog:
</para>
<para>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="rdcastmanager.select_log_dialog.png" scale="55"/>
</imageobject>
<caption>
<para>The Select Log Dialog</para>
</caption>
</mediaobject>
</para>
<para>
Select the log to post, then touch the
<computeroutput>OK</computeroutput> button to bring up the
<computeroutput>Log Render Options</computeroutput> dialog:
</para>
<para>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="rdcastmanager.log_render_options_dialog.png" scale="55"/>
</imageobject>
<caption>
<para>The Select Log Dialog</para>
</caption>
</mediaobject>
</para>
<para>
The following controls are available in this dialog:
</para>
<para>
<variablelist>
<varlistentry>
<term><computeroutput>Virtual Start Time</computeroutput></term>
<listitem>
<para>
Set the virtual start time to be used when rendering the
log. This can be useful for simulating a &quot;real&quot;
log play-out so that dayparting of cuts works as expected.
By default, the wall time when the
<computeroutput>OK</computeroutput> is touched will be used.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><computeroutput>At STOP transition</computeroutput></term>
<listitem>
<para>
Set the action to take during log rendering if a STOP
transition is encountered. If
<computeroutput>Treat as PLAY</computeroutput> (the default)
is selected, rendering will continue as if a PLAY transition
were found. If <computeroutput>Stop Rendering</computeroutput>
is selected, rendering of the log will be terminated at that
point.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><computeroutput>Selected Log Events</computeroutput></term>
<listitem>
<para>
By default, all of the events in the log will be rendered
(subject to possible truncation by a STOP transition as
specified by the setting of
<computeroutput>At STOP Transition</computeroutput>). To
select a subset of events to be rendered, touch the
<computeroutput>Select</computeroutput> button bring up
the <computeroutput>List Log</computeroutput> dialog:
</para>
<para>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="rdcastmanager.list_log_events_dialog.png" scale="55"/>
</imageobject>
<caption>
<para>The List Log Events Dialog</para>
</caption>
</mediaobject>
</para>
<para>
Select the events to be rendered and then touch the
<computeroutput>OK</computeroutput> button to return to the
<computeroutput>Log Render Options</computeroutput> dialog.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
After the desired rendering options set, touch the
<computeroutput>OK</computeroutput> button. RDCastManager will
upload the audio and then open the
<computeroutput>Editing Item</computeroutput> dialog to allow
the new item's metadata to be set.
</para>
</sect2>
<sect2 xml:id="sect.rdcastmanager.posting_an_audio_file">
<title>Posting an Audio File</title>
<para>
To post the contents of an audio file, touch the
<computeroutput>Post from File</computeroutput> button to bring up
the <computeroutput>Select Audio File</computeroutput> dialog.
</para>
<para>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="rdcastmanager.list_log_select_select_audio_file_dialog.png" scale="55"/>
</imageobject>
<caption>
<para>The Select Audio File Dialog</para>
</caption>
</mediaobject>
</para>
<para>
Select the file to be posted and then touch the
<computeroutput>OK</computeroutput> button. RDCastManager will
upload the audio and then open the
<computeroutput>Editing Item</computeroutput> dialog to allow
the new item's metadata to be set.
</para>
</sect2>
</sect1>
</chapter>

1
docs/opsguide/redball.png Symbolic link
View File

@ -0,0 +1 @@
../../icons/redball.png

1
docs/opsguide/redx.png Symbolic link
View File

@ -0,0 +1 @@
../../icons/redx.png

1
docs/opsguide/whiteball.png Symbolic link
View File

@ -0,0 +1 @@
../../icons/whiteball.png

View File

@ -24,6 +24,7 @@ install-exec-am:
mkdir -p $(DESTDIR)@libexecdir@
cp greencheckmark.png $(DESTDIR)@libexecdir@
cp redx.png $(DESTDIR)@libexecdir@
cp blueball.png $(DESTDIR)@libexecdir@
cp greenball.png $(DESTDIR)@libexecdir@
cp redball.png $(DESTDIR)@libexecdir@
cp whiteball.png $(DESTDIR)@libexecdir@
@ -188,6 +189,7 @@ install-exec-am:
uninstall-local:
rm -f $(DESTDIR)@libexecdir@/greencheckmark.png
rm -f $(DESTDIR)@libexecdir@/redx.png
rm -f $(DESTDIR)@libexecdir@/blueball.png
rm -f $(DESTDIR)@libexecdir@/greenball.png
rm -f $(DESTDIR)@libexecdir@/redball.png
rm -f $(DESTDIR)@libexecdir@/whiteball.png
@ -266,6 +268,7 @@ uninstall-local:
EXTRA_DIST = admin.xpm\
blueball.png\
blueball.xpm\
chain.png\
chain.xpm\

BIN
icons/blueball.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 419 B