misc/README

   1 //
   2 // $Id: README 8008 2010-12-11 14:39:07Z AlbrechtS $
   3 //
   4 // Miscellaneous files for developers:
   5 //
   6
   7 Developer files for testing UTF-8 character sets and functions:
   8 ================================================================================
   9
  10 Open these files in test/editor and compare the contents.
  11
  12 Test scrolling, move the cursor over the "special" characters (> U+007F),
  13 watch cursor movement, drawing artefacts, etc..
  14
  15 CAUTION: Do not 'cat' these files unless you know what you're doing.
  16 Especially the cp1252* files can contain control characters that may freeze
  17 your screen (xterm etc.).
  18
  19 Detailed file description:
  20
  21 The "native" encoded files contain 8-bit characters with binary values that
  22 can be seen at the top and left borders, resp. (add both). They should look
  23 like the image file (cp1252.png) on Windows only (if the current codepage is
  24 "Western, CP 1252", a superset of ISO-8859-1). They will look different with
  25 other codepages or on Linux, Unix, or Mac OS X. Use these files with FLTK 1.1
  26 or an editor with the corresponding codepage or locale.
  27
  28 The UTF-8 encoded files should be usable with FLTK 1.3, FLTK 2, or FLTK 3
  29 (future). They contain UTF-8 encoded characters at the table positions,
  30 where the corresponding ISO-8859-1, Windows copepage 1252, or Mac OS Roman
  31 characters would be. They should look identical as the image file (cp1252.png)
  32 or MacRoman_utf-8.png, resp., on all UTF-8 capable systems.
  33
  34 The files with names iso-8859-1_* contain only the ISO-8859-1 subset, i.e.
  35 the colums with character codes 0x80 - 0x9F (U+0080 - U+009F) are empty.
  36
  37 Mac OS Roman is the Apple Mac native character set before it became Unicode
  38 by default (OS X). The corresponding files are ordered as they would appear
  39 with the native character set / encoding.
  40
  41 The *.html files contain a character encoding meta tag, so that they should
  42 be viewable with all standard browsers. They can be used for cut'n'paste and
  43 drag'n'drop tests from a 'native' application (browser) to FLTK, e.g.
  44 test/editor or test/input.
  45
  46 Special Notes:
  47
  48   0x22 (U+0022: "quotation mark") is doubled intentionally. This has been
  49   done for better results in test/editor, because otherwise the rest of the
  50   file would be shown in blue color (as a comment).
  51
  52   0x98 (U+02DC: "small tilde") may not display correctly on Windows systems.
  53   I saw the same effect with other Windows editors as well. The following
  54   characters may be displayed "shifted left" by one position. Seems to work
  55   correctly on Linux (with UTF-8 encoding).
  56
  57   Mac OS Roman: 0xF0 (U+F8FF: "Apple logo") may not be printable, depending
  58   on installed fonts on other systems.
  59
  60   There may currently be drawing artefacts when moving the cursor forwards
  61   and/or backwards over some "special" characters.
  62
  63 References:
  64
  65   http://unicode.org/Public/MAPPINGS/ISO8859/8859-1.TXT
  66   http://unicode.org/Public/MAPPINGS/VENDORS/MICSFT/WINDOWS/CP1252.TXT
  67   http://unicode.org/Public/MAPPINGS/VENDORS/APPLE/ROMAN.TXT
  68   http://en.wikipedia.org/wiki/Mac_OS_Roman
  69
  70 Files:
  71
  72 The first two files are images of how it should look:
  73
  74   cp1252.png            full Windows Codepage 1252 (Western)
  75   MacRoman_utf-8.png    full Mac OS Roman character set (w/o Apple logo)
  76
  77 The following four files contain the full Windows Codepage 1252:
  78
  79   cp1252.txt            native (Windows) encoding, suitable for FLTK 1.1
  80   cp1252_utf-8.txt      UTF-8 encoding, suitable for FLTK 1.3 and greater
  81   cp1252.html           native (Windows) encoding, use with any browser
  82   cp1252_utf-8.html     UTF-8 encoding, use with any browser
  83
  84 The following two files contain only the ISO-8859-1 subset:
  85
  86   iso-8859-1.txt        native (Windows) encoding, suitable for FLTK 1.1
  87   iso-8859-1_utf-8.txt  UTF-8 encoding, suitable for FLTK 1.3 and greater
  88
  89 The following file contains the full Mac OS Roman character set:
  90
  91   MacRoman_utf-8.txt    UTF-8 encoding, suitable for FLTK 1.3 and greater
  92                         (use cp1252.txt with FLTK 1.1 on Mac OS instead)
  93
  94 Other developer support files:
  95 ================================================================================
  96
  97   doxystar.cxx          Use this to reformat doxygen comments (test only).
  98
  99         Compile with:   g++ -o doxystar doxystar.cxx
 100
 101         Usage:          cat file | doxystar
 102
 103   DO NOT USE this for current code development!
 104
 105   It is intended for testing of future code reformatting !
 106
 107 //
 108 // End of $Id: README 8008 2010-12-11 14:39:07Z AlbrechtS $.
 109 //