diff options
| author | Albrecht Schlosser <albrechts.fltk@online.de> | 2008-09-19 07:23:19 +0000 |
|---|---|---|
| committer | Albrecht Schlosser <albrechts.fltk@online.de> | 2008-09-19 07:23:19 +0000 |
| commit | 29c1972a6a37354137107e307ae78c908cdb8fc2 (patch) | |
| tree | 9fb5bb654ef86b3077b2b68b1720532754554389 /documentation | |
| parent | b670807ce00c9d62f7ff8a3e36640d926612a039 (diff) | |
documentation/drawing.dox: Fixed that ¸ and ü encoding problem
by coding this in utf-8.
documentation/development.dox: added some more examples with links and
hidden comments.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6305 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'documentation')
| -rw-r--r-- | documentation/development.dox | 90 | ||||
| -rw-r--r-- | documentation/drawing.dox | 29 |
2 files changed, 113 insertions, 6 deletions
diff --git a/documentation/development.dox b/documentation/development.dox index 302827c87..280c87fdf 100644 --- a/documentation/development.dox +++ b/documentation/development.dox @@ -92,4 +92,94 @@ From Duncan: (will be removed later, just for now as a reminder) and do that for all of the function documentation?) +<H3>Example comment:</H3> + +\code +The following text is a comment within a doxygen comment block and +will not appear in the generated document: +<!-- Editor's note: + ** Caution: the following text contains utf-8 encoded characters. +--> +This will be visible again. +\endcode + +The following text is a comment within a doxygen comment block and +will not appear in the generated document: +<!-- Editor's note: + ** Caution: the following text contains utf-8 encoded characters. +--> +This will be visible again. + +\code +<H1>Headline in big text</H1> +<H2>Headline in big text</H2> +<H3>Headline in big text</H3> +<H4>Headline in big text</H4> +\endcode + +<H1>Headline in big text</H1> +<H2>Headline in big text</H2> +<H3>Headline in big text</H3> +<H4>Headline in big text</H4> + + +<P>Assuming that the following source code was written on MS Windows, +this example will output the correct label on OS X and X11 as well. +Without the conversion call, the label on OS X would read +<tt>Fahrvergn¸gen</tt> with a deformed umlaut u ("cedille", +html "¸"). +\code + btn = new Fl_Button(10, 10, 300, 25); + btn->copy_label(fl_latin1_to_local("Fahrvergnügen")); +\endcode + +\note If your application uses characters that are not part of both + encodings, or it will be used in areas that commonly use different + code pages, you might consider upgrading to FLTK 2 which supports + UTF-8 encoding. + +\todo This is an example todo entry, please ignore ! + +\code + +<!-- Editor's note: + ** Caution: the following text contains utf-8 encoded characters. + ** be careful when using non-utf-8-aware editors ! +--> + +<P>Assuming that the following source code was written on MS Windows, +this example will output the correct label on OS X and X11 as well. +Without the conversion call, the label on OS X would read +<tt>Fahrvergn¸gen</tt> with a deformed umlaut u ("cedille", +html "¸"). +\code + btn = new Fl_Button(10, 10, 300, 25); + btn->copy_label(fl_latin1_to_local("Fahrvergnügen")); +\endcode + +\note If your application uses characters that are not part of both + encodings, or it will be used in areas that commonly use different + code pages, you might consider upgrading to FLTK 2 which supports + UTF-8 encoding. + +\todo This is an example todo entry, please ignore ! + +\endcode + + +<H2>Creating Links</H2> + +\code +see chapter \ref unicode creates a link to the named chapter unicode +that has been created with a \subpage statement. + +see <a href="drawing.html#character_encoding">chapter 5</a> creates +a link to a named html anchor "character_encoding" within the same file. +\endcode +see chapter \ref unicode creates a link to the named chapter unicode +that has been created with a \subpage statement. + +see <a href="drawing.html#character_encoding">chapter 5</a> creates +a link to a named html anchor "character_encoding" within the same file. + */ diff --git a/documentation/drawing.dox b/documentation/drawing.dox index 794438d7f..209ebf492 100644 --- a/documentation/drawing.dox +++ b/documentation/drawing.dox @@ -642,19 +642,36 @@ encodings. These functions are only required if your source code contains "C"-strings with international characters and if this source will be compiled on multiple platforms. +<!-- Editor's note: + ** Caution: the following text contains utf-8 encoded characters. + ** be careful when using non-utf-8-aware editors ! +--> + <P>Assuming that the following source code was written on MS Windows, this example will output the correct label on OS X and X11 as well. Without the conversion call, the label on OS X would read -<tt>Fahrvergn\\¸gen</tt> with a deformed umlaut u. +<tt>Fahrvergn¸gen</tt> with a deformed umlaut u ("cedille", +html "¸"). \code btn = new Fl_Button(10, 10, 300, 25); - btn->copy_label(fl_latin1_to_local("Fahrvergnügen")); + btn->copy_label(fl_latin1_to_local("Fahrvergnügen")); \endcode -<P>If your application uses characters that are not part of both -encodings, or it will be used in areas that commonly use different -code pages, yoou might consider upgrading to FLTK 2 which supports -UTF-8 encoding. +\note If your application uses characters that are not part of both + encodings, or it will be used in areas that commonly use different + code pages, you might consider upgrading to FLTK 2 which supports + UTF-8 encoding. + +\todo drawing.dox: I fixed the above encoding problem of these \¸ + and umlaut characters, but this text is obsoleted by FLTK 1.3 + with utf-8 encoding, or must be rewritten accordingly: + How to use native (e.g. Windows "ANSI", or ISO-8859-x) + encoding in embedded strings for labels, error messages + and more. Please check this (utf-8) encoding on different + OS'es and with different language and font environments. + +For more information about character encoding, unicode and utf-8 +see chapter \ref unicode. <H3><A name="overlay">Drawing Overlays</A></H3> |
