diff --git a/ChangeLog b/ChangeLog index e44b867b..84739f44 100644 --- a/ChangeLog +++ b/ChangeLog @@ -18329,3 +18329,8 @@ 'pypad.Receiver::setPadCallback()'. 2019-01-08 Fred Gleason <fredg@paravelsystems.com> * Removed sample RLM configurations from 'conf/'. +2019-01-08 Fred Gleason <fredg@paravelsystems.com> + * Removed the 'Configuring Now & Next Parameters' subsection from + 'Configuring RDAirPlay' in the Operations Guide. + * Added a 'Managing PyPAD Instances' subsection to the 'Configuring + RDAirPlay section in the Operations Guide. diff --git a/docs/opsguide/Makefile.am b/docs/opsguide/Makefile.am index b8fa0bcf..bc7575a0 100644 --- a/docs/opsguide/Makefile.am +++ b/docs/opsguide/Makefile.am @@ -150,6 +150,7 @@ OPSGUIDE_IMAGES = rdadmin.audio_resource_information_dialog.png\ rdadmin.edit_channel_gpios_dialog.png\ rdadmin.edit_gpi_dialog.png\ rdadmin.edit_host_variable_dialog.png\ + rdadmin.edit_pypad_instance_dialog.png\ rdadmin.edit_serial_ports_dialog.png\ rdadmin.edit_service_dialog.png\ rdadmin.edit_switcher_dialog.png\ @@ -162,6 +163,7 @@ OPSGUIDE_IMAGES = rdadmin.audio_resource_information_dialog.png\ rdadmin.list_gpis_dialog.png\ rdadmin.log_importation_string_fields.png\ rdadmin.login_dialog.png\ + rdadmin.pypad_instances_dialog.png\ rdadmin.rdadmin_screenshot.png\ rdadmin.rdairplay_channel_assignments.png\ rdadmin.rdairplay_display_settings.png\ @@ -183,6 +185,7 @@ OPSGUIDE_IMAGES = rdadmin.audio_resource_information_dialog.png\ rdadmin.rivendell_switcher_list_dialog.png\ rdadmin.rivendell_user_list_dialog.png\ rdadmin.scheduler_code_dialog.png\ + rdadmin.select_pypad_script_dialog.png\ rdadmin.select_scheduler_codes_dialog.png\ rdadmin.services_dialog.png\ rdadmin.system_wide_settings_dialog.png\ diff --git a/docs/opsguide/rdadmin.configure_rdairplay_dialog.png b/docs/opsguide/rdadmin.configure_rdairplay_dialog.png index 26d40f5c..4e63634c 100644 Binary files a/docs/opsguide/rdadmin.configure_rdairplay_dialog.png and b/docs/opsguide/rdadmin.configure_rdairplay_dialog.png differ diff --git a/docs/opsguide/rdadmin.edit_pypad_instance_dialog.png b/docs/opsguide/rdadmin.edit_pypad_instance_dialog.png new file mode 100644 index 00000000..5351472d Binary files /dev/null and b/docs/opsguide/rdadmin.edit_pypad_instance_dialog.png differ diff --git a/docs/opsguide/rdadmin.host_dialog.png b/docs/opsguide/rdadmin.host_dialog.png index f39d01ed..544ca7d3 100644 Binary files a/docs/opsguide/rdadmin.host_dialog.png and b/docs/opsguide/rdadmin.host_dialog.png differ diff --git a/docs/opsguide/rdadmin.pypad_instances_dialog.png b/docs/opsguide/rdadmin.pypad_instances_dialog.png new file mode 100644 index 00000000..b1f90818 Binary files /dev/null and b/docs/opsguide/rdadmin.pypad_instances_dialog.png differ diff --git a/docs/opsguide/rdadmin.select_pypad_script_dialog.png b/docs/opsguide/rdadmin.select_pypad_script_dialog.png new file mode 100644 index 00000000..94bc6ee0 Binary files /dev/null and b/docs/opsguide/rdadmin.select_pypad_script_dialog.png differ diff --git a/docs/opsguide/rdadmin.xml b/docs/opsguide/rdadmin.xml index ded71470..b35c98b2 100644 --- a/docs/opsguide/rdadmin.xml +++ b/docs/opsguide/rdadmin.xml @@ -1313,69 +1313,6 @@ </para> </note> </sect3> - <sect3 xml:id="rdadmin.manage_hosts.configuring_now___next_parameters"> - <title>Configuring Now & Next Parameters</title> - <para> - Transmission of program associated data (PAD) (also known as - <emphasis>Now & Next</emphasis> in Rivendell) can be configured - by touching the - <computeroutput>Configure Now & Next Parameters</computeroutput> - button, bringing up the Edit Now & Next Data Dialog. - </para> - <para> - <mediaobject> - <imageobject> - <imagedata align="center" fileref="rdadmin.rdairplay_edit_now___next_data_dialog.png" scale="60"/> - </imageobject> - <caption> - <para>The Edit Now & Next Data Dialog</para> - </caption> - </mediaobject> - </para> - <note> - <para> - Now & Next data for Rivendell was originally transmitted by - means of an integrated UDP packet transmitter. While currently - still supported, this method has been deprecated in favor of the - <emphasis>Rivendell Loadable Modules</emphasis> (RLMs), a far more - powerful method that involves the use of plug-in code modules. RLM - is the only method that is documented here. - </para> - </note> - <para> - RLMs can be added by touching the - <computeroutput>Add</computeroutput> button to bring up the - Edit Plugin Dialog. - </para> - <para> - <mediaobject> - <imageobject> - <imagedata align="center" fileref="rdadmin.rdairplay_edit_plugin_dialog.png" scale="60"/> - </imageobject> - <caption> - <para>The Edit Plugin Dialog</para> - </caption> - </mediaobject> - </para> - <para> - The <computeroutput>Plugin Path:</computeroutput> field should - contain the full path to the RLM plug-in binary. For all RLMs - provided as part of stock Rivendell, the - <computeroutput>Argument:</computeroutput> field should contain - the full path to the configuration file for the plug-in, samples of - which can be found in the Rivendell docuementation directory. - </para> - <warning> - <para> - When configuring a new plug-in, be sure to make a <emphasis>copy - </emphasis> of the configuration file to the - <userinput>/etc</userinput> directory - and use it, rather than pointing to the original. Otherwise, any - changes made to the file may be overwritten next time Rivendell - is upgraded on the system! - </para> - </warning> - </sect3> </sect2> <sect2 xml:id="sect.rdadmin.manage_hosts.configuring_rdpanel"> <title>Configuring RDPanel</title> @@ -2263,6 +2200,69 @@ <xref linkend="sect.rml.disconnect_jack_ports__jd_" />. </para> </sect2> + <sect2 xml:id="sect.rdadmin.managing_pypad_instances"> + <title>Managing PyPAD Instances</title> + <para> + PyPAD is a system that is built into Rivendell that + allows processing and transmission of Program Associated Data [PAD] + by means of scripts written in the popular Python programming + language. To see the list of PyPAD scripts configured to run on + the selected host, touch the + <computeroutput>PyPAD Instances</computeroutput> button to open + the PyPAD Instances dialog. + </para> + <para> + <mediaobject> + <imageobject> + <imagedata align="center" fileref="rdadmin.pypad_instances_dialog.png" scale="60"/> + </imageobject> + <caption> + <para>The PyPAD Instances Dialog</para> + </caption> + </mediaobject> + </para> + <para> + To add a new PyPAD instance, touch the + <computeroutput>Add</computeroutput> button to open the Select PyPAD + Script dialog. + </para> + <para> + <mediaobject> + <imageobject> + <imagedata align="center" fileref="rdadmin.select_pypad_script_dialog.png" scale="60"/> + </imageobject> + <caption> + <para>The Select PyPAD Script Dialog</para> + </caption> + </mediaobject> + </para> + <para> + Select a script from the list and then touch the + <computeroutput>Open</computeroutput> button to open the Edit PyPAD + Instance dialog. + </para> + <para> + <mediaobject> + <imageobject> + <imagedata align="center" fileref="rdadmin.edit_pypad_instance_dialog.png" scale="60"/> + </imageobject> + <caption> + <para>The Select PyPAD Script Dialog</para> + </caption> + </mediaobject> + </para> + <para> + The <computeroutput>Configuration</computeroutput> box contains lines of + text that control the behavior of the script that's been selected. + Lines that begin with a semicolon character [;] are comments; the rest + are directives to the script. + </para> + <para> + When finished editing the configuration, touch the + <computeroutput>OK</computeroutput> button to save the configuration + and start the script running. + </para> + </sect2> </sect1> <sect1 xml:id="sect.rdadmin.manage_system_settings"> <title>Managing System Settings</title>