]> git.wh0rd.org Git - fontconfig.git/commitdiff
Documentation fixes
authorBrad Hards <bradh@frogmouth.net>
Fri, 11 Mar 2011 22:43:42 +0000 (19:43 -0300)
committerBehdad Esfahbod <behdad@behdad.org>
Fri, 11 Mar 2011 22:43:42 +0000 (19:43 -0300)
doc/fcatomic.fncs
doc/fccharset.fncs
doc/fcfontset.fncs
doc/fcformat.fncs
doc/fcfreetype.fncs
doc/fcinit.fncs
doc/fclangset.fncs
doc/fcpattern.fncs
doc/fcstring.fncs
doc/fontconfig-devel.sgml
doc/fontconfig-user.sgml

index 1653009a8ae5cb855d267e2098780a70e8f089d4..017756af1b6de9092094f922433d6e618a62348a 100644 (file)
@@ -57,7 +57,7 @@ by <parameter>atomic</parameter>.
 @TYPE1@         FcAtomic *                      @ARG1@          atomic
 @PURPOSE@      return original file name
 @DESC@
-Returns the file refernced by <parameter>atomic</parameter>.
+Returns the file referenced by <parameter>atomic</parameter>.
 @@
 
 @RET@           FcBool
index 36ac9d67a238c61a613e9c868208cf7b465401d6..036870d3b3630469217d20d7df7e2388cbd72c2c 100644 (file)
@@ -46,7 +46,7 @@ memory referenced is freed.
 @TYPE2@                FcChar32%               @ARG2@          ucs4 
 @PURPOSE@      Add a character to a charset
 @DESC@
-<function>FcCharSetAddChar</function> adds a single unicode char to the set,
+<function>FcCharSetAddChar</function> adds a single Unicode char to the set,
 returning FcFalse on failure, either as a result of a constant set or from
 running out of memory. 
 @@
@@ -57,7 +57,7 @@ running out of memory.
 @TYPE2@                FcChar32%               @ARG2@          ucs4 
 @PURPOSE@      Add a character to a charset
 @DESC@
-<function>FcCharSetDelChar</function> deletes a single unicode char from the set,
+<function>FcCharSetDelChar</function> deletes a single Unicode char from the set,
 returning FcFalse on failure, either as a result of a constant set or from
 running out of memory.
 @@
@@ -78,7 +78,7 @@ than increment the reference count on <parameter>src</parameter>.
 @PURPOSE@      Compare two charsets
 @DESC@
 Returns whether <parameter>a</parameter> and <parameter>b</parameter>
-contain the same set of unicode chars.
+contain the same set of Unicode chars.
 @@
 
 @RET@          FcCharSet *
@@ -138,7 +138,7 @@ Returns whether <parameter>fcs</parameter> contains the char <parameter>ucs4</pa
 @TYPE1@                const FcCharSet *       @ARG1@          a
 @PURPOSE@      Count entries in a charset
 @DESC@
-Returns the total number of unicode chars in <parameter>a</parameter>. 
+Returns the total number of Unicode chars in <parameter>a</parameter>. 
 @@
 
 @RET@          FcChar32
index f2e99d1fe620fee84bdc8ce7516ab852fb1e88f7..e076d8b92e723e1766c704336da1789d1eec7bc5 100644 (file)
@@ -125,7 +125,7 @@ modify these patterns.  Instead, they should be passed, along with
 <parameter>pattern</parameter> to
 <function>FcFontRenderPrepare</function> which combines them into a complete pattern.
     </para><para>
-The FcFontSet returned by FcFontSetSort is destroyed by caling FcFontSetDestroy.
+The FcFontSet returned by FcFontSetSort is destroyed by calling FcFontSetDestroy.
 @@
 
 @RET@          
index 6e22d527d0305faa5ddc2d50a28f037b9f8e154e..125e6b43745a34f536323205bc1b2a68ab463076 100644 (file)
@@ -36,7 +36,7 @@ caller using free(), or NULL if <parameter>format</parameter> is invalid.
 
 </para><para>
 
-The format is loosely modelled after printf-style format string.
+The format is loosely modeled after printf-style format string.
 The format string is composed of zero or more  directives: ordinary
 characters (not "%"), which are copied unchanged to the output stream;
 and tags which are interpreted to construct text from the pattern in a
@@ -164,7 +164,7 @@ a single value for those elements, starting from the first value and
 continuing as long as any of those elements has a value.
 For example, the format "%{[]family,familylang{%{family} (%{familylang})\n}}"
 will expand the pattern "%{family} (%{familylang})\n" with a pattern
