]> git.ipfire.org Git - thirdparty/tvheadend.git/commitdiff
docs: use a table for the program details dialog toolbar items
authorMark Clarkstone <hello@markclarkstone.co.uk>
Tue, 27 Nov 2018 13:16:31 +0000 (13:16 +0000)
committerJaroslav Kysela <perex@perex.cz>
Tue, 27 Nov 2018 13:35:41 +0000 (14:35 +0100)
docs/markdown/epg.md
docs/markdown/introduction.md
src/webui/static/img/doc/epg/series_link.png [deleted file]

index 43ae175c12de3663913d132daa6a9547c8f99935..d84a00f754f0ed59ed06ede101811aa14ba2a162 100644 (file)
@@ -148,35 +148,19 @@ Icon                                                                  | Descript
 
 If you click on a single event, a popup will display detailed
 information about the event. It also allows you to schedule the event
-for recording by clicking on the *[Record program]* button.
-
-For EPG providers that supply series link information there will also be
-a *[Record series]* button that will record all entries in the series.
-
-![EPG Detail 1](static/img/doc/epg/series_link.png)
-
-For events without any series link information, an *[Autorec]* button
-will be provided to create a pseudo-series link using the autorec
-feature.
+for recording, find alternative events and more.
 
 ![EPG Detail 2](static/img/doc/epg/autorec.png)
 
-If you schedule any kind of recording from this point, you can choose a
-specific DVR profile that will apply to the recording or autorec rule.
-This will normally show as *(default)*, but you can define different
-profiles in the **Configuration -\> Recording -\> [Digital Video
-Recorder Profiles](class/dvrconfig)** tab. This allows you to set, for example, more post-
-broadcast padding for a channel that always runs late, or perhaps define
-a different post-processing command to strip adverts out on a commercial
-channel.
-
-You will also see *[Search IMDB]* and *[TheTVDB]* buttons to look for the program by name
-on imdb.com/thetvdb.com, and a *[Play program]* button to watch a program that’s already
-in progress. This second button downloads a playlist file (XSPF or M3U
-depending on your startup options); if your system is configured for it,
-this will automatically launch an appropriate player, otherwise you will
-need to manually open the playlist to start watching (normally a
-double-click on the downloaded file).
+Toolbar item                                                                          | Description
+--------------------------------------------------------------------------------------|------------
+Find info from ... drop-down                                                          | Query an online service for more information on an event. Opens in new window.
+![Play](static/img/doc/icons/control_play.png) *[Play]*                               | Download a playlist file (XSPF or M3U depending on your startup options); if your system is configured for it, this will automatically launch an appropriate player, otherwise you will need to manually open the playlist to start watching (normally a double-click on the downloaded file).
+(default DVR Profile) drop-down                                                       | Choose a specific DVR profile that will apply to the recording or autorec rule. You can define different profiles in the **Configuration -\> Recording -\> [Digital Video Recorder Profiles](class/dvrconfig)** tab. This allows you to set, for example, more post-broadcast padding for a channel that always runs late, or perhaps define a different post-processing command to strip adverts out on a commercial channel.
+![Record](static/img/doc/icons/rec.png) *[Record]*                                    | Record the displayed event.
+![Record Series](static/img/doc/icons/auto_rec.png) *[Record Series]* / *[Autorec]*   | **Record Series:** Series link, Record all EPG-defined episodes in the series/season. **Autorec:** Create a pseudo-series link using the autorec feature.
+![Alternative showings](static/img/doc/icons/control_repeat_blue.png)                 | List/Find alternative showings (exact matches) of this event.
+![Related events](static/img/doc/icons/clock.png)                                     | List/Find related EPG events. 
 
 To close the popup, just click on the [X] window button. The popup isn’t
 modal, so you don’t have to close it before doing something else, and
