summaryrefslogtreecommitdiff
path: root/Docs
diff options
context:
space:
mode:
authorVille Skyttä <ville.skytta@iki.fi>2009-07-13 01:12:24 +0300
committerVille Skyttä <ville.skytta@iki.fi>2009-07-13 01:12:24 +0300
commit41d45011c24740abfcaae9ecf0ea3f1906c6f29e (patch)
tree40c29c378b9f96b2c166246f63660c9b4e6cf08a /Docs
parent457026f870e5d2916347212ead617ff15b1e9bf1 (diff)
downloadvdr-plugin-text2skin-41d45011c24740abfcaae9ecf0ea3f1906c6f29e.tar.gz
vdr-plugin-text2skin-41d45011c24740abfcaae9ecf0ea3f1906c6f29e.tar.bz2
Replace internal freetype font handling with VDR's font facilities.
Skins that use fonts other than VDR's standard "Osd", "Fix", and "Sml" need to be adapted to use font names as understood by VDR's CreateFont() (Family:Style as of writing this) instead of filenames in their font attributes' names, to use '@' instead of ':' as the separator before sizes, and have fonts shipped with the skin installed and configured in fontconfig. Typically, install font files (if necessary) to a dir somewhere, run fc-cache(1) on the dir, replace for example font="SomeFont.ttf:22,85" with font="Some Font@22,85" or font="SomeFontBold.ttf:22,85" with font="Some Font:Bold@22,85" in the *.skin file. Also, in case the shipped fonts are derivatives of some existing ones, they may need to be properly renamed to something so they will be used instead of the original if it happens to be installed. (closes #36)
Diffstat (limited to 'Docs')
-rw-r--r--Docs/Reference.txt22
-rw-r--r--Docs/Tutorial.txt15
2 files changed, 23 insertions, 14 deletions
diff --git a/Docs/Reference.txt b/Docs/Reference.txt
index eca00f8..718737f 100644
--- a/Docs/Reference.txt
+++ b/Docs/Reference.txt
@@ -371,7 +371,7 @@ A multiline text.
| font | STRING | Font name (see 4.3 font)
-----------------------------------------------------------------------------
- <scrolltext x1="24" y1="138" y2="-72" x2="583" font="helmetr.ttf:20" color="#AFFFFF00">
+ <scrolltext x1="24" y1="138" y2="-72" x2="583" font="Sans Serif@20" color="#AFFFFF00">
{PresentShortText}
{PresentDescription}
</scrolltext>
@@ -918,15 +918,23 @@ There are three predefined fonts
* Fix
* Sml
-If the freetype library is installed it is possible to use every True-Type font in the directories
- /etc/vdr/plugins/text2skin/fonts/
-or
- /etc/vdr/plugins/text2skin/SkinName/
+It is possible to use True Type fonts installed and configured for fontconfig's
+use on the system. See the fontconfig documentation for details how to do
+that; usually it's a matter of copying the font files somewhere and running
+fc-cache(1) (as root or the VDR user).
In the skin file the font is defined with
font="Osd"
-or with True-Type fonts with the desired size and width (optional)
+or with True Type fonts
- font="helmetr.ttf:size[,width]"
+ font="name@size[,width]"
+
+where "name" is a string understood by VDR's CreateFont() method
+(Family:Style where Style is optional as of writing this), size is the font's
+size, and width its width. For example:
+
+ font="Serif@20"
+ font="Monospaced:Bold@22"
+ font="Bitstream Vera Sans:Italic@22,85"
diff --git a/Docs/Tutorial.txt b/Docs/Tutorial.txt
index b173824..da87ad2 100644
--- a/Docs/Tutorial.txt
+++ b/Docs/Tutorial.txt
@@ -117,7 +117,7 @@ Scroll- and progress-bars also need "bgColor", progress-bars "current" and "tota
<rectangle x1="20" x2="99" y1="-83" y2="-44" color="#00000000"/>
<text x1="42" x2="571" y1="-113" y2="-86" color="#FF000000" font="Osd">{ReplayTitle}</text>
<progress x1="124" x2="577" y1="-70" y2="-55" color="#FF84ff00" bgColor="#FFFFFFFF" current="{ReplayPositionIndex}" total="{ReplayDurationIndex}"/>
- <scrolltext x1="24" y1="138" y2="-72" x2="583" font="helmetr.ttf:20" color="#AFFFFF00">
+ <scrolltext x1="24" y1="138" y2="-72" x2="583" font="Sans Serif@20" color="#AFFFFF00">
{PresentShortText}
{PresentDescription}
</scrolltext>
@@ -269,15 +269,16 @@ There are three predefined fonts
* Fix
* Sml
-If the freetype library is installed it is possible to use every True-Type font in the directories
- /etc/vdr/plugins/text2skin/fonts/
-or
- /etc/vdr/plugins/text2skin/SkinName/
+It is possible to use True Type fonts installed and configured for fontconfig's
+use on the system. See the fontconfig documentation for details how to do
+that; usually it's a matter of copying the font files somewhere and running
+fc-cache(1) (as root or the VDR user).
In the skin file the font is defined with
font="Osd"
-or with True-Type fonts with the desired size and if desirable width
+or with True Type fonts with the desired size and if desirable width
- font="helmetr.ttf:size[,width]"
+ font="Sans Serif@size[,width]"
+ font="Monospaced:Bold@size[,width]"