Updated README

This commit is contained in:
louis 2014-01-26 12:08:21 +01:00
parent 7cc5019edf
commit 5eabb6e7c8

88
README
View File

@ -29,7 +29,9 @@ Requirements
Description Description
----------- -----------
"TvGuide" is a highly customizable 2D EPG viewer plugin. "TvGuide" is a highly customizable 2D EPG viewer plugin. The "Search & Recordings"
Menü provided by the red button allows to search in the EPG and manage timers,
search timers, series timers and switch timers in an convenient way.
Installation Installation
------------ ------------
@ -54,6 +56,11 @@ During a "make install" the Icons are automatically copied from <PlgSourceDirect
to the default path. Included Theme files are also copied from <PlgSourceDirectory>/themes/ to the default path. Included Theme files are also copied from <PlgSourceDirectory>/themes/
to <ConfigDirectory>/themes/ to <ConfigDirectory>/themes/
If directories for channel logos or icons are set via startup
parameters, images are searched first in these directories. If the image
is not available, an additional search in the according default directory
will be performed.
I recommend to use channel logos from https://github.com/3PO/Senderlogos I recommend to use channel logos from https://github.com/3PO/Senderlogos
To download them just change in the directory you want to place the logos To download them just change in the directory you want to place the logos
and do a: and do a:
@ -81,7 +88,12 @@ Ok: Detailed EPG View of the selected grid
2nd Ok closes the detailed view 2nd Ok closes the detailed view
Red: Search & Recording Menu Red: Search & Recording Menu
Green / Yellow: Jump (default) five channels back / forward Green / Yellow: Jump (default) five channels back / forward
Blue: Switch to currently selected channel Blue: Depends on configured Mode:
Default: Favorites Menu, Switch to channel in
detailed EPG View
Optional: Switch to currently selected channel
Optional: Open detailed EPG view (OK switches
then to channel)
Numeric Keys: If Setup Option "Functionality of numeric Keys" is configured Numeric Keys: If Setup Option "Functionality of numeric Keys" is configured
to "Jump to specific channel", the numeric keys are used for channel number to "Jump to specific channel", the numeric keys are used for channel number
@ -97,38 +109,49 @@ In Search & Recording menu the following options are available:
- Instant Record: create a timer for the currently selected program. An - Instant Record: create a timer for the currently selected program. An
check for timer conflicts will be performed, if a timer conflict occurs, check for timer conflicts will be performed, if a timer conflict occurs,
the involved timers can be adapted to solve the conflict. the involved timers can be adapted to solve the conflict. Alternatively
reruns can be searched and used to solve timer conflicts.
- Delete / Edit Timer: if a timer already exists for the currently selected - Delete / Edit Timer: if a timer already exists for the currently selected
broadcast, this timer can be deleted or edited. broadcast, this timer can be deleted or edited.
- Timer Timeline: displays active timers per day
- Create Search Timer: create an search timer with epgsearch. The most
important options can be defined directly in the menu, expert options
are available via the "advanced options" button.
- Manage Search Timers: edit, delete and check results of search timers
- Create Series Timer: create a periodical timer for a dedicated time on - Create Series Timer: create a periodical timer for a dedicated time on
dedicated days. dedicated days.
- Create Search Timer: create an search timer with epgsearch. The most
important options can be defined directly in the menu, alternatively
epgsearch templates can be used to define the searchtimer options.
- Create Switch Timer: create a switch timer for the currently selected - Create Switch Timer: create a switch timer for the currently selected
program. program.
- Search: search with epgsearch - Search: search with epgsearch
- Check for Timer Conflicts: check for timer conflicts with epgsearch.
- Search in Recordings: check if a recording already exists for the currently - Search in Recordings: check if a recording already exists for the currently
selected program. selected program.
- Check for Timer Conflicts: check for timer conflicts with epgsearch.
The search & recordings menu is intended to present a convenient interface The search & recordings menu is intended to present a convenient interface
to different VDR core recording features and additional epgsearch features. to different VDR core recording features and additional epgsearch features.
The main goal is to reach better usability for "non expert users". Some The main goal is to reach better usability for "non expert users".
advanced features like editing or deleting search timers and creating epgsearch
templates are not implemented. For these "expert settings" the epgsearch plugin
(or the VDR schedules menu replaced by epgsearch) have to be used directly.
The navigation through the search & recording menu can be done easily with The navigation through the search & recording menu can be done easily with
up/down, left/right and the ok key. In scrolling lists, with left/right up/down, left/right and the ok key. In scrolling lists, with left/right
(after the first/last option of the displayed list element is selected) you (after the first/last option of the displayed list element is selected) you
jump directly to the top/bottom of the list. jump to the next page of the list. Pressing up on the first / down on the
last list item jumpps to the end / start of the list.
If the Option "Use folders for instant records" is set, both during creating an If the Option "Use folders for instant records" is set, both during creating an
instant records and a series timer you can choose the directory where the instant records and a series timer you can choose the directory where the
recordings will be stored. As possible folders all entries from VDRs recordings will be stored. As possible folders all entries from VDRs
<VDRCONFIG>/folders.conf will be used. These entries can be edited via OSD <VDRCONFIG>/folders.conf will be used. These entries can be edited via OSD
through VDRs Timers Menu. through VDRs Timers Menu. These folders are also provided to choose a folder
for a search timer.
Favorites Menu: if configured, the blue key provides a favorite menu. In this
menu the current scheduling ("What's on now") and the next upcomming Shows
("What's on next") can be listed. Via the Plugin Setup Menu up to four user
defined times can be configured with a dedicated description (for instance
"Primetime" for 8:15 pm). These user defined times are also shown as options in
the favorites menu. Finally all search timers with the option "use as favorite"
enabled are displayed in the favorites menu. By selecting this entry, all hits
for this search timer are shown.
Setup Options Setup Options
------------- -------------
@ -152,6 +175,8 @@ Setup Options
select between jumping x channels back/forward or to the previous / next select between jumping x channels back/forward or to the previous / next
channel group channel group
- Keys Blue and OK - Keys Blue and OK
Blue: Favorites in normal view, channel switch in det. EPG View, Ok: det. EPG View
or
Blue: Channel Switch, Ok: Detailed EPG Blue: Channel Switch, Ok: Detailed EPG
or or
Blue: Detailed EPG, Ok: Channel Switch Blue: Detailed EPG, Ok: Channel Switch
@ -165,10 +190,6 @@ Setup Options
- Huge Step (Keys 4 / 6) in hours - Huge Step (Keys 4 / 6) in hours
Hours to jump vertically with keys 4 / 6 Hours to jump vertically with keys 4 / 6
- Time Format (12h/24h) - Time Format (12h/24h)
- Use folders for instant records. If set to yes, when creating an instant record
or a series timer you'll be asked about the folder for the recordings.
- Use Remotetimers: Timers are handled not locally but on a VDR Server defined
with the remotetimers plugin.
- Display Reruns in detailed EPG View - Display Reruns in detailed EPG View
* Screen Presentation: * Screen Presentation:
@ -179,20 +200,22 @@ Setup Options
- Width/Height of Channel Header (% of osd width/height) - Width/Height of Channel Header (% of osd width/height)
- Width/Height of Timeline (% of osd width/height) - Width/Height of Timeline (% of osd width/height)
- Number of Channels to display - Number of Channels to display
- Height of Headers (Status Header and EPG View Header, % of osd height)
- Height of Footer - Height of Footer
- Display status header - Display status header
- Height of status header (% of osd height/height)
- Scale video to upper right corner - Scale video to upper right corner
- Rounded corners around video frame - Rounded corners around video frame
- Display Channel Names in Header - Display channel names in Header
- Display channel groups - Display channel groups
- Width/Height of channel groups (% of osd width/height) - Width/Height of channel groups (% of osd width/height)
- Display current time baseline
- Show Channel Logos - Show Channel Logos
show / hide channel logos, if logos are shown: show / hide channel logos, if logos are shown:
- Logo Extension - Logo Extension
jpg / png jpg / png
- Logo width ratio - Logo width ratio
- Logo height ratio - Logo height ratio
- Text Border in Detailed EPG View (in pixel)
- Show EPG Images - Show EPG Images
show / hide EPG images, if images are shown: show / hide EPG images, if images are shown:
- EPG Image width ratio - EPG Image width ratio
@ -208,3 +231,30 @@ Setup Options
Used Font, all Fonts installed on your system are shown Used Font, all Fonts installed on your system are shown
- adjust various font sizes: - adjust various font sizes:
the defined value is added to / subtracted from the default font size the defined value is added to / subtracted from the default font size
* Recording Menus and Favorites
- Use folders for instant records. If set to yes, when creating an instant record
or a series timer you'll be asked about the folder for the recordings.
- Use Remotetimers: Timers are handled not locally but on a VDR Server defined
with the remotetimers plugin.
- Use "What's on now" in favorites
- Use "What's on next" in favorites
- Use user defined time 1 (to 4) in favorites
- Description (1 - 4)
- Time (1 - 4)
- Limit channels in favorites: if set to yes, only the configured channel range
is used to display favorite results (except for search timer favorites)
- start channel
- stop channel
* Image Caching
- Create Log Messages for image loading: enable debug messages for image loading
- Limit Logo Cache: if set to "no", every channel logo is cached. if set to "yes",
only the amount configured for "Maximal number of logos to cache" is cached, all
other logos are always loaded "on the fly"
- Maximal number of logos to cache
- Number of logos to cache at start: number of logos to pre cache at plugin startup
(a too large number causes a slower VDR start)
- Information about image cache sizes