mirror of
https://github.com/ElvishArtisan/rivendell.git
synced 2025-05-25 16:58:04 +02:00
2017-11-10 Fred Gleason <fredg@paravelsystems.com>
* Retitled the Operations Guide to 'Operations and Administration Guide'. * Split the Operations Guide into three parts. * Added a 'Configuring Rivendell with RDAdmin' chapter to part 2 of the Operations Guide.
This commit is contained in:
Fred Gleason
parent
f47d6fb4e1
commit
fd80263d43
@ -16367,3 +16367,9 @@
|
||||
2017-11-10 Fred Gleason <fredg@paravelsystems.com>
|
||||
* Added a 'Playing Audio with RDCartSlots' chapter to the
|
||||
Operations Guide.
|
||||
2017-11-10 Fred Gleason <fredg@paravelsystems.com>
|
||||
* Retitled the Operations Guide to 'Operations and Administration
|
||||
Guide'.
|
||||
* Split the Operations Guide into three parts.
|
||||
* Added a 'Configuring Rivendell with RDAdmin' chapter to part 2
|
||||
of the Operations Guide.
|
||||
|
||||
@ -26,6 +26,7 @@ OPSGUIDE_HTML = appendix.filepath_wildcards.html\
|
||||
appendix.rivendell_filter.html\
|
||||
appendix.wings_filter.html\
|
||||
chapter.overview.html\
|
||||
chapter.rdadmin.html\
|
||||
chapter.rdairplay.html\
|
||||
chapter.rdcartslots.html\
|
||||
chapter.rdcatch.html\
|
||||
@ -37,6 +38,9 @@ OPSGUIDE_HTML = appendix.filepath_wildcards.html\
|
||||
chapter.utilities.html\
|
||||
chapter.voicetracking.html\
|
||||
index.html\
|
||||
part.appendices.html\
|
||||
part.rivendell_administration.html\
|
||||
part.rivendell_operations.html\
|
||||
sect.filepath_wildcards.examples.html\
|
||||
sect.gpio_switcher_devices.8x2.html\
|
||||
sect.gpio_switcher_devices.acu1p.html\
|
||||
@ -78,6 +82,8 @@ OPSGUIDE_HTML = appendix.filepath_wildcards.html\
|
||||
sect.gpio_switcher_devices.wheatnet_lio.html\
|
||||
sect.gpio_switcher_devices.wheatnet_slio.html\
|
||||
sect.gplv2.how_to_apply_these_terms_to_your_new_programs.html\
|
||||
sect.rdadmin.manage_groups.html\
|
||||
sect.rdadmin.managing_users.html\
|
||||
sect.rdairplay.editing_a_log.html\
|
||||
sect.rdairplay.layout.html\
|
||||
sect.rdairplay.log_machines.html\
|
||||
@ -121,77 +127,85 @@ OPSGUIDE_HTML = appendix.filepath_wildcards.html\
|
||||
sect.utilities.rdrevert.html\
|
||||
sect.voicetracking.using_the_voicetracker_dialog.html
|
||||
|
||||
OPSGUIDE_IMAGES = rdairplay.audio_meter.png\
|
||||
rdairplay.button_log_widget.png\
|
||||
rdairplay.delete_from.png\
|
||||
rdairplay.edit_button_dialog.png\
|
||||
rdairplay.edit_buttons.png\
|
||||
rdairplay.edit_event_dialog.png\
|
||||
rdairplay.full_log_widget.png\
|
||||
rdairplay.label_widget.png\
|
||||
rdairplay.mode_widget.png\
|
||||
rdairplay.next_stop_widget.png\
|
||||
rdairplay.piewedge_widget.png\
|
||||
rdairplay.postpoint_early_widget.png\
|
||||
rdairplay.postpoint_late_widget.png\
|
||||
rdairplay.postpoint_ontime_widget.png\
|
||||
rdairplay.rdairplay_screenshot.png\
|
||||
rdairplay.select_a_log_dialog.png\
|
||||
rdairplay.soundpanel_widget.png\
|
||||
rdairplay.wallclock_widget.png\
|
||||
rdairplay.where_to.png\
|
||||
rdcartslots.rdcartslots.edit_slot_options_dialog.png\
|
||||
rdcartslots.rdcartslots_screenshot.png\
|
||||
rdcartslots.rivendell_services_dialog.png\
|
||||
rdcartslots.select_cart_dialog.png\
|
||||
rdcatch.add_event_dialog.png\
|
||||
rdcatch.edit_cart_event_dialog.png\
|
||||
rdcatch.edit_download_dialog.png\
|
||||
rdcatch.edit_playout_dialog.png\
|
||||
rdcatch.edit_recording_dialog.png\
|
||||
rdcatch.edit_switcher_event_dialog.png\
|
||||
rdcatch.edit_upload_dialog.png\
|
||||
rdcatch.rdcatch_screenshot.png\
|
||||
rdlibrary.cd_ripper_dialog.png\
|
||||
rdlibrary.edit_cart_dialog.png\
|
||||
rdlibrary.edit_cut_info_dialog.png\
|
||||
rdlibrary.edit_macro_cart_dialog.png\
|
||||
rdlibrary.edit_marker_dialog.png\
|
||||
rdlibrary.import_export_dialog.png\
|
||||
rdlibrary.rdlibrary_screenshot.png\
|
||||
rdlibrary.rip_disk_dialog.png\
|
||||
rdlibrary.set_cart_cut_dialog.png\
|
||||
rdlogedit.edit_log_chain_dialog.png\
|
||||
rdlogedit.edit_log_dialog.png\
|
||||
rdlogedit.edit_log_entry_dialog.png\
|
||||
rdlogedit.edit_log_marker_dialog.png\
|
||||
rdlogedit.edit_voice_track_marker_dialog.png\
|
||||
rdlogedit.rdlogedit_screenshot.png\
|
||||
rdlogedit.select_cart_dialog.png\
|
||||
rdlogin.rdlogin_screenshot.png\
|
||||
rdlogmanager.edit_clock_dialog.png\
|
||||
rdlogmanager.edit_event_assignment_dialog.png\
|
||||
rdlogmanager.edit_grid_dialog.png\
|
||||
rdlogmanager.editing_event.png\
|
||||
rdlogmanager.generate_log_dialog.png\
|
||||
rdlogmanager.generate_log_dialog_fully_merged.png\
|
||||
rdlogmanager.generate_log_dialog_music_merge_required.png\
|
||||
rdlogmanager.generate_log_dialog_traffic_merge_required.png\
|
||||
rdlogmanager.log_clock_list.png\
|
||||
rdlogmanager.log_clocks.png\
|
||||
rdlogmanager.log_events_dialog.png\
|
||||
rdlogmanager.log_grids_dialog.png\
|
||||
rdlogmanager.rdlogmanager_screenshot.png\
|
||||
rdlogmanager.rivendell_services_dialog.png\
|
||||
rdlogmanager.select_date_dialog.png\
|
||||
rdlogmanager.select_report_dates_dialog.png\
|
||||
rdlogmanager.service_association_dialog.png\
|
||||
voicetracking.voice_tracker_dialog.png\
|
||||
voicetracking.voice_tracker_dialog_recording.png\
|
||||
voicetracking.voice_tracker_dialog_track_1_playing.png\
|
||||
voicetracking.voice_tracker_dialog_track_2_playing.png\
|
||||
voicetracking.voice_tracker_dialog_track_completed.png\
|
||||
voicetracking.voice_tracker_dialog_track_selected.png
|
||||
OPSGUIDE_IMAGES = rdadmin.group_dialog.png\
|
||||
rdadmin.login_dialog.png\
|
||||
rdadmin.rdadmin_screenshot.png\
|
||||
rdadmin.rename_group_dialog.png\
|
||||
rdadmin.rivendell_group_list_dialog.png\
|
||||
rdadmin.rivendell_user_list_dialog.png\
|
||||
rdadmin.user_dialog.png\
|
||||
rdairplay.audio_meter.png\
|
||||
rdairplay.button_log_widget.png\
|
||||
rdairplay.delete_from.png\
|
||||
rdairplay.edit_button_dialog.png\
|
||||
rdairplay.edit_buttons.png\
|
||||
rdairplay.edit_event_dialog.png\
|
||||
rdairplay.full_log_widget.png\
|
||||
rdairplay.label_widget.png\
|
||||
rdairplay.mode_widget.png\
|
||||
rdairplay.next_stop_widget.png\
|
||||
rdairplay.piewedge_widget.png\
|
||||
rdairplay.postpoint_early_widget.png\
|
||||
rdairplay.postpoint_late_widget.png\
|
||||
rdairplay.postpoint_ontime_widget.png\
|
||||
rdairplay.rdairplay_screenshot.png\
|
||||
rdairplay.select_a_log_dialog.png\
|
||||
rdairplay.soundpanel_widget.png\
|
||||
rdairplay.wallclock_widget.png\
|
||||
rdairplay.where_to.png\
|
||||
rdcartslots.rdcartslots.edit_slot_options_dialog.png\
|
||||
rdcartslots.rdcartslots_screenshot.png\
|
||||
rdcartslots.rivendell_services_dialog.png\
|
||||
rdcartslots.select_cart_dialog.png\
|
||||
rdcatch.add_event_dialog.png\
|
||||
rdcatch.edit_cart_event_dialog.png\
|
||||
rdcatch.edit_download_dialog.png\
|
||||
rdcatch.edit_playout_dialog.png\
|
||||
rdcatch.edit_recording_dialog.png\
|
||||
rdcatch.edit_switcher_event_dialog.png\
|
||||
rdcatch.edit_upload_dialog.png\
|
||||
rdcatch.rdcatch_screenshot.png\
|
||||
rdlibrary.cd_ripper_dialog.png\
|
||||
rdlibrary.edit_cart_dialog.png\
|
||||
rdlibrary.edit_cut_info_dialog.png\
|
||||
rdlibrary.edit_macro_cart_dialog.png\
|
||||
rdlibrary.edit_marker_dialog.png\
|
||||
rdlibrary.import_export_dialog.png\
|
||||
rdlibrary.rdlibrary_screenshot.png\
|
||||
rdlibrary.rip_disk_dialog.png\
|
||||
rdlibrary.set_cart_cut_dialog.png\
|
||||
rdlogedit.edit_log_chain_dialog.png\
|
||||
rdlogedit.edit_log_dialog.png\
|
||||
rdlogedit.edit_log_entry_dialog.png\
|
||||
rdlogedit.edit_log_marker_dialog.png\
|
||||
rdlogedit.edit_voice_track_marker_dialog.png\
|
||||
rdlogedit.rdlogedit_screenshot.png\
|
||||
rdlogedit.select_cart_dialog.png\
|
||||
rdlogin.rdlogin_screenshot.png\
|
||||
rdlogmanager.edit_clock_dialog.png\
|
||||
rdlogmanager.edit_event_assignment_dialog.png\
|
||||
rdlogmanager.edit_grid_dialog.png\
|
||||
rdlogmanager.editing_event.png\
|
||||
rdlogmanager.generate_log_dialog.png\
|
||||
rdlogmanager.generate_log_dialog_fully_merged.png\
|
||||
rdlogmanager.generate_log_dialog_music_merge_required.png\
|
||||
rdlogmanager.generate_log_dialog_traffic_merge_required.png\
|
||||
rdlogmanager.log_clock_list.png\
|
||||
rdlogmanager.log_clocks.png\
|
||||
rdlogmanager.log_events_dialog.png\
|
||||
rdlogmanager.log_grids_dialog.png\
|
||||
rdlogmanager.rdlogmanager_screenshot.png\
|
||||
rdlogmanager.rivendell_services_dialog.png\
|
||||
rdlogmanager.select_date_dialog.png\
|
||||
rdlogmanager.select_report_dates_dialog.png\
|
||||
rdlogmanager.service_association_dialog.png\
|
||||
utilities.rmlsend_screenshot.png\
|
||||
voicetracking.voice_tracker_dialog.png\
|
||||
voicetracking.voice_tracker_dialog_recording.png\
|
||||
voicetracking.voice_tracker_dialog_track_1_playing.png\
|
||||
voicetracking.voice_tracker_dialog_track_2_playing.png\
|
||||
voicetracking.voice_tracker_dialog_track_completed.png\
|
||||
voicetracking.voice_tracker_dialog_track_selected.png
|
||||
|
||||
|
||||
OPSGUIDE_DEPS = $(OPSGUIDE_IMAGES) \
|
||||
@ -201,6 +215,7 @@ OPSGUIDE_DEPS = $(OPSGUIDE_IMAGES) \
|
||||
opsguide.xml\
|
||||
overview.xml\
|
||||
metadata_wildcards.xml\
|
||||
rdadmin.xml\
|
||||
rdairplay.xml\
|
||||
rdcartslots.xml\
|
||||
rdcatch.xml\
|
||||
@ -211,7 +226,6 @@ OPSGUIDE_DEPS = $(OPSGUIDE_IMAGES) \
|
||||
rivendell_filter.xml\
|
||||
wings_filter.xml\
|
||||
rml.xml\
|
||||
utilities.rmlsend_screenshot.png\
|
||||
utilities.xml\
|
||||
voicetracking.xml
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
<info xmlns="http://docbook.org/ns/docbook">
|
||||
<title>Rivendell Radio Automation System</title>
|
||||
<subtitle>Operations Guide</subtitle>
|
||||
<subtitle>Operations and Administration Guide</subtitle>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname>Fred</firstname><surname>Gleason</surname>
|
||||
|
||||
@ -1,80 +1,81 @@
|
||||
<appendix xmlns="http://docbook.org/ns/docbook" xml:id="appendix.metadata_wildcards">
|
||||
<title>Metadata Wildcards</title>
|
||||
<para>
|
||||
These codes are used in Rivendell to indicate when a substitution of the
|
||||
indicated cart metadata field should be performed --e.g. in the
|
||||
'--metadata-pattern' switch of rdimport(1) or the RLMResolveNowNext*()
|
||||
functions in the Rivendell Loadable Module API.
|
||||
</para>
|
||||
<table xml:id="table.metadata_wildcards" frame="all" pgwide="0">
|
||||
<sect1 xml:id="sect.metadata_wildcards">
|
||||
<title>Metadata Wildcards</title>
|
||||
<tgroup cols="3" align="left" colsep="1" rowsep="1">
|
||||
<colspec colname="Now" colwidth="2.0*"/>
|
||||
<colspec colname="Next" colwidth="2.0*"/>
|
||||
<colspec colname="Field" colwidth="10.0*"/>
|
||||
<tbody>
|
||||
<row><entry>Now</entry><entry>Next</entry><entry>Field</entry></row>
|
||||
<row><entry><userinput>%a</userinput></entry><entry><userinput>%A</userinput></entry><entry>Artist</entry></row>
|
||||
<row><entry><userinput>%b</userinput></entry><entry><userinput>%B</userinput></entry><entry>Record Label</entry></row>
|
||||
<row><entry><userinput>%c</userinput></entry><entry><userinput>%C</userinput></entry><entry>Client</entry></row>
|
||||
<row><entry><userinput>%d(<replaceable><dt></replaceable>)</userinput></entry><entry><userinput>%D(<replaceable><dt></replaceable>)</userinput></entry><entry>Date/Time (see the <link linkend="table.metadata_wildcards.datetimes">Metadata DateTime Specification</link> for values of <userinput><replaceable><dt></replaceable></userinput>)</entry></row>
|
||||
<row><entry><userinput>%e</userinput></entry><entry><userinput>%E</userinput></entry><entry>Agency</entry></row>
|
||||
<row><entry><userinput>%f</userinput></entry><entry><userinput>%F</userinput></entry><entry>[unassigned]</entry></row>
|
||||
<row><entry><userinput>%g</userinput></entry><entry><userinput>%G</userinput></entry><entry>Rivendell group name</entry></row>
|
||||
<row><entry><userinput>%h</userinput></entry><entry><userinput>%H</userinput></entry><entry>Event length (milliseconds)</entry></row>
|
||||
<row><entry><userinput>%i</userinput></entry><entry><userinput>%I</userinput></entry><entry>Cut Description</entry></row>
|
||||
<row><entry><userinput>%j</userinput></entry><entry><userinput>%J</userinput></entry><entry>Cut Number</entry></row>
|
||||
<row><entry><userinput>%k</userinput></entry><entry><userinput>%K</userinput></entry><entry>Start [<userinput>%k</userinput>]/end [<userinput>%K</userinput>] time for <command>rdimport</command><manvolnum>1</manvolnum> [HH:MM:SS]</entry></row>
|
||||
<row><entry><userinput>%l</userinput></entry><entry><userinput>%L</userinput></entry><entry>Album</entry></row>
|
||||
<row><entry><userinput>%m</userinput></entry><entry><userinput>%M</userinput></entry><entry>Composer</entry></row>
|
||||
<row><entry><userinput>%n</userinput></entry><entry><userinput>%N</userinput></entry><entry>Rivendell cart number</entry></row>
|
||||
<row><entry><userinput>%o</userinput></entry><entry><userinput>%O</userinput></entry><entry>Outcue</entry></row>
|
||||
<row><entry><userinput>%p</userinput></entry><entry><userinput>%P</userinput></entry><entry>Publisher</entry></row>
|
||||
<row><entry><userinput>%q</userinput></entry><entry><userinput>%Q</userinput></entry><entry>Start [<userinput>%q</userinput>]/end [<userinput>%Q</userinput>] date for <command>rdimport</command><manvolnum>1</manvolnum> [YYYY-MM-DD]</entry></row>
|
||||
<row><entry><userinput>%r</userinput></entry><entry><userinput>%R</userinput></entry><entry>Conductor</entry></row>
|
||||
<row><entry><userinput>%s</userinput></entry><entry><userinput>%S</userinput></entry><entry>Song ID</entry></row>
|
||||
<row><entry><userinput>%t</userinput></entry><entry><userinput>%T</userinput></entry><entry>Title</entry></row>
|
||||
<row><entry><userinput>%u</userinput></entry><entry><userinput>%U</userinput></entry><entry>User Definied</entry></row>
|
||||
<row><entry><userinput>%v</userinput></entry><entry><userinput>%V</userinput></entry><entry>[Unassigned]</entry></row>
|
||||
<row><entry><userinput>%w</userinput></entry><entry><userinput>%W</userinput></entry><entry>[Unassigned]</entry></row>
|
||||
<row><entry><userinput>%x</userinput></entry><entry><userinput>%X</userinput></entry><entry>[Unassigned]</entry></row>
|
||||
<row><entry><userinput>%y</userinput></entry><entry><userinput>%Y</userinput></entry><entry>Release Year</entry></row>
|
||||
<row><entry><userinput>%z</userinput></entry><entry><userinput>%Z</userinput></entry><entry>[Unassigned]</entry></row>
|
||||
<row><entry><userinput>\r</userinput></entry><entry><userinput>\r</userinput></entry><entry>Literal Carriage Return (ASCII 13)</entry></row>
|
||||
<row><entry><userinput>\n</userinput></entry><entry><userinput>\n</userinput></entry><entry>Literal Linefeed (ASCII 10)</entry></row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
|
||||
<table xml:id="table.metadata_wildcards.datetimes" frame="all" pgwide="0">
|
||||
<title>Metadata DateTime Specification</title>
|
||||
<tgroup cols="2" align="left" colsep="1" rowsep="1">
|
||||
<colspec colname="Wildcard" colwidth="2.0*"/>
|
||||
<colspec colname="Meaning" colwidth="10.0*"/>
|
||||
<tbody>
|
||||
<row><entry>Wildcard</entry><entry>Meaning</entry></row>
|
||||
<row><entry><userinput>d</userinput></entry><entry>The day as a number without a leading zero (1 to 31)</entry></row>
|
||||
<row><entry><userinput>dd</userinput></entry><entry>The day as a number with a leading zero (01 to 31)</entry></row>
|
||||
<row><entry><userinput>ddd</userinput></entry><entry>The abbreviated localized day name ('Mon' or 'Sun')</entry></row>
|
||||
<row><entry><userinput>dddd</userinput></entry><entry>The long localized day name ('Monday' or 'Sunday')</entry></row>
|
||||
<row><entry><userinput>M</userinput></entry><entry>The month as a number without a leading zero (1 to 12)</entry></row>
|
||||
<row><entry><userinput>MM</userinput></entry><entry>The month as a number with a leading zero (01 to 12)</entry></row>
|
||||
<row><entry><userinput>MMM</userinput></entry><entry>The abbreviated localized month name ('Jan' or 'Dec')</entry></row>
|
||||
<row><entry><userinput>MMMM</userinput></entry><entry> The long localized month name ('January' or 'December')</entry></row>
|
||||
<row><entry><userinput>yy</userinput></entry><entry>The last two digits of the year</entry></row>
|
||||
<row><entry><userinput>yyyy</userinput></entry><entry>The full four digits of the year</entry></row>
|
||||
<row><entry><userinput>h</userinput></entry><entry>The hour without a leading zero (0 - 23, or 1 - 12 if using AM/PM display)</entry></row>
|
||||
<row><entry><userinput>hh</userinput></entry><entry>The hour with a leading zero (00 - 23, or 01 -12 if using AM/PM display)</entry></row>
|
||||
<row><entry><userinput>m</userinput></entry><entry>The minute without a leading zero (0 - 59)</entry></row>
|
||||
<row><entry><userinput>mm</userinput></entry><entry>The minute with a leading zero (00 - 59)</entry></row>
|
||||
<row><entry><userinput>s</userinput></entry><entry>The second without a leading zero (00 - 60)</entry></row>
|
||||
<row><entry><userinput>ss</userinput></entry><entry>The second with a leading zero (00 - 60)</entry></row>
|
||||
<row><entry><userinput>z</userinput></entry><entry>The milliseconds without a leading zero (0 - 999)</entry></row>
|
||||
<row><entry><userinput>zzz</userinput></entry><entry>The milliseconds with leading zeros (000 - 999)</entry></row>
|
||||
<row><entry><userinput>AP</userinput></entry><entry>Use AM/PM display. The 'AP' will be replaced by 'AM' or 'PM' as appropriate</entry></row>
|
||||
<row><entry><userinput>ap</userinput></entry><entry>Use AM/PM display. The 'ap' will be replaced by 'am' or 'pm' as appropriate</entry></row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
<para>
|
||||
These codes are used in Rivendell to indicate when a substitution of the
|
||||
indicated cart metadata field should be performed --e.g. in the
|
||||
'--metadata-pattern' switch of rdimport(1) or the RLMResolveNowNext*()
|
||||
functions in the Rivendell Loadable Module API.
|
||||
</para>
|
||||
<table xml:id="table.metadata_wildcards" frame="all" pgwide="0">
|
||||
<title>Metadata Wildcards</title>
|
||||
<tgroup cols="3" align="left" colsep="1" rowsep="1">
|
||||
<colspec colname="Now" colwidth="2.0*"/>
|
||||
<colspec colname="Next" colwidth="2.0*"/>
|
||||
<colspec colname="Field" colwidth="10.0*"/>
|
||||
<tbody>
|
||||
<row><entry>Now</entry><entry>Next</entry><entry>Field</entry></row>
|
||||
<row><entry><userinput>%a</userinput></entry><entry><userinput>%A</userinput></entry><entry>Artist</entry></row>
|
||||
<row><entry><userinput>%b</userinput></entry><entry><userinput>%B</userinput></entry><entry>Record Label</entry></row>
|
||||
<row><entry><userinput>%c</userinput></entry><entry><userinput>%C</userinput></entry><entry>Client</entry></row>
|
||||
<row><entry><userinput>%d(<replaceable><dt></replaceable>)</userinput></entry><entry><userinput>%D(<replaceable><dt></replaceable>)</userinput></entry><entry>Date/Time (see the <link linkend="table.metadata_wildcards.datetimes">Metadata DateTime Specification</link> for values of <userinput><replaceable><dt></replaceable></userinput>)</entry></row>
|
||||
<row><entry><userinput>%e</userinput></entry><entry><userinput>%E</userinput></entry><entry>Agency</entry></row>
|
||||
<row><entry><userinput>%f</userinput></entry><entry><userinput>%F</userinput></entry><entry>[unassigned]</entry></row>
|
||||
<row><entry><userinput>%g</userinput></entry><entry><userinput>%G</userinput></entry><entry>Rivendell group name</entry></row>
|
||||
<row><entry><userinput>%h</userinput></entry><entry><userinput>%H</userinput></entry><entry>Event length (milliseconds)</entry></row>
|
||||
<row><entry><userinput>%i</userinput></entry><entry><userinput>%I</userinput></entry><entry>Cut Description</entry></row>
|
||||
<row><entry><userinput>%j</userinput></entry><entry><userinput>%J</userinput></entry><entry>Cut Number</entry></row>
|
||||
<row><entry><userinput>%k</userinput></entry><entry><userinput>%K</userinput></entry><entry>Start [<userinput>%k</userinput>]/end [<userinput>%K</userinput>] time for <command>rdimport</command><manvolnum>1</manvolnum> [HH:MM:SS]</entry></row>
|
||||
<row><entry><userinput>%l</userinput></entry><entry><userinput>%L</userinput></entry><entry>Album</entry></row>
|
||||
<row><entry><userinput>%m</userinput></entry><entry><userinput>%M</userinput></entry><entry>Composer</entry></row>
|
||||
<row><entry><userinput>%n</userinput></entry><entry><userinput>%N</userinput></entry><entry>Rivendell cart number</entry></row>
|
||||
<row><entry><userinput>%o</userinput></entry><entry><userinput>%O</userinput></entry><entry>Outcue</entry></row>
|
||||
<row><entry><userinput>%p</userinput></entry><entry><userinput>%P</userinput></entry><entry>Publisher</entry></row>
|
||||
<row><entry><userinput>%q</userinput></entry><entry><userinput>%Q</userinput></entry><entry>Start [<userinput>%q</userinput>]/end [<userinput>%Q</userinput>] date for <command>rdimport</command><manvolnum>1</manvolnum> [YYYY-MM-DD]</entry></row>
|
||||
<row><entry><userinput>%r</userinput></entry><entry><userinput>%R</userinput></entry><entry>Conductor</entry></row>
|
||||
<row><entry><userinput>%s</userinput></entry><entry><userinput>%S</userinput></entry><entry>Song ID</entry></row>
|
||||
<row><entry><userinput>%t</userinput></entry><entry><userinput>%T</userinput></entry><entry>Title</entry></row>
|
||||
<row><entry><userinput>%u</userinput></entry><entry><userinput>%U</userinput></entry><entry>User Definied</entry></row>
|
||||
<row><entry><userinput>%v</userinput></entry><entry><userinput>%V</userinput></entry><entry>[Unassigned]</entry></row>
|
||||
<row><entry><userinput>%w</userinput></entry><entry><userinput>%W</userinput></entry><entry>[Unassigned]</entry></row>
|
||||
<row><entry><userinput>%x</userinput></entry><entry><userinput>%X</userinput></entry><entry>[Unassigned]</entry></row>
|
||||
<row><entry><userinput>%y</userinput></entry><entry><userinput>%Y</userinput></entry><entry>Release Year</entry></row>
|
||||
<row><entry><userinput>%z</userinput></entry><entry><userinput>%Z</userinput></entry><entry>[Unassigned]</entry></row>
|
||||
<row><entry><userinput>\r</userinput></entry><entry><userinput>\r</userinput></entry><entry>Literal Carriage Return (ASCII 13)</entry></row>
|
||||
<row><entry><userinput>\n</userinput></entry><entry><userinput>\n</userinput></entry><entry>Literal Linefeed (ASCII 10)</entry></row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
|
||||
<table xml:id="table.metadata_wildcards.datetimes" frame="all" pgwide="0">
|
||||
<title>Metadata DateTime Specification</title>
|
||||
<tgroup cols="2" align="left" colsep="1" rowsep="1">
|
||||
<colspec colname="Wildcard" colwidth="2.0*"/>
|
||||
<colspec colname="Meaning" colwidth="10.0*"/>
|
||||
<tbody>
|
||||
<row><entry>Wildcard</entry><entry>Meaning</entry></row>
|
||||
<row><entry><userinput>d</userinput></entry><entry>The day as a number without a leading zero (1 to 31)</entry></row>
|
||||
<row><entry><userinput>dd</userinput></entry><entry>The day as a number with a leading zero (01 to 31)</entry></row>
|
||||
<row><entry><userinput>ddd</userinput></entry><entry>The abbreviated localized day name ('Mon' or 'Sun')</entry></row>
|
||||
<row><entry><userinput>dddd</userinput></entry><entry>The long localized day name ('Monday' or 'Sunday')</entry></row>
|
||||
<row><entry><userinput>M</userinput></entry><entry>The month as a number without a leading zero (1 to 12)</entry></row>
|
||||
<row><entry><userinput>MM</userinput></entry><entry>The month as a number with a leading zero (01 to 12)</entry></row>
|
||||
<row><entry><userinput>MMM</userinput></entry><entry>The abbreviated localized month name ('Jan' or 'Dec')</entry></row>
|
||||
<row><entry><userinput>MMMM</userinput></entry><entry> The long localized month name ('January' or 'December')</entry></row>
|
||||
<row><entry><userinput>yy</userinput></entry><entry>The last two digits of the year</entry></row>
|
||||
<row><entry><userinput>yyyy</userinput></entry><entry>The full four digits of the year</entry></row>
|
||||
<row><entry><userinput>h</userinput></entry><entry>The hour without a leading zero (0 - 23, or 1 - 12 if using AM/PM display)</entry></row>
|
||||
<row><entry><userinput>hh</userinput></entry><entry>The hour with a leading zero (00 - 23, or 01 -12 if using AM/PM display)</entry></row>
|
||||
<row><entry><userinput>m</userinput></entry><entry>The minute without a leading zero (0 - 59)</entry></row>
|
||||
<row><entry><userinput>mm</userinput></entry><entry>The minute with a leading zero (00 - 59)</entry></row>
|
||||
<row><entry><userinput>s</userinput></entry><entry>The second without a leading zero (00 - 60)</entry></row>
|
||||
<row><entry><userinput>ss</userinput></entry><entry>The second with a leading zero (00 - 60)</entry></row>
|
||||
<row><entry><userinput>z</userinput></entry><entry>The milliseconds without a leading zero (0 - 999)</entry></row>
|
||||
<row><entry><userinput>zzz</userinput></entry><entry>The milliseconds with leading zeros (000 - 999)</entry></row>
|
||||
<row><entry><userinput>AP</userinput></entry><entry>Use AM/PM display. The 'AP' will be replaced by 'AM' or 'PM' as appropriate</entry></row>
|
||||
<row><entry><userinput>ap</userinput></entry><entry>Use AM/PM display. The 'ap' will be replaced by 'am' or 'pm' as appropriate</entry></row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
</sect1>
|
||||
</appendix>
|
||||
|
||||
@ -13,6 +13,7 @@
|
||||
<!ENTITY voicetracking SYSTEM "voicetracking.xml">
|
||||
<!ENTITY rml SYSTEM "rml.xml">
|
||||
<!ENTITY utilities SYSTEM "utilities.xml">
|
||||
<!ENTITY rdadmin SYSTEM "rdadmin.xml">
|
||||
<!ENTITY gplv2 SYSTEM "gplv2.xml">
|
||||
<!ENTITY gpio_switcher_devices SYSTEM "gpio_switcher_devices.xml">
|
||||
<!ENTITY filepath_wildcards SYSTEM "filepath_wildcards.xml">
|
||||
@ -23,23 +24,32 @@
|
||||
|
||||
<book xmlns="http://docbook.org/ns/docbook" version="5.0">
|
||||
&frontspiece;
|
||||
&overview;
|
||||
&rdlogin;
|
||||
&rdlibrary;
|
||||
&rdcatch;
|
||||
&rdlogedit;
|
||||
&rdairplay;
|
||||
&rdcartslots;
|
||||
&rdlogmanager;
|
||||
&voicetracking;
|
||||
&rml;
|
||||
&utilities;
|
||||
&gplv2;
|
||||
&gpio_switcher_devices;
|
||||
&filepath_wildcards;
|
||||
&metadata_wildcards;
|
||||
&rivendell_filter;
|
||||
&wings_filter;
|
||||
<part xml:id="part.rivendell_operations" xmlns="http://docbook.org/ns/docbook" version="5.0">
|
||||
<title>Rivendell Operations</title>
|
||||
&overview;
|
||||
&rdlogin;
|
||||
&rdlibrary;
|
||||
&rdcatch;
|
||||
&rdlogedit;
|
||||
&rdairplay;
|
||||
&rdcartslots;
|
||||
&rdlogmanager;
|
||||
&voicetracking;
|
||||
&rml;
|
||||
&utilities;
|
||||
</part>
|
||||
<part xml:id="part.rivendell_administration" xmlns="http://docbook.org/ns/docbook" version="5.0">
|
||||
<title>Rivendell Administration</title>
|
||||
&rdadmin;
|
||||
</part>
|
||||
<part xml:id="part.appendices" xmlns="http://docbook.org/ns/docbook" version="5.0">
|
||||
&gplv2;
|
||||
&gpio_switcher_devices;
|
||||
&filepath_wildcards;
|
||||
&metadata_wildcards;
|
||||
&rivendell_filter;
|
||||
&wings_filter;
|
||||
</part>
|
||||
</book>
|
||||
|
||||
<!--
|
||||
|
||||
BIN
docs/opsguide/rdadmin.group_dialog.png
Normal file
BIN
docs/opsguide/rdadmin.group_dialog.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 40 KiB |
BIN
docs/opsguide/rdadmin.login_dialog.png
Normal file
BIN
docs/opsguide/rdadmin.login_dialog.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 7.3 KiB |
BIN
docs/opsguide/rdadmin.rdadmin_screenshot.png
Normal file
BIN
docs/opsguide/rdadmin.rdadmin_screenshot.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 24 KiB |
BIN
docs/opsguide/rdadmin.rename_group_dialog.png
Normal file
BIN
docs/opsguide/rdadmin.rename_group_dialog.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 9.1 KiB |
BIN
docs/opsguide/rdadmin.rivendell_group_list_dialog.png
Normal file
BIN
docs/opsguide/rdadmin.rivendell_group_list_dialog.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 46 KiB |
BIN
docs/opsguide/rdadmin.rivendell_user_list_dialog.png
Normal file
BIN
docs/opsguide/rdadmin.rivendell_user_list_dialog.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 20 KiB |
BIN
docs/opsguide/rdadmin.user_dialog.png
Normal file
BIN
docs/opsguide/rdadmin.user_dialog.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 44 KiB |
259
docs/opsguide/rdadmin.xml
Normal file
259
docs/opsguide/rdadmin.xml
Normal file
@ -0,0 +1,259 @@
|
||||
<chapter xmlns="http://docbook.org/ns/docbook" xml:id="chapter.rdadmin">
|
||||
<title>Configuring Rivendell with RDAdmin</title>
|
||||
<sect1 xml:id="sect.rdadmin.overview">
|
||||
<title>Overview</title>
|
||||
<para>
|
||||
RDAdmin is the Rivendell module designed for the comprehensive
|
||||
configuration of the Rivendell system.
|
||||
</para>
|
||||
<para>
|
||||
<mediaobject>
|
||||
<imageobject>
|
||||
<imagedata align="center" fileref="rdadmin.rdadmin_screenshot.png" scale="45"/>
|
||||
</imageobject>
|
||||
<caption>
|
||||
<para>The RDAdmin Main Window</para>
|
||||
</caption>
|
||||
</mediaobject>
|
||||
</para>
|
||||
<para>
|
||||
When starting up RDAdmin, you will be prompted to login in. For a
|
||||
freshly created Rivendell database, the default login parameters are
|
||||
a <computeroutput>User Name:</computeroutput> of
|
||||
<userinput>admin</userinput> with no
|
||||
<computeroutput>Password:</computeroutput>.
|
||||
</para>
|
||||
<para>
|
||||
<mediaobject>
|
||||
<imageobject>
|
||||
<imagedata align="center" fileref="rdadmin.login_dialog.png" scale="45"/>
|
||||
</imageobject>
|
||||
<caption>
|
||||
<para>The Login Dialog</para>
|
||||
</caption>
|
||||
</mediaobject>
|
||||
</para>
|
||||
</sect1>
|
||||
<sect1 xml:id="sect.rdadmin.managing_users">
|
||||
<title>Managing Users</title>
|
||||
<para>
|
||||
To manage users in RDAdmin, touch the
|
||||
<computeroutput>Manage Users</computeroutput> to open the
|
||||
Rivendell User List dialog.
|
||||
</para>
|
||||
<para>
|
||||
<mediaobject>
|
||||
<imageobject>
|
||||
<imagedata align="center" fileref="rdadmin.rivendell_user_list_dialog.png" scale="45"/>
|
||||
</imageobject>
|
||||
<caption>
|
||||
<para>The Rivendell User List Dialog</para>
|
||||
</caption>
|
||||
</mediaobject>
|
||||
</para>
|
||||
<para>
|
||||
Two different types of user exist within Rivendell:
|
||||
<emphasis>administrator</emphasis> users (those which have the
|
||||
<computeroutput>Administer System</computeroutput> right set), who
|
||||
are allowed to login into RDAdmin, and
|
||||
<emphasis>operational</emphasis> users, who are configured to have
|
||||
rights to operate specific portions of the Rivendell system but do
|
||||
not have access to RDAdmin. It is not possible for a single user to
|
||||
act in both roles.
|
||||
</para>
|
||||
<para>
|
||||
A newly created Rivendell database will have one user of each type
|
||||
populated automatically, called "admin" and
|
||||
"user" respectively. To see the attributes of an existing
|
||||
user, select its entry on the <computeroutput>Users</computeroutput>
|
||||
list and touch the <computeroutput>Edit</computeroutput> button to
|
||||
open the User Dialog.
|
||||
</para>
|
||||
<para>
|
||||
<mediaobject>
|
||||
<imageobject>
|
||||
<imagedata align="center" fileref="rdadmin.user_dialog.png" scale="45"/>
|
||||
</imageobject>
|
||||
<caption>
|
||||
<para>The Rivendell User Dialog</para>
|
||||
</caption>
|
||||
</mediaobject>
|
||||
</para>
|
||||
<para>
|
||||
The upper third of the the dialog provides fields for basic information
|
||||
regarding the user as well as authentication settings. If the
|
||||
<computeroutput>Authenticate This User Locally</computeroutput> box
|
||||
is ticked, then the login password for this use can be set by touching
|
||||
the <computeroutput>Change Password</computeroutput> button. If
|
||||
unticked, then authentication is delegated to the Pluggable
|
||||
Authentication Module (PAM) specified in the
|
||||
<computeroutput>PAM Service:</computeroutput> field.
|
||||
</para>
|
||||
<para>
|
||||
The <computeroutput>WebAPI Timeout:</computeroutput> field sets the
|
||||
timeout (in seconds) when connecting to Rivendell's WebAPI
|
||||
component, while the <computeroutput>Allow Web Logins</computeroutput>
|
||||
box, if ticked, permits this user to use the web comonent of
|
||||
RDCastManager.
|
||||
</para>
|
||||
<para>
|
||||
The middle section of the dialog is where individual user rights
|
||||
are assigned for this user. The
|
||||
<computeroutput>Administer System</computeroutput> box, if ticked,
|
||||
will make this user an administrative user while disallowing the
|
||||
selection of any other rights. The other listed rights should be
|
||||
self-explanatory.
|
||||
</para>
|
||||
<para>
|
||||
The bottom of the dialog contains two large buttons. The
|
||||
<computeroutput>Assign Group Permissions</computeroutput> button
|
||||
allows assignment of the specific groups which this user will be
|
||||
allowed to access in RDLibrary, while the
|
||||
<computeroutput>Assign Podcast Feed Permissions</computeroutput>
|
||||
does the same for Podcast Feeds.
|
||||
</para>
|
||||
<para>
|
||||
Touch the <computeroutput>OK</computeroutput> button to commit any
|
||||
changes made, or <computeroutput>Cancel</computeroutput> to
|
||||
abandon them.
|
||||
</para>
|
||||
</sect1>
|
||||
<sect1 xml:id="sect.rdadmin.manage_groups">
|
||||
<title>Managing Groups</title>
|
||||
<para>
|
||||
To manage groups in RDAdmin, touch the
|
||||
<computeroutput>Manage Groups</computeroutput> button to open
|
||||
the Rivendell Group List dialog.
|
||||
</para>
|
||||
<para>
|
||||
<mediaobject>
|
||||
<imageobject>
|
||||
<imagedata align="center" fileref="rdadmin.rivendell_group_list_dialog.png" scale="45"/>
|
||||
</imageobject>
|
||||
<caption>
|
||||
<para>The Rivendell Group List Dialog</para>
|
||||
</caption>
|
||||
</mediaobject>
|
||||
</para>
|
||||
<sect2 xml:id="sect.rdadmin.manage_groups.editing_group_information">
|
||||
<title>Editing Group Information</title>
|
||||
<para>
|
||||
To examine and modify an existing group, touch its entry in the
|
||||
<computeroutput>Groups</computeroutput> list and then touch the
|
||||
<computeroutput>Edit</computeroutput> button to open the
|
||||
Group Dialog.
|
||||
</para>
|
||||
<para>
|
||||
<mediaobject>
|
||||
<imageobject>
|
||||
<imagedata align="center" fileref="rdadmin.group_dialog.png" scale="45"/>
|
||||
</imageobject>
|
||||
<caption>
|
||||
<para>The Rivendell Group Dialog</para>
|
||||
</caption>
|
||||
</mediaobject>
|
||||
</para>
|
||||
<para>
|
||||
The <computeroutput>Default Import Title</computeroutput> is the
|
||||
title string that will be assigned to carts created by dropboxes or
|
||||
<command>rdimport</command><manvolnum>1</manvolnum> when no
|
||||
file-specific title metadata is found. This field recognizes
|
||||
the following wildcards:
|
||||
</para>
|
||||
<table xml:id="table.rdadmin.default_import_title_wildcards" frame="all" pgwide="0">
|
||||
<title>Default Import Title Wildcards</title>
|
||||
<tgroup cols="2" align="left" colsep="1" rowsep="1">
|
||||
<colspec colname="Wildcard" colwidth="1.0*"/>
|
||||
<colspec colname="Value" colwidth="10.0*"/>
|
||||
<tbody>
|
||||
<row><entry>%f</entry><entry>Body part of the filename</entry></row>
|
||||
<row><entry>%e</entry><entry>Extension part of the filename</entry></row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
<para>
|
||||
The <computeroutput>Default Cart Type:</computeroutput> controls
|
||||
which type of cart (<computeroutput>Audio</computeroutput> or
|
||||
<computeroutput>Macro</computeroutput> RDLibrary will default to
|
||||
when creating a new cart in this group.
|
||||
</para>
|
||||
<para>
|
||||
The <computeroutput>Default Cart Number:</computeroutput> fields
|
||||
define a range of cart numbers to use by default for this group
|
||||
--i.e. by RDLibrary or
|
||||
<command>rdimport</command><manvolnum>1</manvolnum>. If the
|
||||
<computeroutput>Enforce Cart Range</computeroutput> box is ticked,
|
||||
Rivendell will not permit carts to be created in or moved to this
|
||||
group whose cart number does not fall within this range.
|
||||
</para>
|
||||
<para>
|
||||
If the
|
||||
<computeroutput>Include this group in Traffic reports</computeroutput> or
|
||||
<computeroutput>Include this group in Music reports</computeroutput> box
|
||||
is ticked, play-outs of carts belonging to this group in a log will
|
||||
be included in traffic or music reports, respectively.
|
||||
</para>
|
||||
<para>
|
||||
If this <computeroutput>Set End Date/Time</computeroutput> box is ticked,
|
||||
then new cuts that belong to this group will have their end date/time
|
||||
automatically set to the specified number of days after the date of
|
||||
creation.
|
||||
</para>
|
||||
<para>
|
||||
If the <computeroutput>Purge expired cuts</computeroutput> box is
|
||||
ticked, then cuts in the group will be purged --i.e. deleted --
|
||||
the specified number of days after they expire. If
|
||||
<computeroutput>Delete cart if empty</computeroutput> is also ticked,
|
||||
then the cart containing the deleted cut will also be deleted if it
|
||||
contains no other cuts.
|
||||
</para>
|
||||
<para>
|
||||
If the <computeroutput>Transmit Now ' Next</computeroutput> box
|
||||
is ticked, then carts in this group will generate an RLM event when
|
||||
played in a log.
|
||||
</para>
|
||||
<para>
|
||||
Carts in this group will be allowed to play only on those services
|
||||
that are shown in the <computeroutput>Active Services</computeroutput>
|
||||
list.
|
||||
</para>
|
||||
<para>
|
||||
To set a color for the group (used when the group name is displayed
|
||||
elsewhere in Rivendell, touch the <computeroutput>Color</computeroutput>
|
||||
button.
|
||||
</para>
|
||||
<para>
|
||||
Touch the <computeroutput>OK</computeroutput> button to commit any
|
||||
changes made, or <computeroutput>Cancel</computeroutput> to
|
||||
abandon them.
|
||||
</para>
|
||||
</sect2>
|
||||
<sect2 xml:id="rdadmin.manage_groups.renaming_groups">
|
||||
<title>Renaming Groups</title>
|
||||
<para>
|
||||
A group can be renamed by touching the
|
||||
<computeroutput>Rename</computeroutput> button. If the
|
||||
<computeroutput>New Group Name:</computeroutput> given already exists,
|
||||
then the carts in this group will be moved into that group.
|
||||
</para>
|
||||
<para>
|
||||
<mediaobject>
|
||||
<imageobject>
|
||||
<imagedata align="center" fileref="rdadmin.rename_group_dialog.png" scale="60"/>
|
||||
</imageobject>
|
||||
<caption>
|
||||
<para>The Rename Group Dialog</para>
|
||||
</caption>
|
||||
</mediaobject>
|
||||
</para>
|
||||
</sect2>
|
||||
<sect2 xml:id="rdadmin.manage_groups.group_reports">
|
||||
<title>Group Report</title>
|
||||
<para>
|
||||
A printable report listing the defined groups and their attributes
|
||||
can be generated by touching the
|
||||
<computeroutput>Generate Report</computeroutput> button.
|
||||
</para>
|
||||
</sect2>
|
||||
</sect1>
|
||||
</chapter>
|
||||
Loading…
x
Reference in New Issue
Block a user