Updated documentation

- Updated information about dependencies
- Fixed line lengths to look better when viewed on shell
- Removed some trailing whitespaces
This commit is contained in:
Manuel Reimer 2014-11-07 17:31:27 +01:00
parent a1ec8cc283
commit 28413f7f2c
2 changed files with 71 additions and 54 deletions

54
HISTORY
View File

@ -7,14 +7,17 @@ VDR Plugin 'skindesigner' Revision History
Version 0.0.2
- added some more tokens with more detailed audio information in displaychannel -> statusinfo
- added some more tokens with more detailed audio information in
displaychannel -> statusinfo
- added hasVPS for current scheduling in displaychannel -> epginfo
- added common channel logo path for all skins
- changed skin handling so that every skin is directly shown in VDR OSD Menu
- added Theme support, each skin can now have various themes
- fixed a crash if no skindesigner skins are found and plugin setup menu is called from another skin
- fixed a crash if no skindesigner skins are found and plugin setup menu is
called from another skin
- added {durationhours} and {durationminutes} tokens in several view elements
- added discusage icons to menu header view element so that it discusage can be displayed in every menu view
- added discusage icons to menu header view element so that it discusage can be
displayed in every menu view
- added numeric day, month and year tokens in different view elements
- support for global variables type "double"
- added setup options to configure rerun display behaviour
@ -23,37 +26,48 @@ Version 0.0.2
- added vps token in menudetailepg
- implemented cSDDisplayMenu::GetTextAreaFont()
- introduced new viewelement audioinfo in displaychannel
- added setup option to choose Menu Item display method between "at one go" and "after one another"
- fixed bug that new skin was not properly loaded sometimes when skin was changed in OSD Setup menu
- fixed bug that new font was displayed first after VDR restart when font was changed in OSD Setup menu
- display always newest recording of folders in recordings list, thanks@ Lars Hanisch for providing the patch
- added setup option to choose Menu Item display method between "at one go" and
"after one another"
- fixed bug that new skin was not properly loaded sometimes when skin was
changed in OSD Setup menu
- fixed bug that new font was displayed first after VDR restart when font was
changed in OSD Setup menu
- display always newest recording of folders in recordings list,
thanks@ Lars Hanisch for providing the patch
- added extented recording information
- added token {nummenuitem} as number of item for every list, value starts with 1
- added token {nummenuitem} as number of item for every list, value starts
with 1
- fixed bug that x and y of subviews was not respected
- if a subview is completely not set in a skin, the default menu is used
- fixed a bug if displaydetailedtext is called without correct menucat (mailbox plugin)
- fixed a bug if displaydetailedtext is called without correct menucat (mailbox
plugin)
- implemented function drawslope, see Wiki for documentation
- using default menu list in case an invalid MenuCategory is set
- added device info in displaychannel, example in metrixHD
- improved menu icon display, additionally using menu cat
- changed devices list, device numbers start with 0
- fixed bug that hasposter is only true if poster really exists
- no absolute pathes allowed for image type "image", path has to start with {ressourcedir}
- no absolute pathes allowed for image type "image", path has to start with
{ressourcedir}
Version 0.0.3
- added tokens for current video and audio bitrate in displaychannel. Thx @rofafor for the original code
- added tokens for current video and audio bitrate in displaychannel.
Thx @rofafor for the original code
in the femon plugin and _Martin_ for extracting the code in skinflatplus
- changed skin metrixHD to display bitrate infos
- added "active" Token for cutting marks so that a mark can be displayed in a dedicated way if current position
in replay exactly hits the mark
- added {channelname}, {channelid}, {channellogoexists} for all schedules list and current views
- added "active" Token for cutting marks so that a mark can be displayed in a
dedicated way if current position in replay exactly hits the mark
- added {channelname}, {channelid}, {channellogoexists} for all schedules list
and current views
- added printf function for <drawtext>, see Wiki for documentation
- removed code for displaying bitrates in displaychannel again because of incompatibility with dvbapi Plugin
- removed code for displaying bitrates in displaychannel again because of
incompatibility with dvbapi Plugin
- optimized performance when creating a menu list
- fixed Bug that displaychannel was not shown after closing displaymenu with "backspace" (with active
menuorg plugin)
- fixed Bug that displaychannel was not shown after closing displaymenu with
"backspace" (with active menuorg plugin)
- fixed Bug with menuselection Patch
- added tokens {month}, {monthname} and {year} in displaymenutimers listitem and currentitem
- added dedicated tokens for posters and banners in <srapercontent> in displaychannel and displayreplay
- added tokens {month}, {monthname} and {year} in displaymenutimers listitem
and currentitem
- added dedicated tokens for posters and banners in <srapercontent> in
displaychannel and displayreplay

71
README
View File

