Merge pull request #362 from paddatrapper/docs

Update Calendar Manual

docs/manual/about-this-manual/index.md

@@ -1,10 +1,10 @@
 About this manual
 =================
 
-**Copyright © 2011-2015 Sourcefabric z.ú.
-**
+**Copyright © 2011-2017 Sourcefabric z.ú.**
+**Copyright © 2017 LibreTime Community**
 
-This manual was written for Sourcefabric by Daniel James, using Booktype Pro. Please add your comments and contributions at: [http://sourcefabric.booktype.pro/airtime-pro-for-broadcasters/](../index.html "Airtime Pro for Broadcasters")
+This manual was written for Sourcefabric by Daniel James, using Booktype Pro. It has been converted to markdown and updated by the LibreTime Community. Please add your comments and contributions at: [http://libretime.org/manual/](../index.md)
 
 License
 -------

docs/manual/calendar/index.md

@@ -1,4 +1,4 @@
-The Calendar page of the Airtime administration interface has three views: **day**, **week** and **month**, which can be switched using the grey buttons in the top right corner. By default, the **month** view is shown, with today's date highlighted by a pale green background.
+The Calendar page of the LibreTime administration interface has three views: **day**, **week** and **month**, which can be switched using the grey buttons in the top right corner. By default, the **month** view is shown, with today's date highlighted by a pale grey background.
 
 ![](static/Screenshot451-Calendar.png)
 
@@ -9,7 +9,7 @@ In the top left corner of the page, you can go back or forward through the **Cal
 Adding a show
 -------------
 
-Only *Admins* and *Program Managers* can use this feature. To add a new show to the Calendar, click the **+ Show** button in the top left corner of the page, or click on any future row or box in the Calendar which is empty. Either of these actions opens the **Add this show** box, which has six sections, arranged vertically: **What**, **When**, **Live Stream Input**, **Record & Rebroadcast**, **Who**, and **Style**. Click the small black triangle to the left of the section name if you wish to minimize or maximize it.
+Only *Admins* and *Program Managers* can use this feature. To add a new show to the Calendar, click the **+ New Show** button in the top left corner of the page, or click on any future row or box in the Calendar which is empty. Either of these actions opens the **Add this show** box, which has seven sections, arranged vertically: **What**, **Automatic Playlist**, **When**, **Live Stream Input**, **Record & Rebroadcast**, **Who**, and **Style**. Click the small orange triangle to the left of the section name if you wish to minimize or maximize it.
 
 What
 ----
@@ -18,16 +18,23 @@ In the **What** box, enter the **Name**, public website **URL**, **Genre** and *
 
 ![](static/Screenshot453-Show_what.png)
 
+Automatic Playlist
+------------------
+
+In this section, you can select a playlist that will be used for this show. The playlist must already be defined in your library. **Auto Schedule Playlist** needs to be checked for **Select Playlist** and **Repeat AutoPlaylist Until Show is Full** to be visible.
+
+![](static/Screenshot454-Show_playlist.png)
+
 When
 ----
 
-Next, in the **When** section, if you clicked on a date in the **Calendar** this should already be entered in the **Date/Time Start** field. To set another date for the show, click on the date in the **Date/Time Start** field and select the date that you require from the small pop-up calendar which will appear. Click on the adjacent time field to set the start time for the show, with the pop-up **Hour** and **Minute** box. The Minute values in the pop-up time boxes are rounded to the nearest five minutes. You can also adjust the times manually by clicking into the fields and typing. Repeat the process to set the **Date/Time End** fields. The **Duration** of the show will be displayed automatically, based on the start and end times you have set.
+Next, in the **When** section, if you clicked on a date in the **Calendar** this should already be entered in the **Date/Time Start** field. To set another date for the show, click on the date in the **Date/Time Start** field and select the date that you require from the small pop-up calendar which will appear. Click on the adjacent time field to set the start time for the show, with the pop-up **Hour** and **Minute** box. The Minute values in the pop-up time boxes are rounded to the nearest five minutes. You can also adjust the times manually by clicking into the fields and typing. Repeat the process to set the **Date/Time End** fields. The **Start Time** can be **Now** or **In the Future**. A show that starts now, will start at the time save is pressed, while a future show will start at the time set. The **Duration** of the show will be displayed automatically, based on the start and end times you have set.
 
 By default, the **Timezone** of the show start and end times will be the timezone of the station, as set on the Preferences page on the System menu. You can specify an alternative time zone using the drop-down menu, if you wish. The time zone displayed in the Calendar when you log in depends on your personal settings. See 'Updating your own account' in the chapter *Users* for more details.
 
 ![](static/Screenshot526-Add_show_when_250.png)
 
-Airtime will only allow you to enter valid times for shows. If you attempt to schedule show times which would be impossible, by ending the show before it begins, Airtime will highlight the error with a pink background.
+LibreTime will only allow you to enter valid times for shows. If you attempt to schedule show times which would be impossible, by ending the show before it begins, LibreTime will highlight the error with a pink background.
 
 ![](static/Screenshot527-negative_time250.png)
 
@@ -46,31 +53,31 @@ Uncheck the **No End?** box and set the **Date End** for the regular show to fin
 Live Stream Input
 -----------------
 
-The **Live Stream Input** section can be used to enable live input streams during the show, and also to configure authentication for them. If you check the **Use Airtime Authentication** box, the DJs (presenters) of the show will be able to connect a live stream to Airtime's **Show Source Mount Point** using their login name and password. See the chapter *Stream Settings* for details.
+The **Live Stream Input** section can be used to enable live input streams during the show, and also to configure authentication for them. If you check the **Use LibreTime Authentication** box, the DJs (presenters) of the show will be able to connect a live stream to LibreTime's **Show Source Mount Point** using their login name and password. See the chapter *Stream Settings* for details.
 
-If you check the **Use Custom Authentication** box instead, you can set a one-time username and password pair for live stream input to the show. For example, you may wish to create an authenticated live stream input for a particular remote news reporter, without providing any further access to your Airtime server for that person.
+If you check the **Use Custom Authentication** box instead, you can set a one-time username and password pair for live stream input to the show. For example, you may wish to create an authenticated live stream input for a particular remote news reporter, without providing any further access to your LibreTime server for that person.
 
 ![](static/Screenshot457-Live_stream_input.png)
 
-A reminder of the **Connection URL** for the live input stream to use is shown at the end of the **Live Stream Input** section.
+A reminder of the connection **Host**, **Port** and **Mount** for the live input stream to use is shown at the end of the **Live Stream Input** section.
 
 Record & Rebroadcast
 --------------------
 
-In the **Record & Rebroadcast** section, checking the **Record from Line In?** box enables automatic recording of the soundcard line input, if your Airtime server has one, at the time of the show. Shows set for line-in recording should not also contain files or playlists. The default audio format for live recordings is 256kbps Ogg Vorbis, and the files are saved in the *recorded* folder, under the **Import Folder** path set in the **Media Folders** page on the **System** menu. See the chapter *Host configuration* for details of recorder settings.
+In the **Record & Rebroadcast** section, checking the **Record from Line In?** box enables automatic recording of the soundcard line input, if your LibreTime server has one, at the time of the show. Shows set for line-in recording should not also contain files or playlists. The default audio format for live recordings is 256kbps Ogg Vorbis, and the files are saved in the *recorded* folder, under the **Import Folder** path set in the **Media Folders** page on the **System** menu. See the chapter *Host configuration* for details of recorder settings.
 
 If you wish the recording to be played out at a later time, check the **Rebroadcast?** box, and then select up to ten date and time slots in the **Choose Days** box.
 
 ![](static/Screenshot458-Record_and_rebroadcast.png)
 
-Shows set for recording have a small red dot icon in the calendar, while rebroadcast shows have a white loop icon.
+Shows set for rebroadcast have a white loop icon in the calendar.
 
 ![](static/Screenshot92-Record_and_rebroadcast_icons.png)
 
 Who
 ---
 
-In the **Who** section, type the first few letters of the name of the show's DJ (presenter) in the **Search Users** field to select a name from the Airtime database, or check one of the **DJs** boxes in the vertical list below. This association of a DJ name with a particular show enables that presenter to add playout media to the show, and also to connect a live Show Source input stream (if that has been enabled), so it is important to get the DJ's name right.
+In the **Who** section, type the first few letters of the name of the show's DJ (presenter) in the **Search Users** field to select a name from the LibreTime database, or check one of the **DJs** boxes in the vertical list below. This association of a DJ name with a particular show enables that presenter to add playout media to the show, and also to connect a live Show Source input stream (if that has been enabled), so it is important to get the DJ's name right.
 
 ![](static/Screenshot161-Show_users.png)
 
@@ -98,18 +105,18 @@ Episodes of repeating shows also have an **Instance Description** field in which
 
 ![](static/Screenshot583-Show_instance_description_vC9ooiT.png)
 
-Alternatively, individual shows can be clicked on and dragged to new days and times in the calendar. However, Airtime will not allow you to drag a future show into the past, or drag and drop instances of a repeated show. In the **Day** and **Week** views, show length can be adjusted by clicking on the lower edge of the show box, and dragging the edge of the box upwards or downwards. The new show length is calculated automatically.
+Alternatively, individual shows can be clicked on and dragged to new days and times in the calendar. However, LibreTime will not allow you to drag a future show into the past, or drag and drop instances of a repeated show. In the **Day** and **Week** views, show length can be adjusted by clicking on the lower edge of the show box, and dragging the edge of the box upwards or downwards. The new show length is calculated automatically.
 
 Adding content to a show
 ------------------------
 
-To add content to a show, click the show in any view on the Calendar, and select **Add/Remove Content** from the pop-up menu. Shows that do not yet contain any scheduled content are marked with a red exclamation mark icon, to the right of the show start and end times in the top bar. Shows partially filled with content have a yellow exclamation mark icon. During playout of the show, a green play icon will also be shown in the top bar.
+To add content to a show, click the show in any view on the Calendar, and select **Schedule Tracks** from the pop-up menu. Shows that do not yet contain any scheduled content are marked with a red exclamation mark icon, to the right of the show start and end times in the top bar. Shows partially filled with content have a yellow exclamation mark icon. During playout of the show, a green play icon will also be shown in the top bar.
 
 ![](static/Screenshot488-Add_remove_content.png)
 
-The **Add/Remove Content** action opens a window with the name of the show. Like when using the **Now Playing** page, you can search for content items and add them to the show schedule on the right side of the page. Refer to the *Now Playing* chapter for details.
+The **Schedule Tracks** action opens a window with the name of the show. Like when using the **Now Playing** page, you can search for content items and add them to the show schedule on the right side of the page. Refer to the *Now Playing* chapter for details.
 
-When your show has all the required content, click the **OK** button in the bottom right corner to close the window. Back in the **Calendar**, click the show and select **Show content** from the pop-up menu to view a list of content now included in the show.
+When your show has all the required content, click the **OK** button in the bottom right corner to close the window. Back in the **Calendar**, click the show and select **View** from the pop-up menu to view a list of content now included in the show.
 
 ![](static/Screenshot489-Show_Content.png)
 
@@ -120,21 +127,21 @@ The **Contents of Show** window is a read-only interface featuring an orange bar
 Removing content from a show
 ----------------------------
 
-To remove an individual item from a show, click on the show in the **Calendar**, and select **Add/Remove Content** from the pop-up menu. In the window which opens, click any item you wish to remove from the show, then click **Delete** on the pop-up menu, or check the box in the item's row then click the **Trashcan** icon at the top of the table. To remove all files and playlists from a show, click on the show in the **Calendar**, and select **Remove All Content** from the pop-up menu. 
+To remove an individual item from a show, click on the show in the **Calendar**, and select **Schedule Tracks** from the pop-up menu. In the window which opens, click any item you wish to remove from the show, then click **Delete** on the pop-up menu, or check the box in the item's row then click the **Remove** icon at the top of the table. To remove all files and playlists from a show, click on the show in the **Calendar**, and select **Clear Show** from the pop-up menu. 
 
 Deleting a forthcoming show
 ---------------------------
 
-To delete one forthcoming instance of a repeating show, click on the show in the **Calendar**, and select **Delete**, then **Delete This Instance** from the pop-up menu. If you wish to delete all future instances of a repeating show, select **Delete This Instance and All Following** from the pop-up menu.
+To delete one forthcoming instance of a repeating show, click on the show in the **Calendar**, and select **Delete**, then **Delete Instance** from the pop-up menu. If you wish to delete all future instances of a repeating show, select **Delete Instance and All Following** from the pop-up menu.
 
 ![](static/Screenshot490-Delete_this_instance.png)
 
-You cannot delete or remove content from shows that have already played out. These shows have only one option on the pop-up menu, which is **Show Content**.
+You cannot delete or remove content from shows that have already played out. These shows have only one option on the pop-up menu, which is **View**.
 
 Cancelling playout
 ------------------
 
-If you wish to cancel playout of a show while it is running, click on the show in the **Calendar** and select **Cancel Current Show** from the pop-up menu. Airtime will ask you if you are sure about this action, as it cannot be undone.
+If you wish to cancel playout of a show while it is running, click on the show in the **Calendar** and select **Cancel Show** from the pop-up menu. LibreTime will ask you if you are sure about this action, as it cannot be undone.
 
 ![](static/Screenshot357-Cancel_current_show.png)