ESCAPES.txt for Tux Paint

Tux Paint - A simple drawing program for children.

Copyright 2003 by Bill Kendrick
bill@newbreedsoftware.com
http://www.newbreedsoftware.com/tuxpaint/

February 1, 2003 - February 1, 2003


About Escape Sequences
----------------------
  Tux Paint allows the use of HTML escape sequences in the description files
  (".txt" files) it reads when loading Rubber Stamp images.
  (See README.txt for more information on creating your own rubber stamps.)
  
  The escape sequences provide a way of entering hard-to-type ASCII
  characters into the text file.  The escape sequences Tux Paint supports
  are identical to those used in HTML pages on the web.

  A sequence begins with the "&" character (ampersand), and ends with
  the ";" character (semicolon).  For example: "&iuml;".


Using Escape Sequences in Tux Paint
-----------------------------------
  To use a string containing escape sequences in a rubber stamp description
  file (the ".txt" file that corresponds to the stamps ".png" image file),
  the line containing the translated description should begin with the
  language's "locale code", followed by ".esc=" and the description text.

  For example, a Spanish translation of a string in plain ASCII might look
  like this:

    es=Hola

  A Spanish translation that takes advantage of the HTML-style escape
  sequences might look like this:

    es.esc=&iexcl;Hola ni&ntilde;os!
  

  In both cases, the "es" at the beginning of the line corresponds to the
  language of the description: Spanish.
  (See README.txt for a list of languages supported by Tux Paint, and their
  locale codes.)

  In the latter example, the "&iexcl;" is an 'escape sequence' that
  represents an inverted (upside-down) exclamation point ("!"), which
  looks like this:  "¡"

  The "&ntilde;" represents an "n" with a tilde ("~") over it.
  The Spanish character:  "ñ"


  This example could have been easily done using plain ASCII, like so:

    es=¡Hola niños!

  However, depending on the text editor being used, typing that literally
  may not be an easy task.  Typing the letters A-Z and punctuation should
  never be a problem, though.  This is why escape sequence support was
  added to Tux Paint.


  NOTE: Since the ampersand character ("&") is used to denote the beginning
  of an escape sequence, it itself must be escaped.  Use the sequence "&amp;"

  For example, in plain ASCII:

    xx=This & that

  Should be written as follows when using the escape sequence mode:

    xx.esc=This &amp; that


  The following is INCORRECT, and will end up truncated to just the word "This":

    xx.esc=This & that



Supported Escape Sequences
--------------------------
  Sequence   Character   Description
  --------   ---------   -----------
  &agrave;       à       Lowercase a grave
  &aacute;       á       Lowercase a acute
  &acirc;        â       Lowercase a circumflex
  &atilde;       ã       Lowercase a tilde
  &auml;         ä       Lowercase a umlaut
  &aring;        å       Lowercase a ring

  &Agrave;       À       Uppercase A grave
  &Aacute;       Á       Uppercase A acute
  &Acirc;        Â       Uppercase A circumflex
  &Atilde;       Ã       Uppercase A tilde
  &Auml;         Ä       Uppercase A umlaut
  &Aring;        Å       Uppercase A ring

  &aelig;        æ       Lowercase ae ligature
  &AElig;        Æ       Uppercase AE ligature

  &ccedil;       ç       Lowercase c cedil
  &Ccedil;       Ç       Uppercase C cedil

  &eth;          ð       Lowercase eth
  &ETH;          Ð       Uppercase Eth

  &egrave;       è       Lowercase e grave
  &eacute;       é       Lowercase e acute
  &ecirc;        ê       Lowercase e circumflex
  &euml;         ë       Lowercase e umlaut

  &Egrave;       È       Uppercase E grave
  &Eacute;       É       Uppercase E acute
  &Ecirc;        Ê       Uppercase E circumflex
  &Euml;         Ë       Uppercase E umlaut

  &igrave;       ì       Lowercase i grave
  &iacute;       í       Lowercase i acute
  &icirc;        î       Lowercase i circumflex
  &iuml;         ï       Lowercase i umlaut

  &Igrave;       Ì       Uppercase I grave
  &Iacute;       Í       Uppercase I acute
  &Icirc;        Î       Uppercase I circumflex
  &Iuml;         Ï       Uppercase I umlaut

  &ograve;       ò       Lowercase o grave
  &oacute;       ó       Lowercase o acute
  &ocirc;        ô       Lowercase o circumflex
  &otilde;       õ       Lowercase o tilde
  &ouml;         ö       Lowercase o umlaut
  &oslash;       ø       Lowercase o slash

  &Ograve;       Ò       Uppercase O grave
  &Oacute;       Ó       Uppercase O acute
  &Ocirc;        Ô       Uppercase O circumflex
  &Otilde;       Õ       Uppercase O tilde
  &Ouml;         Ö       Uppercase O umlaut
  &Oslash;       Ø       Uppercase O slash

  &ugrave;       ù       Lowercase u grave
  &uacute;       ú       Lowercase u acute
  &ucirc;        û       Lowercase u circumflex
  &uuml;         ü       Lowercase u umlaut

  &Ugrave;       Ù       Uppercase U grave
  &Uacute;       Ú       Uppercase U acute
  &Ucirc;        Û       Uppercase U circumflex
  &Uuml;         Ü       Uppercase U umlaut

  &ntilde;       ñ       Lowercase n tilde
  &Ntilde;       Ñ       Uppercase N tilde

  &szlig;        ß       Sharp S

  &yacute;       ý       Lowercase y acute
  &yuml;         ÿ       Lowercase y umlaut
  &Yacute;       Ý       Uppercase Y acute

  &thorn;        þ       Lowercase thorn
  &THORN;        Þ       Uppercase thorn

  &iexcl;        ¡       Inverted exclamation
  &iquest;       ¿       Inverte question mark
  &laquo;        «       Left angle quotes
  &raquo;        »       Right angle quotes

  &cent;         ¢       Cent sign
  &pound;        £       Pound sign
  &curren;       ¤       Currency sign
  &yen;          ¥       Yen sign

  &acute;        ´       Acute
  &cedil;        ¸       Cedil
  &uml;          ¨       Umlaut

  &quot;         "       Quote
  &amp;          &       Ampersand
  &lt;           <       Less than
  &gt;           >       Greater than

  &plusmn;       ±       Plus-minus sign
  &times;        ×       Times sign
  &divide;       ÷       Division sign
  &not;          ¬       Logical not sign
  &deg;          °       Degree sign
  &micro;        µ       Micro sign

  &frac14;       ¼       One quarter (1/4)
  &frac12;       ½       One half (1/2)
  &frac34;       ¾       Three quarters (3/4)

  &sup1;         ¹       Superscript 1
  &sup2;         ²       Superscript 2
  &sup3;         ³       Superscript 3

  &brvbar;       ¦       Broken vertical bar
  &sect;         §       Section sign
  &para;         ¶       Paragraph sign
  &middot;       *       Middle dot

  &copy;         ©       Copyright sign ((C))
  &reg;          ®       Registered trademark sign ((R))

  &ordf;         ª       Feminine ordinal
  &ordm;         º       Masculine ordinal
  &shy;          ­       Soft hyphen
  &macr;         ¯       Spacing macron

