diff --git a/docs/_data/nav.yml b/docs/_data/nav.yml index ba328bb49..a679202f4 100644 --- a/docs/_data/nav.yml +++ b/docs/_data/nav.yml @@ -1,4 +1,4 @@ -# Navigation +# Navigation for Docs page (guides.md) djguides: - page: Broadcasting Live url: live-broadcast @@ -11,7 +11,7 @@ djguides: managerguides: - page: Playout History & Auditing - url: playout-history + url: analytics - page: Rights and Royalties url: rights-royalties - page: User Management diff --git a/docs/analytics.md b/docs/analytics.md index af43464ce..e2c1363e9 100644 --- a/docs/analytics.md +++ b/docs/analytics.md @@ -13,6 +13,8 @@ Search results can be copied to the clipboard using the **Copy** button, exporte This page has three tabs: **Log Sheet**, **File Summary** and **Show Summary**. On any of these tabs, you can select a date and time range by clicking the calendar and clock icons in the upper left corner of the page. Then click the search button, which has a magnifying glass icon, to the right. A list of files played during that date and time range will appear further down the page. +![](img/log-sheet.png) + In the **Log Sheet** tab, the playout history is sorted by **Start Time** and **End Time** by default. The number of times each file was played and the length of the files are shown in the **File Summary** tab. To make optimal use of this feature for royalty reporting purposes, music files must be tagged with **Composer** and **Copyright** metadata. The artist performing a piece of music may not be the original composer of the work, or the copyright holder of the sound recording. @@ -27,8 +29,12 @@ Log entries can also be manually deleted, using the button with the trashcan ico ## History Templates +![](img/history-templates.png) + The **History Templates** page on the History menu enables you to prepare reports with the exact content required by regulatory agencies in the territories that you are broadcasting to. You can begin creating a custom template by clicking the button **New Log Sheet Template** or the button **New File Summary Template**. +![](img/new-hist-temp.png) + Either of these actions opens a page in which you can name the new template, and add or remove elements from the list on the left. To add a new element from the list on the right, click the plus icon for the item you require. If the element you require is not listed, you can use the **Add New Field** box at the lower end of the right side column. Select *string*, *boolean*, *integer*, or *float*, depending on the type of data that you wish to log, and then click the **+ Add** button. When the template is in the format you require, click the **Save** button, and **Set Default Template** if you wish. The new template will now be listed on the History Templates page. If you have set a new default template, any changes will be visible on the tabs of the Playout History page. diff --git a/docs/api.md b/docs/api.md index b75477be8..e43062920 100644 --- a/docs/api.md +++ b/docs/api.md @@ -1,6 +1,7 @@ --- layout: default title: LibreTime API Usage +git: api.md --- The LibreTime API enables many types of information about the broadcast schedule and configuration to be retrieved from the LibreTime server. Other than the live-info and week-info data fetched by website widgets (see the chapter *Exporting the schedule*), all API requests must be authenticated using the secret API key stored in the file */etc/airtime/api\_client.cfg* on the LibreTime server. This key is autogenerated during LibreTime installation and should be unique for each server. diff --git a/docs/contribute.md b/docs/contribute.md index f86b4a500..068bd0d4e 100644 --- a/docs/contribute.md +++ b/docs/contribute.md @@ -1,7 +1,7 @@ --- layout: default title: Contributing to LibreTime - +git: contribute.md --- > LibreTime is a fork of AirTime due to stalled development of the FLOSS version. For background on this, @@ -27,7 +27,9 @@ supported? Follow [this guide](interface-localization) to add your language to L ## Help write documentation for LibreTime Our site is now run by Jekyll. After cloning our repo locally, enter the `/docs` directory and run + ``` +bundle install jekyll serve ``` diff --git a/docs/hd-audio-modules.md b/docs/hd-audio-modules.md index a4dfbd5df..f97025cd0 100644 --- a/docs/hd-audio-modules.md +++ b/docs/hd-audio-modules.md @@ -1,6 +1,7 @@ --- layout: default title: HD Audio Modules +git: hd-audio-modules.md --- This listing is provided to help ensure that the correct model parameter is passed to the ALSA kernel module for an Intel HDA soundcard, if one is fitted to your LibreTime server. See the chapter *Preparing the server* in this book for more details. diff --git a/docs/icecast-shoutcast.md b/docs/icecast-shoutcast.md index 079e79c16..45f7767aa 100644 --- a/docs/icecast-shoutcast.md +++ b/docs/icecast-shoutcast.md @@ -1,6 +1,7 @@ --- layout: default title: Icecast and Shoutcast Stream Configuration +git: icecast-shoutcast.md --- ## Background diff --git a/docs/img/history-templates.png b/docs/img/history-templates.png new file mode 100644 index 000000000..cf5213fcc Binary files /dev/null and b/docs/img/history-templates.png differ diff --git a/docs/img/log-sheet.png b/docs/img/log-sheet.png new file mode 100644 index 000000000..22341628f Binary files /dev/null and b/docs/img/log-sheet.png differ diff --git a/docs/img/logsheet-selall.png b/docs/img/logsheet-selall.png new file mode 100644 index 000000000..843ec772d Binary files /dev/null and b/docs/img/logsheet-selall.png differ diff --git a/docs/img/new-hist-temp.png b/docs/img/new-hist-temp.png new file mode 100644 index 000000000..dab9c00e7 Binary files /dev/null and b/docs/img/new-hist-temp.png differ diff --git a/docs/img/showsum.png b/docs/img/showsum.png new file mode 100644 index 000000000..03897da5f Binary files /dev/null and b/docs/img/showsum.png differ diff --git a/docs/img/user-edit.png b/docs/img/user-edit.png new file mode 100644 index 000000000..a7b3f412e Binary files /dev/null and b/docs/img/user-edit.png differ diff --git a/docs/img/user-list.png b/docs/img/user-list.png new file mode 100644 index 000000000..40a62a708 Binary files /dev/null and b/docs/img/user-list.png differ diff --git a/docs/microsite.md b/docs/microsite.md index 5411dcb33..dbfed0246 100644 --- a/docs/microsite.md +++ b/docs/microsite.md @@ -1,6 +1,7 @@ --- layout: default title: Built-in Microsite +git: microsite --- ![](img/radio-page.png) diff --git a/docs/preparing-media.md b/docs/preparing-media.md index 2134fbf6c..e32cbeb07 100644 --- a/docs/preparing-media.md +++ b/docs/preparing-media.md @@ -1,7 +1,7 @@ --- layout: default title: Preparing Media for LibreTime - +git: preparing-media.md --- Before uploading media to an LibreTime server, there are a number of factors which should be considered. Getting your ingest workflow right will save you a lot of time later. diff --git a/docs/rights-royalties.md b/docs/rights-royalties.md index 853a37bf5..f02adf87b 100644 --- a/docs/rights-royalties.md +++ b/docs/rights-royalties.md @@ -1,6 +1,7 @@ --- layout: default title: Rights and Royalties +git: rights-royalties.md --- If you're new to broadcasting, or have not streamed your station online before, diff --git a/docs/settings.md b/docs/settings.md index a51e3c049..c57b96007 100644 --- a/docs/settings.md +++ b/docs/settings.md @@ -1,6 +1,7 @@ --- layout: default title: Settings +git: settings.md --- diff --git a/docs/upgrading.md b/docs/upgrading.md index b4ee847be..8423f1b6b 100644 --- a/docs/upgrading.md +++ b/docs/upgrading.md @@ -1,7 +1,7 @@ --- layout: default title: Upgrading LibreTime - +git: upgrading.md --- ## LibreTime versioning diff --git a/docs/users.md b/docs/users.md index 9ab93fcd2..d8f49599c 100644 --- a/docs/users.md +++ b/docs/users.md @@ -8,7 +8,7 @@ git: users.md it is recommended that you create a second administrator account with a secure password and then delete the `admin` account, for best security practice. -## Adding user accounts +## User Account Types To add further user accounts to the system, one for each of your station staff that need access to Airtime, click the **New User** button with the plus icon. Enter a user name, password and contact details, and then select the **User Type** from the drop down menu, which can be *Admin*, *Program Manager*, *DJ*, or *Guest*. The difference between these user types is: @@ -37,11 +37,15 @@ To add further user accounts to the system, one for each of your station staff t ## Editing or deleting user accounts +![](img/user-list.png) + New user accounts that you add will be shown in the table on the left side of the **Users** page. If you have a large number of users on the system, you can use the search tool above the table (which has a magnifying glass icon) to identify specific user accounts. Click the white chevrons in the table headings to sort the search results by **Username**, **First Name**, **Last Name** or **User Type**. +![](img/user-edit.png) + To edit a user account, click on that user's row in the table, change the user's details in the box on the right side, and then click the **Save** button. To remove a user account, click the small **x** icon to the right side of its row in the table. You cannot delete your own user account, and usernames cannot be changed once created. diff --git a/docs/vagrant.md b/docs/vagrant.md index c57c548d5..9fc749e3f 100644 --- a/docs/vagrant.md +++ b/docs/vagrant.md @@ -1,7 +1,7 @@ --- layout: default title: Using Vagrant and Virtualbox for developing LibreTime - +git: vagrant.md --- > Prerequisites: git, [Vagrant](https://vagrantup.com), libvirt or VirtualBox