Check wxDateTime components validity more rigorously.

[wxWidgets.git] / docs / doxygen / overviews / html.h

diff --git a/docs/doxygen/overviews/html.h b/docs/doxygen/overviews/html.h
index 4d8485e9c60f41a395bb1808bc147bf5f9a1617b..00320585d78eb238f0d2b96dfd2faf7d44d49dda 100644 (file)
--- a/docs/doxygen/overviews/html.h
+++ b/docs/doxygen/overviews/html.h
@@ -3,7 +3,7 @@
 // Purpose:     topic overview
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     topic overview
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /**
 /////////////////////////////////////////////////////////////////////////////
 
 /**


@@ -45,7 +45,7 @@ There is a generic wxHtmlParser class, independent of wxHtmlWindow.
 
 First of all, you must include @c wx/wxhtml.h.
 
 
 First of all, you must include @c wx/wxhtml.h.
 

-Class wxHtmlWindow (derived from wxScrolledWindow) is used to display HTML documents.
+Class wxHtmlWindow (derived from ::wxScrolledWindow) is used to display HTML documents.

 
 It has two important methods: wxHtmlWindow::LoadPage and wxHtmlWindow::SetPage.
 LoadPage loads and displays HTML file while SetPage displays directly the
 
 It has two important methods: wxHtmlWindow::LoadPage and wxHtmlWindow::SetPage.
 LoadPage loads and displays HTML file while SetPage displays directly the


@@ -59,13 +59,9 @@ passed @b string. See the example:
                     "/body/hmtl");
 @endcode
 
                     "/body/hmtl");
 @endcode
 

-@subsection overview_html_quickstart_disphelp Displaying Help
-
-See wxHtmlHelpController.
-

 @subsection overview_html_quickstart_settingup Setting up wxHtmlWindow
 
 @subsection overview_html_quickstart_settingup Setting up wxHtmlWindow
 

-Because wxHtmlWindow is derived from wxScrolledWindow and not from
+Because wxHtmlWindow is derived from ::wxScrolledWindow and not from

 wxFrame, it doesn't have visible frame. But the user usually wants to see
 the title of HTML page displayed somewhere and the frame's titlebar is
 the ideal place for it.
 wxFrame, it doesn't have visible frame. But the user usually wants to see
 the title of HTML page displayed somewhere and the frame's titlebar is
 the ideal place for it.


@@ -122,17 +118,15 @@ printing into two columns.)
 
 @section overview_html_helpformats Help Files Format
 
 
 @section overview_html_helpformats Help Files Format
 

-wxHTML library uses a reduced version of MS HTML Workshop format.
-Tex2RTF can produce these files when generating HTML, if you set
-@b htmlWorkshopFiles to @true in your tex2rtf.ini file.
-(See wxHtmlHelpController for help controller description.)
+wxHTML library can be used to show an help manual to the user; in fact, it supports
+natively (through wxHtmlHelpController) a reduced version of MS HTML Workshop format.

 
 A @b book consists of three files: the header file, the contents file
 and the index file.
 
 You can make a regular zip archive of these files, plus the HTML and any
 
 A @b book consists of three files: the header file, the contents file
 and the index file.
 
 You can make a regular zip archive of these files, plus the HTML and any

-image files, for wxHTML (or helpview) to read; and the @c .zip file can
-optionally be renamed to @c .htb.
+image files, for wxHTML (or helpview) to read; and the @c ".zip" file can
+optionally be renamed to @c ".htb".

 
 @subsection overview_html_helpformats_hhp Header file (.hhp)
 
 
 @subsection overview_html_helpformats_hhp Header file (.hhp)
 


@@ -147,9 +141,9 @@ Default topic=default page to be displayed.htm
 @endcode
 
 All filenames (including the Default topic) are relative to the
 @endcode
 
 All filenames (including the Default topic) are relative to the

-location of the @c .hhp file.
+location of the @c ".hhp" file.

 
 

-@note For localization, in addition the @c .hhp file may contain the line
+@note For localization, in addition the @c ".hhp" file may contain the line

     @code
         Charset=rfc_charset
     @endcode
     @code
         Charset=rfc_charset
     @endcode


@@ -182,7 +176,7 @@ It contains exactly one list (@c <ul>....@c </ul> statement):
 
 You can modify value attributes of param tags.
 The <em>topic name</em> is name of chapter/topic as is displayed in
 
 You can modify value attributes of param tags.
 The <em>topic name</em> is name of chapter/topic as is displayed in

-contents, <em>filename.htm</em> is the HTML page name (relative to the @c .hhp file)
+contents, <em>filename.htm</em> is the HTML page name (relative to the @c ".hhp" file)

 and <em>numeric_id</em> is optional - it is used only when you use wxHtmlHelpController::Display(int).
 
 Items in the list may be nested - one @c &lt;li&gt; statement may contain a @c &lt;ul&gt; sub-statement:
 and <em>numeric_id</em> is optional - it is used only when you use wxHtmlHelpController::Display(int).
 
 Items in the list may be nested - one @c &lt;li&gt; statement may contain a @c &lt;ul&gt; sub-statement:


@@ -213,7 +207,7 @@ Items in the list may be nested - one @c &lt;li&gt; statement may contain a @c &
 
 @subsection overview_html_helpformats_hhk Index file (.hhk)
 
 
 @subsection overview_html_helpformats_hhk Index file (.hhk)
 

-Index files have same format as contents file except that ID params are ignored
+Index files have same format as contents files except that ID params are ignored

 and sublists are @b not allowed.
 
 
 and sublists are @b not allowed.
 
 


@@ -532,7 +526,7 @@ H5
 H6
 I
 IMG             SRC=[url]
 H6
 I
 IMG             SRC=[url]

-                WIDTH=[pixels]
+                WIDTH=[percent|pixels]

                 HEIGHT=[pixels]
                 ALIGN=TEXTTOP
                 ALIGN=CENTER
                 HEIGHT=[pixels]
                 ALIGN=TEXTTOP
                 ALIGN=CENTER


@@ -549,6 +543,7 @@ P               ALIGN=[alignment]
 PRE
 SAMP
 SMALL
 PRE
 SAMP
 SMALL

+SPAN

 STRIKE
 STRONG
 SUB
 STRIKE
 STRONG
 SUB


@@ -582,5 +577,12 @@ U
 UL
 @endcode
 
 UL
 @endcode
 

+@subsection overview_html_suppstyles_list List of supported styles
+
+wxHTML doesn't really have CSS support but it does support a few simple styles:
+you can use @c "text-align", @c "width", @c "vertical-align" and @c
+"background" with all elements and for @c SPAN elements the @c "color", @c
+"font-size" and @c "font-weight" are additionally recognized.
+

 */
 
 */