-having only the first value of the family and familylang elemtns, then expands
+having only the first value of the family and familylang elements, then expands
 it with the second values, then the third, etc.
 
 </para><para>
index 207a0524e3c48169bcf0ccd1797a5cd91d9bbbb9..e4cca46a3a6998a0ec79969e132ef953673e0989 100644 (file)
@@ -45,7 +45,7 @@ higher level functions.
 @FUNC@          FcFreeTypeCharSet 
 @TYPE1@         FT_Face%                       @ARG1@          face      
 @TYPE2@         FcBlanks *                     @ARG2@          blanks
-@PURPOSE@      compute unicode coverage
+@PURPOSE@      compute Unicode coverage
 @DESC@
 Scans a FreeType face and returns the set of encoded Unicode chars.  This scans
 several encoding tables to build as complete a list as possible.  
@@ -61,7 +61,7 @@ not in 'blanks' are not placed in the returned FcCharSet.
 @TYPE1@         FT_Face%                       @ARG1@          face      
 @TYPE2@         FcBlanks *                     @ARG2@          blanks
 @TYPE3@                int *                           @ARG3@          spacing
-@PURPOSE@      compute unicode coverage and spacing type
+@PURPOSE@      compute Unicode coverage and spacing type
 @DESC@
 Scans a FreeType face and returns the set of encoded Unicode chars.
 This scans
index eb3f14b0eaacfd353925357a49f17b772ef1ab1e..2130a55ddc4873d071c5c74cea0eff6f12ee76c5 100644 (file)
@@ -76,7 +76,7 @@ Returns the version number of the library.
 @DESC@
 Forces the default configuration file to be reloaded and resets the default
 configuration. Returns FcFalse if the configuration cannot be reloaded (due
-to config file errors, allocation failures or other issues) and leaves the
+to configuration file errors, allocation failures or other issues) and leaves the
 existing configuration unchanged. Otherwise returns FcTrue.
 @@
 
index 8f9678efcb68a284586709cdd85e815d71567ce1..0a44b38c2212c0712d968a505541c4802bba26ae 100644 (file)
@@ -98,7 +98,7 @@ Returns a set including only those languages found in <parameter>ls_a</parameter
 <parameter>ls_a</parameter> and <parameter>ls_b</parameter>. If they share
 any language and territory pair, this function returns FcLangEqual. If they
 share a language but differ in which territory that language is for, this
-function returns FcLangDiffentTerritory. If they share no languages in
+function returns FcLangDifferentTerritory. If they share no languages in
 common, this function returns FcLangDifferentLang.
 @@
 
@@ -149,7 +149,7 @@ value may not be equal.
 <parameter>ls</parameter> has a matching language and territory pair,
 this function returns FcLangEqual. If <parameter>ls</parameter> has
 a matching language but differs in which territory that language is for, this
-function returns FcLangDiffentTerritory. If <parameter>ls</parameter> 
+function returns FcLangDifferentTerritory. If <parameter>ls</parameter> 
 has no matching language, this function returns FcLangDifferentLang.
 @@
 
index 77b84886b2d165c9d747d52244d227e489698fce..1df1c4f6184bfd9051b433cfb2e0f3d7e3751f42 100644 (file)
@@ -108,7 +108,7 @@ equal.
 @DESC@
 Adds a single value to the list of values associated with the property named
 `object<parameter>.  If `append</parameter> is FcTrue, the value is added at the end of any
-existing list, otherwise it is inserted at the begining.  `value' is saved
+existing list, otherwise it is inserted at the beginning.  `value' is saved
 (with FcValueSave) when inserted into the pattern so that the library
 retains no reference to any application-supplied data structure.
 @@
index 6cb75ce01de52f6d44820c16e6a85ecb6c4479dd..0412bbd1aed84cb269923731629b6d264411b4f2 100644 (file)
@@ -58,7 +58,7 @@ the char.
 Counts the number of Unicode chars in <parameter>len</parameter> bytes of
 <parameter>src</parameter>.  Places that count in
 <parameter>nchar</parameter>.  <parameter>wchar</parameter> contains 1, 2 or
-4 depending on the number of bytes needed to hold the largest unicode char
+4 depending on the number of bytes needed to hold the largest Unicode char
 counted.  The return value indicates whether <parameter>src</parameter> is a
 well-formed UTF8 string.
 @@
