graphicstools/bitmapfonttools/group/README.TXT
changeset 0 5d03bc08d59c
equal deleted inserted replaced
-1:000000000000 0:5d03bc08d59c
       
     1 //
       
     2 // Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
       
     3 // All rights reserved.
       
     4 // This component and the accompanying materials are made available
       
     5 // under the terms of "Eclipse Public License v1.0"
       
     6 // which accompanies this distribution, and is available
       
     7 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 //
       
     9 // Initial Contributors:
       
    10 // Nokia Corporation - initial contribution.
       
    11 //
       
    12 // Contributors:
       
    13 //
       
    14 // Description: 
       
    15 
       
    16 
       
    17 DOCUMENTATION FOR FNTTRAN.EXE
       
    18 =======================
       
    19 
       
    20 (This has been updated as of 041)
       
    21 
       
    22 Summary
       
    23 ======
       
    24 FNTTRAN takes multiple arguments; a series of input ASCII files each containing a bitmap font in BDF format, 
       
    25 followed by a .GD file that details how the bitmap fonts are collected into typefaces. This creates the font store 
       
    26 file (with extension GDR) that will be put into the \SYSTEM\FONTS directory on 
       
    27 a machine running EPOC32.
       
    28 
       
    29 For example: FNTTRAN FONT1.BDF FONT2.BDF FONT3.BDF EON14.GD
       
    30 will produce EON14.GDR
       
    31 
       
    32 Version 041 introduced font metric font compression.
       
    33 
       
    34 Details
       
    35 ====
       
    36 In general, a font collection will be made up of many individual font bitmaps, each 
       
    37 described in a separate file. The .GD file adds information about the typefaces
       
    38 and the final font-store file::
       
    39 
       
    40 ---------------------------------------------------------------------
       
    41 
       
    42 Typeface Rom 
       
    43    Name "Roman" Proportional // The name of the typeface that the user will see
       
    44    FontBitmaps
       
    45       rom11 // These names must match font bitmap names in the BDF/GDF files
       
    46       rom14
       
    47    EndFontBitmaps
       
    48 EndTypeface
       
    49 
       
    50 FontStoreFile
       
    51    CollectionUid 99999999
       
    52    CopyrightInfo
       
    53         "Copyright xxx"
       
    54    EndCopyrightInfo
       
    55    Typefaces
       
    56       Rom
       
    57    EndTypefaces
       
    58 EndFontStoreFile
       
    59 ----------------------------------------------------------------------
       
    60 
       
    61 In the above example, only one typeface is included, but this can be extended to 
       
    62 multiple typefaces, each with a variety of heights and bold/italic characteristics 
       
    63 (defined in the individual BDF files). The final font-store file collects up the 
       
    64 individual typefaces, adds a collection uid and copyright information.
       
    65 
       
    66 BDF Format
       
    67 =======
       
    68 This is as BDF V2.2 but without the support for multiple writing directions as this is 
       
    69 not supported by EPOC32. The characters must be listed in order of Unicode encoding.
       
    70 The name of the font (following FONT) is the label used to indentify the individual 
       
    71 font bitmap when the typefaces are constructed. 
       
    72 Some additional keyword should be supplied in the PROPERTIES section of the BDF 
       
    73 file however.
       
    74 
       
    75 STARTPROPERTIES 3
       
    76 UID 999999      // A uid enabling the font bitmap to be requested 
       
    77 MAXNORMALCHARWIDTH 12 // The maximum normal width of characters in pixels.
       
    78 MAXCONSECUTIVEFILLCHARS 0
       
    79 FONTASCENT 9
       
    80 FONTDESCENT 2
       
    81 ENDPROPERTIES
       
    82 
       
    83 The MAXCONSECUTIVEFILLCHARS is optional and controls whether 
       
    84 breaks are made between code sections when there are missing characters in the 
       
    85 input BDF file.
       
    86 
       
    87 The FONTASCENT and FONTDESCENT keywords are optional (but, if present, BOTH must be present). If present they are used to calculate the font height. If not present it is done using the height of the font bounding box (as it was up until v039). Since the ascent and descent of the font are less likely to vary between stylistic variants of a single typeface at a single size, it is less likely to produce duplicate entries with apparently the same size in the font lists (the variants actually are different fractional values that round to the same integer for display).
       
    88 
       
    89 The order of any of these keywords within the properties section is irrelevant.
       
    90 
       
    91 The prescence of other keywords in the properties section is ignored. However, we recommend that you leave them there rather than edit them oout of the file. These keywords are automatically generated by various font foundries with additional font information and the exact set and the exact names vary from one font supplier to another but the values in them may be useful if future developments require us to take account of additional font information (if we are lucky it will be contained in these additional keywords). Any keywords in the properties section that we are not explicitly looking for will be ignored and they will not increase the size of the font files made by FNTTRAN.
       
    92 
       
    93 GDF Format
       
    94 =======
       
    95 This format is deprecated
       
    96 GDF files are files produced by FONTCOMP from FSC or EFF format.