index 2cdfe5b79ed0a06109817f433338242be153edec..10c39e5729c845aa98a28beee3483734f7a237f7 100644 (file)
@@ -211,71 +211,74 @@ to Add/Save/Edit-type functions, and a [grid](#grids) like a spreadsheet, a pane
 Below is a (VERY) long list of the buttons you'll find in Tvheadend, 
 They're listed here so you can quickly refer back to them at a later date (and know where to find them!).
 
-Button                              | Function
-------------------------------------|-------------------
-Save                                | Save any changes made to the grid/entries/panel.
-Undo                                | Revert any changes made since the last save.
-Add                                 | Display the *Add entry* dialog.
-Delete/Remove                       | Delete the selected entry/entries.
-Edit                                | Edit the selected entries.
-Reset All                           | Reset/clear all filters. 
-                                    | **Electronic Program Guide only.**
-Watch TV                            | Launches Live TV via HTML5 video. 
-                                    | **Electronic Program Guide only.**
-Create Autorec                      | Creates an auto-recording rule based on the current filter criteria. 
-                                    | **Electronic Program Guide only.**
-Play Program                        | Play the program.
-                                    | **Electronic Program Guide/Broadcast details only.**
-Record Program                      | Record the program/event.
-                                    | **Electronic Program Guide/Broadcast details only.**
-Autorec/Record Series               | Create an Auto-record entry matching the current program query. For events that have series-link information available the *Record Series* button will be shown instead.
-                                    | **Electronic Program Guide/Broadcast details only.**
-Force Scan                          | Forces a scan on the selected network(s) or bouquet(s).
-                                    | **Configuration -> DVB Inputs -> Networks/Configuration -> Channel / EPG -> Bouquets only.**
-Map Services                        | *Selected*: Map the selected services to channels. *All*: Map all services to channels. *Detach from bouquet*: Detach the (selected) services from it's bouquet (to prevent changes). 
-                                    | **Configuration -> Channel / EPG -> Channels/Configuration -> DVB Inputs -> Services only.**
-Maintenance                         | *Remove unseen services (PAT/SDT) (7 days+)*: Remove services marked as Missing in PAT/SDT for 7+ days. *Remove all unseen services*: Remove all services not seen for 7+ days. 
-                                    | **Configuration -> DVB Inputs -> Services only.**
-Number Operations                   | *Assign Number*: Assign the lowest available channel number(s) to the selected channel(s). *Number Up*: Increment the selected channel number(s) by 1. *Number Down*: Decrement the selected channel numbers by 1. *Swap Numbers*: Swap the numbers of the two selected channels. 
-                                    | **Configuration -> Channel / EPG -> Channels only.**
-Trigger OTA EPG Grabber             | Force an immediate tune to the OTA EPG mux(es) to request EPG updates. 
-                                    | **Configuration -> Channel / EPG -> EPG Grabber only.**
-Re-run Internal EPG Grabbers        | Re-run all enabled internal grabbers. 
-                                    | **Configuration -> Channel / EPG -> EPG Grabber/EPG Grabber Modules only.**
-Move Up                             | Move the selected entry up in the list. 
-                                    | **Configuration -> Users -> Access entries/Configuration -> Stream -> Stream filters only.**
-Move Down                           | Move the selected entry down in the list. 
-                                    | **Configuration -> Users -> Access entries/Configuration -> Stream -> Stream filters only.**
-Clone                               | Clone the currently selected entry.
-                                    | **Configuration -> Conditional Access (CAs)/Configuration -> Stream -> Stream/Codec Profiles only.**
-Show/Hide Passwords                 | Reveal/Hide password fields. 
-                                    | **Configuration -> Conditional Access (CAs) only.**
-Stop                                | Gracefully stop the selected in-progress recording entry/entries. 
-                                    | **Digital Video Recorder -> Upcoming / Current Recordings only.**
-Abort                               | Abruptly stop the selected in-progress recording entry/entries. 
-                                    | **Digital Video Recorder -> Upcoming / Current Recordings only.**
-Download                            | Download the selected recording. 
-                                    | **Digital Video Recorder -> Finished/Failed/Removed Recordings only.**
-Re-record                           | Re-schedule the selected entry/recording if possible.
-                                    | **Digital Video Recorder -> Finished/Failed/Removed Recordings only.**
-Move to failed                      | Move the selected recording entries to *Failed Recordings*. 
-                                    | **Digital Video Recorder -> Finished Recordings only.**
-Move to finished                    | Move the selected recording entries to the *Finished Recordings*. 
-                                    | **Digital Video Recorder -> Failed Recordings only.**
-Start wizard                        | Start the wizard. 
-                                    | **Configuration -> General -> Base only.**
-Clean image (icon) cache            | Clean-up the stored image files (empty cache and re-fetch icons). 
-                                    | **Configuration -> General -> Image cache only.**
-Re-fetch images                     | Re-refresh image cache (reload images from upstream providers). 
-                                    | **Configuration -> General -> Image cache only.**
-Discover SAT\>IP servers            | Attempt to discover more SAT>IP servers on the network. 
-                                    | **Configuration -> General -> SAT>IP Server only.**
-Apply configuration (run time only) | Apply the entered debugging settings. 
-                                    | **Configuration -> Debugging -> Configuration only.**
-Clear all statistics                | Reset all stream statistics, e.g. BER, PER etc.. 
-                                    | **Status -> Stream only.**
-View Level                          | Show/Hide more advanced options.
-Help                                | Display the help page.
+Button                                   | Function
+-----------------------------------------|-------------------
+Save                                     | Save any changes made to the grid/entries/panel.
+Undo                                     | Revert any changes made since the last save.
+Add                                      | Display the *Add entry* dialog.
+Delete/Remove                            | Delete the selected entry/entries.
+Edit                                     | Edit the selected entries.
+Reset All                                | Reset/clear all filters. 
+                                         | **Electronic Program Guide only.**
+Watch TV                                 | Launches Live TV via HTML5 video. 
+                                         | **Electronic Program Guide only.**
+Create Autorec                           | Creates an auto-recording rule based on the current filter criteria. 
+                                         | **Electronic Program Guide only.**
+Play                                     | Play the program.
+                                         | **Electronic Program Guide/Broadcast details only.**
+Record                                   | Record the program/event.
+                                         | **Electronic Program Guide/Broadcast details only.**
+Autorec/Record Series                    | Create an Auto-record entry matching the current program query. For events that have series-link information available the *Record Series* button will be shown instead.
+                                         | **Electronic Program Guide/Broadcast details only.**
+Force Scan                               | Forces a scan on the selected network(s) or bouquet(s).
+                                         | **Configuration -> DVB Inputs -> Networks/Configuration -> Channel / EPG -> Bouquets only.**
+Map Services                             | *Selected*: Map the selected services to channels. *All*: Map all services to channels. *Detach from bouquet*: Detach the (selected) services from it's bouquet (to prevent changes). 
+                                         | **Configuration -> Channel / EPG -> Channels/Configuration -> DVB Inputs -> Services only.**
+Maintenance                              | *Remove unseen services (PAT/SDT) (7 days+)*: Remove services marked as Missing in PAT/SDT for 7+ days. *Remove all unseen services*: Remove all services not seen for 7+ days. 
+                                         | **Configuration -> DVB Inputs -> Services only.**
+Number Operations                        | *Assign Number*: Assign the lowest available channel number(s) to the selected channel(s). *Number Up*: Increment the selected channel number(s) by 1. *Number Down*: Decrement the selected channel numbers by 1. *Swap Numbers*: Swap the numbers of the two selected channels. 
+                                         | **Configuration -> Channel / EPG -> Channels only.**
+Trigger OTA EPG Grabber                  | Force an immediate tune to the OTA EPG mux(es) to request EPG updates. 
+                                         | **Configuration -> Channel / EPG -> EPG Grabber only.**
+Re-run Internal EPG Grabbers             | Re-run all enabled internal grabbers. 
+                                         | **Configuration -> Channel / EPG -> EPG Grabber/EPG Grabber Modules only.**
+Move Up                                  | Move the selected entry up in the list. 
+                                         | **Configuration -> Users -> Access entries/Configuration -> Stream -> Stream filters only.**
+Move Down                                | Move the selected entry down in the list. 
+                                         | **Configuration -> Users -> Access entries/Configuration -> Stream -> Stream filters only.**
+Clone                                    | Clone the currently selected entry.
+                                         | **Configuration -> Conditional Access (CAs)/Configuration -> Stream -> Stream/Codec Profiles only.**
+Show/Hide Passwords                      | Reveal/Hide password fields. 
+                                         | **Configuration -> Conditional Access (CAs) only.**
+Stop                                     | Gracefully stop the selected in-progress recording entry/entries. 
+                                         | **Digital Video Recorder -> Upcoming / Current Recordings only.**
+Abort                                    | Abruptly stop the selected in-progress recording entry/entries. 
+                                         | **Digital Video Recorder -> Upcoming / Current Recordings only.**
+Download                                 | Download the selected recording. 
+                                         | **Digital Video Recorder -> Finished/Failed/Removed Recordings only.**
+Re-record                                | Re-schedule the selected entry/recording if possible.
+                                         | **Digital Video Recorder -> Finished/Failed/Removed Recordings only.**
+Move to failed                           | Move the selected recording entries to *Failed Recordings*. 
+                                         | **Digital Video Recorder -> Finished Recordings only.**
+Move to finished                         | Move the selected recording entries to the *Finished Recordings*. 
+                                         | **Digital Video Recorder -> Failed Recordings only.**
+Start wizard                             | Start the wizard. 
+                                         | **Configuration -> General -> Base only.**
+Clean image (icon) cache                 | Clean-up the stored image files (empty cache and re-fetch icons). 
+                                         | **Configuration -> General -> Image cache only.**
+Re-fetch images                          | Re-refresh image cache (reload images from upstream providers). 
+                                         | **Configuration -> General -> Image cache only.**
+Discover SAT\>IP servers                 | Attempt to discover more SAT>IP servers on the network. 
+                                         | **Configuration -> General -> SAT>IP Server only.**
+Apply configuration (run time only)      | Apply the entered debugging settings. 
+                                         | **Configuration -> Debugging -> Configuration only.**
+Clear all statistics                     | Reset all stream statistics, e.g. BER, PER etc.. 
+                                         | **Status -> Stream only.**
+View Level                               | Show/Hide more advanced options.
+Help                                     | Display the help page.
+                                         | **Icon-only buttons**
+!["Right Arrow"](static/img/doc/icons/arrow_right.png) (Next)  | Display/Jump to the next associated item, channel or EPG event.
+!["Left Arrow"](static/img/doc/icons/arrow_left.png) (Previous)   | Display/Jump to the previous associated item, channel or EPG event.
 
 Some of these buttons are only displayed in selected tabs/panels (noted in bold underneath).
 For items not listed above, refer to the associated Help page.
diff --git a/src/webui/static/img/doc/epg/series_link.png b/src/webui/static/img/doc/epg/series_link.png
deleted file mode 100644 (file)
index 760024f..0000000
Binary files a/src/webui/static/img/doc/epg/series_link.png and /dev/null differ