@@ -92,7 +92,7 @@ Counts the number of Unicode chars in <parameter>len</parameter> bytes of
 combined into 16-bit units according to <parameter>endian</parameter>.
 Places that count in <parameter>nchar</parameter>.
 <parameter>wchar</parameter> contains 1, 2 or 4 depending on the number of
-bytes needed to hold the largest unicode char counted.  The return value
+bytes needed to hold the largest Unicode char counted.  The return value
 indicates whether <parameter>string</parameter> is a well-formed UTF16
 string.
 @@
index 31303536897a74ded190d4c4b72e0157edc05d1d..87339511c85f98437891d93f5246f50c2ba62dfe 100644 (file)
@@ -96,7 +96,7 @@ which accepts font patterns and returns the nearest matching font.
   <sect2><title>FONT CONFIGURATION</title>
     <para>
 The configuration module consists of the FcConfig datatype, libexpat and
-FcConfigParse which walks over an XML tree and ammends a configuration with
+FcConfigParse which walks over an XML tree and amends a configuration with
 data found within.  From an external perspective, configuration of the
 library consists of generating a valid XML tree and feeding that to
 FcConfigParse.  The only other mechanism provided to applications for
@@ -126,83 +126,83 @@ simplify and regularize font installation and customization.
 While font patterns may contain essentially any properties, there are some
 well known properties with associated types.  Fontconfig uses some of these
 properties for font matching and font completion.  Others are provided as a
-convenience for the applications rendering mechanism.
+convenience for the application's rendering mechanism.
     </para>
     <programlisting>
                  Property Definitions
 
-    Property       CPP Symbol           Type    Description
+    Property       C Preprocessor Symbol  Type    Description
     ----------------------------------------------------