@ -5,7 +5,7 @@ Written by: Louis Braun <louis DOT braun AT gmx DOT de>
Project's homepage: http://projects.vdr-developer.org/projects/plg-skindesigner
Latest version: http://projects.vdr-developer.org/projects/plg-skindesigner/files
GIT repository: git clone git://projects.vdr-developer.org/vdr-plugin-skindesigner.git
GIT repository: git clone git://projects.vdr-developer.org/vdr-plugin-skindesigner.git
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
@ -16,9 +16,9 @@ See the file COPYING for more information.
Description
-----------
Skindesigner is a VDR skin engine that displays XML based Skins.
Skindesigner is a VDR skin engine that displays XML based Skins.
Currently two XML Skins (MetrixHD and nOpacity freestyle) are included in
Currently two XML Skins (MetrixHD and nOpacity freestyle) are included in
<pluginsourcedir>/skins/
Requirements
@ -26,19 +26,19 @@ Requirements
- VDR version >= 2.0.0
- Installed ImageMagick or GraphicsMagick for displaying png/jpg Icons, Channel Logos
and EPG Images (configurable during make via IMAGELIB = imagemagick|graphicsmagick
parameter)
- cairo
- librsvg-2
- libxml2
- for scaling the video picture to fit into the VDR menu window please use
- for scaling the video picture to fit into the VDR menu window please use
softhddevice plugin revision 87c1c7be (2013-01-01) or newer.
- epgsearch Git since commit ba7c6277 (2013-01-03) to correctly replace the schedules
menu with epgsearch
- epgsearch Git since commit ba7c6277 (2013-01-03) to correctly replace the
schedules menu with epgsearch
Installation
Installation
------------
After "normal" Plugin installation you have to care about the paths for the
@ -53,10 +53,10 @@ XML skins and epg images. The following paths can be set at startup:
-e path, --epgimages=path
Path to the epgimages (Default: <CacheDirectory>/epgimages/)
ResourceDirectory and CacheDirectory are taken from your VDR configuration (make.config
or vdr.pc).
ResourceDirectory and CacheDirectory are taken from your VDR configuration
(make.config or vdr.pc).
During a "make install" the included skins are automatically copied from
During a "make install" the included skins are automatically copied from
<SkinSourceDirectory>/skins/ to the configured path.
For S2-6400 Users: Disable High Level OSD, otherwise the plugin will not be
@ -67,20 +67,21 @@ an suitable true color OSD.
For Xineliboutput Users: Start vdr-sxfe with the --hud option enabled
Since the default skin MetrixHD uses VDROpenSans as font which is not installed per
default, you may want to install this font (included in <SkinSourceDirectory>/fonts/)
first. Otherwise the inside VDRs OSD menu configured vdrOsd Font is used as default.
Since the default skin MetrixHD uses VDROpenSans as font which is not installed
per default, you may want to install this font (included in
<SkinSourceDirectory>/fonts/) first. Otherwise the inside VDRs OSD menu
configured vdrOsd Font is used as default.
Channel Logos
-------------
Since each XML skin is responsible for it's used channel logos, skindesigner searches
for channel logos only in the skin dependend directory
Since each XML skin is responsible for it's used channel logos, skindesigner
searches for channel logos only in the skin dependend directory
<ResourceDirectory>/plugins/skindesigner/skins/<skinname>/logos
Each copy your used logos directly to this directory or set a symbolic link to a common
channellogo directory.
Each copy your used logos directly to this directory or set a symbolic link to
a common channellogo directory.
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
@ -89,17 +90,19 @@ git clone https://github.com/3PO/Senderlogos.git logos
An update of the logos can then be done with a "git pull" just inside this
directory.
In this logo pack all files are named only with lower case letters.
Skindesigner uses the channel name CONVERTED TO LOWER CASE LETTERS to search for an
appropriate channel logo. With this, approximately 90% of the channel logos should work
immediately after placing the channel logos in the correct place. So if you have to change
the name of a channel logo (may be by inserting a space or a hyphen) so that it fits to
the channel name, only use lower case letters, and not the name of the channel with upper
and lower letters as displayed inside VDR.
If no logo is found for the channel name, additionally a search for a logo named as the
ChannelID is performed. Analog to the channel name the ChannelID is also converted to lower
case letters. This allows channel logos for channels with changing names (for instance
Sky Feed Channels).
Additional hint: some channels have slashes in their name (in germany nick/comedy for instance).
In this example, as a dirty hack just create a folder in your channel logo directory named
"nick" and place an image named "comedy.png" inside this folder.
In this logo pack all files are named only with lower case letters.
Skindesigner uses the channel name CONVERTED TO LOWER CASE LETTERS to search
for an appropriate channel logo. With this, approximately 90% of the channel
logos should work immediately after placing the channel logos in the correct
place. So if you have to change the name of a channel logo (may be by inserting
a space or a hyphen) so that it fits to the channel name, only use lower case
letters, and not the name of the channel with upper and lower letters as
displayed inside VDR.
If no logo is found for the channel name, additionally a search for a logo
named as the ChannelID is performed. Analog to the channel name the ChannelID
is also converted to lower case letters. This allows channel logos for channels
with changing names (for instance Sky Feed Channels).
Additional hint: some channels have slashes in their name (in germany
nick/comedy for instance).
In this example, as a dirty hack just create a folder in your channel logo
directory named "nick" and place an image named "comedy.png" inside this folder.