documented wxLogChain and wxLogPassThrough classes and wxLog::DoLog/DoLogString methods

[wxWidgets.git] / docs / latex / wx / tnoneng.tex

diff --git a/docs/latex/wx/tnoneng.tex b/docs/latex/wx/tnoneng.tex
index 1ea38c589a4b8ea762f27e7b832993c709214fa7..d1c5d65249537959244fc2e36166ff7ee25b11c4 100644 (file)
--- a/docs/latex/wx/tnoneng.tex
+++ b/docs/latex/wx/tnoneng.tex
@@ -5,49 +5,143 @@ user in language other than English. Unfortunately many languages use
 different charsets under Unix and Windows (and other platforms, to make
 situation even more complicated). These charsets usually differ in so
 many characters it is impossible to use same texts under all platforms.
 different charsets under Unix and Windows (and other platforms, to make
 situation even more complicated). These charsets usually differ in so
 many characters it is impossible to use same texts under all platforms.

-wxWindows provide mechanism that helps you avoid distributing many
+
+wxWindows library provides mechanism that helps you avoid distributing many

 identical, only differently encoded, packages with your application 
 (e.g. help files and menu items in iso8859-13 and windows-1257). Thanks
 identical, only differently encoded, packages with your application 
 (e.g. help files and menu items in iso8859-13 and windows-1257). Thanks

-to this mechanism you can distribute only let's say iso8859-13 data 
+to this mechanism you can, for example, distribute only iso8859-13 data 

 and it will be handled transparently under all systems.
 
 and it will be handled transparently under all systems.
 

-Please read \helpref{Internationalization}\label{internationalization} which
-describes locales concept.
+Please read \helpref{Internationalization}{internationalization} which
+describes the locales concept.

 
 

-Whereever in the following text {\it iso8859-2} and {\it windows-1250} are
+In the following text, wherever {\it iso8859-2} and {\it windows-1250} are

 used, any encodings are meant and any encodings may be substituted there.
 
 used, any encodings are meant and any encodings may be substituted there.
 

-

 \wxheading{Locales}
 
 \wxheading{Locales}
 

-TODO
+The best way to ensure correctly displayed texts in a GUI across platforms
+is to use locales. Write your in-code messages in English or without 
+diacritics and put real messages into the message catalog (see 
+\helpref{Internationalization}{internationalization}).

 
 

-\wxheading{Converting data}
+A standard .po file begins with a header like this:
+
+\begin{verbatim}
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) YEAR Free Software Foundation, Inc.
+# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\n"
+"POT-Creation-Date: 1999-02-19 16:03+0100\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=CHARSET\n"
+"Content-Transfer-Encoding: ENCODING\n"
+\end{verbatim}
+
+Notice this particular line:
+
+\begin{verbatim}
+"Content-Type: text/plain; charset=CHARSET\n"
+\end{verbatim}
+
+It specifies the charset used by the catalog. All strings in the catalog
+are encoded using this charset.
+
+You have to fill in proper charset information. Your .po file may look like this
+after doing so: 

 
 

-before storing / after loading
+\begin{verbatim}
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) YEAR Free Software Foundation, Inc.
+# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\n"
+"POT-Creation-Date: 1999-02-19 16:03+0100\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=iso8859-2\n"
+"Content-Transfer-Encoding: 8bit\n"
+\end{verbatim}
+
+(Make sure that the header is {\bf not} marked as {\it fuzzy}.)

 
 

-TODO
+wxWindows is able to use this catalog under any supported platform
+(although iso8859-2 is a Unix encoding and is normally not understood by
+Windows).
+
+How is this done? When you tell the wxLocale class to load a message catalog that
+contains correct header, it checks the charset. If the
+charset is "alien" on the platform the program is currently running (e.g.
+any of ISO encodings under Windows or CP12XX under Unix) it uses 
+\helpref{wxEncodingConverter::GetPlatformEquivalents}{wxencodingconvertergetplatformequivalents}
+to obtain an encoding that is more common on this platform and converts
+the message catalog to this encoding. Note that it does {\bf not} check
+for presence of fonts in the "platform" encoding! It only assumes that it is
+always better to have strings in platform native encoding than in an encoding
+that is rarely (if ever) used.
+
+The behaviour described above is disabled by default.
+You must set {\it bConvertEncoding} to TRUE in 
+\helpref{wxLocale constructor}{wxlocaledefctor} in order to enable
+runtime encoding conversion.

 
 \wxheading{Font mapping}
 
 
 \wxheading{Font mapping}
 

-TODO
+You can use \helpref{wxEncodingConverter}{wxencodingconverter} and 
+\helpref{wxFontMapper}{wxfontmapper} to display text:
+
+\begin{verbatim}
+if (!wxTheFontMapper->IsEncodingAvailable(enc, facename))
+{
+   wxFontEncoding alternative;
+   if (wxTheFontMapper->GetAltForEncoding(enc, &alternative, 
+                                          facename, FALSE))
+   {
+       wxEncodingConverted encconv;
+       if (!encconv.Init(enc, alternative))
+           ...failure...
+       else
+           text = encconv.Convert(text);
+   }
+   else
+       ...failure...
+}
+...display text...
+\end{verbatim}
+
+\wxheading{Converting data}
+
+You may want to store all program data (created documents etc.) in
+the same encoding, let's say windows1250. Obviously, the best way would
+be to use \helpref{wxEncodingConverter}{wxencodingconverter}.

 
 \wxheading{Help files}
 
 If you're using \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller} there is
 
 \wxheading{Help files}
 
 If you're using \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller} there is

-no problem at all. You must only make sure that all HTML files contain
-META tag, e.g.
+no problem at all. You must only make sure that all the HTML files contain
+the META tag, e.g.

 
 \begin{verbatim}
 
 \begin{verbatim}

-<meta http-equiv="Content-Type" content="iso8859-2">
+<meta http-equiv="Content-Type" content="text/html; charset=iso8859-2">

 \end{verbatim}
 
 \end{verbatim}
 

-and that hhp project file contains one additional line in {\tt OPTIONS}
+and that the hhp project file contains one additional line in the {\tt OPTIONS}

 section:
 
 \begin{verbatim}
 Charset=iso8859-2
 \end{verbatim}
 
 section:
 
 \begin{verbatim}
 Charset=iso8859-2
 \end{verbatim}
 

-This additional entry tells HTML help controller what encoding is used
+This additional entry tells the HTML help controller what encoding is used

 in contents and index tables.
 in contents and index tables.

+