-    family         FC_FAMILY            String  Font family names
-    familylang     FC_FAMILYLANG        String  Language cooresponding to
-                                                each family name
-    style          FC_STYLE             String  Font style. Overrides weight
-                                                and slant
-    stylelang      FC_STYLELANG         String  Language cooresponding to
-                                                each style name
-    fullname       FC_FULLNAME          String  Font face full name where
-                                                different from family and
-                                                family + style
-    fullnamelang   FC_FULLNAMELANG      String  Language cooresponding to
-                                                each fullname
-    slant          FC_SLANT             Int     Italic, oblique or roman
-    weight         FC_WEIGHT            Int     Light, medium, demibold,
-                                                bold or black
-    size           FC_SIZE              Double  Point size
-    width          FC_WIDTH             Int     Condensed, normal or expanded
-    aspect         FC_ASPECT            Double  Stretches glyphs horizontally
-                                                before hinting
-    pixelsize      FC_PIXEL_SIZE        Double  Pixel size
-    spacing        FC_SPACING           Int     Proportional, dual-width,
-                                                monospace or charcell
-    foundry        FC_FOUNDRY           String  Font foundry name
-    antialias      FC_ANTIALIAS         Bool    Whether glyphs can be
-                                                antialiased
-    hinting        FC_HINTING           Bool    Whether the rasterizer should
-                                                use hinting
-    hintstyle      FC_HINT_STYLE        Int     Automatic hinting style
-    verticallayout FC_VERTICAL_LAYOUT   Bool    Use vertical layout
-    autohint       FC_AUTOHINT          Bool    Use autohinter instead of
-                                                normal hinter
-    globaladvance  FC_GLOBAL_ADVANCE    Bool    Use font global advance data
-    file           FC_FILE              String  The filename holding the font
-    index          FC_INDEX             Int     The index of the font within
-                                                the file
-    ftface         FC_FT_FACE           FT_Face Use the specified FreeType
-                                                face object
-    rasterizer     FC_RASTERIZER        String  Which rasterizer is in use
-    outline        FC_OUTLINE           Bool    Whether the glyphs are outlines
-    scalable       FC_SCALABLE          Bool    Whether glyphs can be scaled
-    scale          FC_SCALE             Double  Scale factor for point->pixel
-                                                conversions
-    dpi            FC_DPI               Double  Target dots per inch
-    rgba           FC_RGBA              Int     unknown, rgb, bgr, vrgb,
-                                                vbgr, none - subpixel geometry
-    lcdfilter      FC_LCD_FILTER        Int     Type of LCD filter
-    minspace       FC_MINSPACE          Bool    Eliminate leading from line
-                                                spacing
-    charset        FC_CHARSET           CharSet Unicode chars encoded by
-                                                the font
-    lang           FC_LANG              LangSet Set of RFC-3066-style
-                                                languages this font supports
-    fontversion    FC_FONTVERSION       Int     Version number of the font
-    capability     FC_CAPABILITY        String  List of layout capabilities in
-                                                the font
-    embolden       FC_EMBOLDEN          Bool    Rasterizer should
-                                                synthetically embolden the font
+    family         FC_FAMILY              String  Font family names
+    familylang     FC_FAMILYLANG          String  Language corresponding to
+                                                  each family name
+    style          FC_STYLE               String  Font style. Overrides weight
+                                                  and slant
+    stylelang      FC_STYLELANG           String  Language corresponding to
+                                                  each style name
+    fullname       FC_FULLNAME            String  Font face full name where
+                                                  different from family and
+                                                  family + style
+    fullnamelang   FC_FULLNAMELANG        String  Language corresponding to
+                                                  each fullname
+    slant          FC_SLANT               Int     Italic, oblique or roman
+    weight         FC_WEIGHT              Int     Light, medium, demibold,
+                                                  bold or black
+    size           FC_SIZE                Double  Point size
+    width          FC_WIDTH               Int     Condensed, normal or expanded
+    aspect         FC_ASPECT              Double  Stretches glyphs horizontally
+                                                  before hinting
+    pixelsize      FC_PIXEL_SIZE          Double  Pixel size
+    spacing        FC_SPACING             Int     Proportional, dual-width,
+                                                  monospace or charcell
+    foundry        FC_FOUNDRY             String  Font foundry name
+    antialias      FC_ANTIALIAS           Bool    Whether glyphs can be
+                                                  antialiased
+    hinting        FC_HINTING             Bool    Whether the rasterizer should
+                                                  use hinting
+    hintstyle      FC_HINT_STYLE          Int     Automatic hinting style
+    verticallayout FC_VERTICAL_LAYOUT     Bool    Use vertical layout
+    autohint       FC_AUTOHINT            Bool    Use autohinter instead of
+                                                  normal hinter
+    globaladvance  FC_GLOBAL_ADVANCE      Bool    Use font global advance data
+    file           FC_FILE                String  The filename holding the font
+    index          FC_INDEX               Int     The index of the font within
+                                                  the file
+    ftface         FC_FT_FACE             FT_Face Use the specified FreeType
+                                                  face object
+    rasterizer     FC_RASTERIZER          String  Which rasterizer is in use
+    outline        FC_OUTLINE             Bool    Whether the glyphs are outlines
+    scalable       FC_SCALABLE            Bool    Whether glyphs can be scaled
+    scale          FC_SCALE               Double  Scale factor for point->pixel
+                                                  conversions
+    dpi            FC_DPI                 Double  Target dots per inch
+    rgba           FC_RGBA                Int     unknown, rgb, bgr, vrgb,
+                                                  vbgr, none - subpixel geometry
+    lcdfilter      FC_LCD_FILTER          Int     Type of LCD filter
+    minspace       FC_MINSPACE            Bool    Eliminate leading from line
+                                                  spacing
+    charset        FC_CHARSET             CharSet Unicode chars encoded by
+                                                  the font
+    lang           FC_LANG                LangSet Set of RFC-3066-style
+                                                  languages this font supports
+    fontversion    FC_FONTVERSION         Int     Version number of the font
+    capability     FC_CAPABILITY          String  List of layout capabilities in
+                                                  the font
+    embolden       FC_EMBOLDEN            Bool    Rasterizer should
+                                                  synthetically embolden the font
     </programlisting>
   </sect2>
 </sect1>
 <sect1><title>Datatypes</title>
   <para>
-Fontconfig uses abstract datatypes to hide internal implementation details
+Fontconfig uses abstract data types to hide internal implementation details
 for most data structures.  A few structures are exposed where appropriate.
   </para>
   <sect2><title>FcChar8, FcChar16, FcChar32, FcBool</title>
     <para>
-These are primitive datatypes; the FcChar* types hold precisely the number
+These are primitive data types; the FcChar* types hold precisely the number
 of bits stated (if supported by the C implementation).  FcBool holds
-one of two CPP symbols: FcFalse or FcTrue.
+one of two C preprocessor symbols: FcFalse or FcTrue.
     </para>
   </sect2>
   <sect2><title>FcMatrix</title>
@@ -218,7 +218,7 @@ A small set of matrix operations are provided to manipulate these.
   </sect2>
   <sect2><title>FcCharSet</title>
     <para>
-An FcCharSet is an abstract type that holds the set of encoded unicode chars
+An FcCharSet is an abstract type that holds the set of encoded Unicode chars
 in a font.  Operations to build and compare these sets are provided.
     </para>
   </sect2>
