diff --git a/docs/docresources/autorecpopup.png b/docs/docresources/autorecpopup.png index 6b25f680..31929dc7 100644 Binary files a/docs/docresources/autorecpopup.png and b/docs/docresources/autorecpopup.png differ diff --git a/docs/docresources/epg.png b/docs/docresources/epg.png index e359399f..bae7990b 100644 Binary files a/docs/docresources/epg.png and b/docs/docresources/epg.png differ diff --git a/docs/docresources/epg2.png b/docs/docresources/epg2.png index e9986b98..3ea05bee 100644 Binary files a/docs/docresources/epg2.png and b/docs/docresources/epg2.png differ diff --git a/docs/docresources/epg3.png b/docs/docresources/epg3.png new file mode 100644 index 00000000..78d33421 Binary files /dev/null and b/docs/docresources/epg3.png differ diff --git a/docs/html/epg.html b/docs/html/epg.html index 13118c8f..40a715d8 100644 --- a/docs/html/epg.html +++ b/docs/html/epg.html @@ -1,95 +1,130 @@
-Tvheadend has a built in Electronic Program Guide. The EPG is an in memory +

Tvheadend has a built in Electronic Program Guide. The EPG is an in-memory database populated with all the information about events received from -the DVB networks or from XMLTV. -

-The EPG tab displays a filterable paged grid containing all the events -sorted based on start time. +the DVB networks over-the-air or from external grabbers such as XMLTV.

+

+

The EPG tab displays a filterable grid containing all events, +sorted based on start time.

-

-

-
Filtering (or searching) -
- In the EPG top tool bar you can access four input fields. +

+
+Filtering (or searching) +
+

In the EPG top tool bar you can access five input fields. These are used to filter/search for events. The form uses implicit AND between the input fields. This means that all filters must match - for an event to be displayed. + for an event to be displayed.

[Search title...]
- Filter on the event title. The filter uses case insensitive regular - expression. If you don't know what a regular expression is this means - that you can type just parts of the title and filter on that too. - (No need for exact matching). -
[Filter channel...] + Only display events that match the given title. The filter uses case-insensitive + regular expressions. If you don't know what a regular expression is, this simply + means that you can type just parts of the title and filter on that - there's no need + for full, exact matching.
+
[Filter channel...]
Only display events from the selected channel. Channels in the drop down are - ordered by channel number and can be filtered (by name) by typing in the box. -
[Filter tag...] + ordered by channel number and can be filtered (by name) by typing in the box. +
[Filter tag...]
- Only display events from the channels which are included in the selected tag. - Tags are used for grouping channels and is configured by the administrator. -
[Filter content type...] + Only display events from channels which are included in the selected tag. + Tags are used for grouping channels together - such as 'Radio' or 'HDTV' - and are + configured by the administrator. You can start typing a tag name to filter the list. +
[Filter content type...]
- Most DVB networks classify their events into content groups. This field - allows you to filter based on content type. + Only display events that match the given content type tag. Most DVB networks + classify their events into content groups. This field allows you to filter based + on content type (e.g. "Sports" or "Game Show"). Supported tags are determined by + your broadcaster. Again, simply start typing to filter the entries if you have a + long list to choose from.
+
[Filter duration...]
+
+ Only display events that fall between the given minimum and maximum durations. + This allows you to filter for or against, say, a daily broadcast and a weekly omnibus + edition of a programme, or only look for short news bulletins and not the 24-hour + rolling broadcasts.
+
 
+
Options are:
+ + + + + + + +
00:00:01 to 00:15:00 - for very short news bulletins, children's programmes, etc.
00:15:01 to 00:30:00 - for short programmes, e.g. daily soap operas
00:30:01 to 01:30:00 - for medium-length programmes, e.g. documentaries
01:30:01 to 03:00:00 - for longer programmes, e.g. films
03:00:00 to no maximum - for very long programmes, e.g. major sporting events
+
- Thus, if you only would like to browse Movies from your HD-channels you - would select 'HDTV' in the [Filter tag...]-field, and select - 'Movie / Drama' in the [Only include content...]-field. -

- Notice that you don't have to press a 'Search' button, the grid immediately - updates itself as you change the filters. -

- If you would like to clear all filters, just press the [Reset] button. + +

So, if you only want to see Movies from your available HD channels, you + would select 'HDTV' in the [Filter tag...] field, and select + 'Movie / Drama' in the [Filter content type...] field. If you wish, you + could then further limit the search to programmes of between 90 minutes and 3 hours by + selecting '01:30:01 to 03:00:00' in the [Filter duration...] field.

+

+

Note that you don't have to press a 'Search' button: the grid immediately + updates itself as you change the filters.

+

+

You can clear an individual filter by simply deleting its contents, or by selecting + '(Clear filter)' as appropriate on all except the title filter. If you want to + clear all filters, just press the [Reset All] button.

+
 
-
Paging +
+Event details and recording +
-
- In large installations with many channels and full EPG feed there could be - tens of thousands of events in the database. - Therefore the EPG display employs a paging bar at the bottom of the grid. - Use it to browse backwards and forwards in the EPG. It also displays the - total amount of events matched by the current query. - -
Event details and recording -
- If you click on a single event, a popup will display detailed information - about the event. It also allows the user to schedule the event for recording - by clicking on the [Record program] button. +

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. + [Record series] button that will record all entries in the series.

- For events without any series link information, a [Autorec] button will be - provided to create a pseudo series link using the Autorec feature. -

- -

- To close the popup, just close it with the [X] window button. - The popup is not modal and you can open as many detailed information popups - as you want. + For events without any series link information, an [Autorec] button will be + provided to create a pseudo-series link using the autorec feature.

+

+ +

+

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 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 a Search IMDB link to look for the programme by name on + imdb.com, and a Play link to watch a programme that's already in progress. This + second link 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).

+

+

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 you can open as many detailed information popups as you want.

+
 
- -
Autorecordings -
- Should you wish to record all events matching a specific query. (Record - your favorite TV-show, etc) you can press the [Create Autorec] button - in the top toolbar. -

- A popup with details about the to-be-created autorecording rule needs to - be confirmed before the rule takes effect. -

+

+ Autorecordings +
+

Should you wish to record all events matching a specific query (to record + your favourite show every week, for example) you can press the [Create AutoRec] + button in the top toolbar.

+

+

A popup with details about the to-be-created autorecording rule needs to + be confirmed before the rule takes effect.

+

-

- The autorecordings can later be changed/deleted in under the - 'Digital Video Recorder'-tag. Use that editor if you temporary want - to disable an autorecording or make adjustments, etc. +

+

You can change or delete the autorec rules in the + Digital Video Recorder tab. Use that editor if you temporarily want + to disable an autorecording or make adjustments to the channel, tag, or similar.

+
 
-
Watch TV -
- If you want to watch live TV in the web UI, the [Watch TV] button will pop-up +
+ Watch TV +
+

If you want to watch live TV in the web UI, the [Watch TV] button will pop up a VLC plugin window (if you don't have the plugin installed a direct URL should be - provided to load into your preferred media player). - + provided to load into your preferred media player).