@@ -378,7 +378,7 @@ public entry points that need global data can take an optional FcConfig*
 argument; passing 0 uses the default configuration.  FcConfig objects hold two
 sets of fonts, the first contains those specified by the configuration, the
 second set holds those added by the application at run-time.  Interfaces
-that need to reference a particulat set use one of the FcSetName enumerated
+that need to reference a particular set use one of the FcSetName enumerated
 values.
     </para>
   </sect2>
@@ -401,13 +401,13 @@ Used as a return type for functions manipulating FcPattern objects.
         FcResultTypeMismatch    Object exists, but the type doesn't match
         FcResultNoId            Object exists, but has fewer values
                                 than specified
-        FcResultOutOfMemory     Malloc failed
+        FcResultOutOfMemory     malloc failed
     </programlisting>
     </para>
   </sect2>
   <sect2><title>FcAtomic</title>
     <para>
-Used for locking access to config files.  Provides a safe way to update
+Used for locking access to configuration files.  Provides a safe way to update
 configuration files.
     </para>
   </sect2>
@@ -423,7 +423,7 @@ included 'fc-cache' program generally suffices for all of that.
 </sect1>
 <sect1><title>FUNCTIONS</title>
   <para>
-These are grouped by functionality, often using the main datatype being
+These are grouped by functionality, often using the main data type being
 manipulated.
   </para>
   <sect2><title>Initialization</title>
@@ -450,7 +450,7 @@ results of listing available fonts.
   <sect2><title>FcObjectSet</title>
     <para>
 An FcObjectSet holds a list of pattern property names; it is used to
-indiciate which properties are to be returned in the patterns from
+indicate which properties are to be returned in the patterns from
 FcFontList.
     </para>
     &fcobjectset;
@@ -475,7 +475,7 @@ typechecking, although that depends on careful programming.
   </sect2>
   <sect2><title>FcCharSet</title>
     <para>
-An FcCharSet is a boolean array indicating a set of unicode chars.  Those
+An FcCharSet is a boolean array indicating a set of Unicode chars.  Those
 associated with a font are marked constant and cannot be edited.
 FcCharSets may be reference counted internally to reduce memory consumption;
 this may be visible to applications as the result of FcCharSetCopy may
@@ -509,7 +509,7 @@ any function using the data within an FcConfig.
   </sect2>
   <sect2><title>FcObjectType</title>
     <para>
-Provides for applcation-specified font name object types so that new
+Provides for application-specified font name object types so that new
 pattern elements can be generated from font names.
     </para>
     &fcobjecttype;
@@ -532,9 +532,9 @@ accurate CharSet for applications.
   </sect2>
   <sect2><title>FcAtomic</title>
     <para>
-These functions provide a safe way to update config files, allowing ongoing
-reading of the old config file while locked for writing and ensuring that a
-consistent and complete version of the config file is always available.
+These functions provide a safe way to update configuration files, allowing ongoing
+reading of the old configuration file while locked for writing and ensuring that a
+consistent and complete version of the configuration file is always available.
     </para>
     &fcatomic;
   </sect2>
index b870825f21685eacc3d61a15b5273c0aec6efba9..217feb97adcde17a8e0161dd98602c8ed4d37d13 100644 (file)
@@ -216,9 +216,9 @@ Here are some examples:
                                   with artificial obliquing
     </programlisting>
     <para>
-The '\', '-', ':' and ',' characters in family names must be preceeded by a
+The '\', '-', ':' and ',' characters in family names must be preceded by a
 '\' character to avoid having them misinterpreted. Similarly, values
-containing '\', '=', '_', ':' and ',' must also have them preceeded by a
+containing '\', '=', '_', ':' and ',' must also have them preceded by a
 '\' character. The '\' characters are stripped out of the family name and
 values as the font name is read.
     </para>
@@ -659,14 +659,14 @@ This is an example of a per-user configuration file that lives in
 contains configuration information for the fontconfig library
 consisting of directories to look at for font information as well as
 instructions on editing program specified font patterns before attempting to
-match the available fonts.  It is in xml format.
+match the available fonts.  It is in XML format.
   </para>
   <para>
 <emphasis>conf.d</emphasis>
 is the conventional name for a directory of additional configuration files
 managed by external applications or the local administrator.  The
 filenames starting with decimal digits are sorted in lexicographic order
-and used as additional configuration files.  All of these files are in xml
+and used as additional configuration files.  All of these files are in XML
 format.  The master fonts.conf file references this directory in an 
 &lt;include&gt; directive.
   </para>