From: Julian Smart <julian@anthemion.co.uk>
Date: Thu, 31 Dec 1998 18:18:56 +0000 (+0000)
Subject: Rationalised a few more docs
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/2dc5505ebcf8412d425028e91297f061e685368f

Rationalised a few more docs


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@1294 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---

diff --git a/docs/bugs.txt b/docs/bugs.txt
new file mode 100644
index 0000000000..e64dc10130
--- /dev/null
+++ b/docs/bugs.txt
@@ -0,0 +1,15 @@
+wxWindows Buglist
+-----------------
+
+wxGTK:
+------
+
+wxMSW:
+------
+
+wxMotif:
+--------
+
+General:
+--------
+
diff --git a/docs/html/index.htm b/docs/html/index.htm
index 5ba390c826..b913d9a099 100644
--- a/docs/html/index.htm
+++ b/docs/html/index.htm
@@ -31,20 +31,22 @@ from the <a href="http://wxwin.home.ml.org">wxWindows Web site</a>.<P>
 <h3>Installation and release notes</h3>
 
 <ul>
-<li>Licence: <a href="../preamble.txt">Preamble</a>,
-<a href="../licence.txt">Licence</a>,
-<a href="../licendoc.txt">Documentation Licence</a>,
-<a href="../lgpl.txt">L-GPL</a>,
-<a href="../gpl.txt">GPL</a>
-<li>ReadMe: <a href="../gtk/readme.txt">wxGTK</a>,
+<li>ReadMe: <a href="../readme.txt"><b>General ReadMe</b></a>,
+<a href="../gtk/readme.txt">wxGTK</a>,
 <a href="../motif/readme.txt">wxMotif</a>,
 <a href="../msw/readme.txt">wxMSW</a>
 <li>Installation: <a href="../gtk/install.txt">wxGTK</a>,
 <a href="../motif/install.txt">wxMotif</a>,
 <a href="../msw/install.txt">wxMSW</a>
-<li>Change logs: <a href="../motif/changes.txt">wxMotif</a>,
-<a href="../msw/changes.txt">wxMSW</a>
-<li>ToDo: <a href="../gtk/todo.txt">wxGTK</a>,
+<li><a href="../changes.txt"><b>Change log</b></a>
+<li><a href="../bugs.txt"><b>Buglist</b></a>
+<li>Licence: <a href="../preamble.txt">Preamble</a>,
+<a href="../licence.txt">Licence</a>,
+<a href="../licendoc.txt">Documentation Licence</a>,
+<a href="../lgpl.txt">L-GPL</a>,
+<a href="../gpl.txt">GPL</a>
+<li>ToDo: <a href="../todo.txt"><b>General ToDo</b></a>,
+<a href="../gtk/todo.txt">wxGTK</a>,
 <a href="../motif/todo.txt">wxMotif</a>,
 <a href="../msw/todo.txt">wxMSW</a>
 <li>List of <a href="../symbols.txt">preprocessor symbols</a> used in wxWindows
diff --git a/docs/motif/readme.txt b/docs/motif/readme.txt
new file mode 100644
index 0000000000..a56f9e93a4
--- /dev/null
+++ b/docs/motif/readme.txt
@@ -0,0 +1,7 @@
+wxMotif ReadMe
+--------------
+
+This file is currently under construction.
+
+For further details of the Motif port, please see changes.txt and
+todo.txt.
diff --git a/docs/readme.txt b/docs/readme.txt
index 2e6d4bad35..662d04dc24 100644
--- a/docs/readme.txt
+++ b/docs/readme.txt
@@ -2,7 +2,18 @@ wxWindows 2.0
 -------------
 
 Welcome to wxWindows 2.0, a sophisticated cross-platform C++
-framework for writing GUI applications.
+framework for writing advanced GUI applications using (where
+possible) the native controls.
+
+In addition to common and advanced GUI facilities such as frames, scrolling
+windows, toolbars, tree controls, icons, device contexts,
+printing, splitter windows and so on, there are wrappers for common
+file operations and facilities for writing TCP/IP applications.
+Where certain features are not available on a platform, such as MDI and
+tree controls on Unix, they are emulated.
+
+A detailed 700-page reference manual is supplied in HTML, PDF and
+Windows Help form.
 
 Platforms supported
 -------------------
@@ -44,7 +55,7 @@ in the individual directories:
   docs/gtk
   docs/motif
 
-License information
+Licence information
 -------------------
 
 For licensing information, please see the files:
@@ -55,4 +66,48 @@ For licensing information, please see the files:
   docs/gpl.txt
   docs/lgpl.txt
 
+Although this may seem complex, it is there to allow authors of
+proprietary/commercial applications to use wxWindows in
+addition to those writing GPL'ed applications. In summary,
+the licence is L-GPL plus a clause allowing unrestricted
+distribution of application binaries. To answer a FAQ, you
+don't have to distribute any source if you wish to write
+commercial applications using wxWindows.
+
+Documentation
+-------------
+
+See docs/changes.txt for a history of changes to wxWindows 2.0.
+See docs/html/index.htm for an HTML index of the major documents.
+
+The Windows help files are located in docs/winhelp.
+The PDF help files are located in docs/pdf.
+
+Further information
+-------------------
+
+The wxWindows Web site is located at:
+
+  http://wxwin.home.ml.org
+
+The wxGTK Web site (with further wxGTK-specific fiels and
+information) is located at:
+
+  http://www.freiburg.linux.de/~wxxt
+
+The main wxWindows ftp site is at:
+
+  ftp://www.remstar.com/pub/wxwin
+
+A wxWindows CD-ROM with the latest distribution plus an HTML
+front-end and hundreds of MB of compilers, utilities and other
+material may be ordered from the CD-ROM page:
+
+  http://wxwin.home.ml.org/cdrom
+
+or contact Julian Smart <julian.smart@ukonline.co.uk>.
+
+Good luck!
+
+The wxWindows Team, January 1999
 
diff --git a/docs/todo.txt b/docs/todo.txt
new file mode 100644
index 0000000000..fce7963424
--- /dev/null
+++ b/docs/todo.txt
@@ -0,0 +1,11 @@
+General ToDo
+------------
+
+- Write this ToDo list :-)
+
+Please see also:
+
+  docs/gtk/todo.txt
+  docs/motif/todo.txt
+  docs/msw/todo.txt
+
diff --git a/utils/dialoged/docs/dialoged.tex b/utils/dialoged/docs/dialoged.tex
index 795717a2ee..441b3d238c 100644
--- a/utils/dialoged/docs/dialoged.tex
+++ b/utils/dialoged/docs/dialoged.tex
@@ -1,12 +1,11 @@
 \documentstyle[a4,makeidx,verbatim,texhelp,fancyhea,mysober,mytitle]{report}
-\latexonly{\newcommand{\icon}[2]{\image{1cm;0cm}{#1}}}
 \input psbox.tex
 % Remove this for processing with dvi2ps instead of dvips
 %\special{!/@scaleunit 1 def}
 \parskip=10pt
 \parindent=0pt
-\title{User Manual for wxWindows Dialog Editor Version 2.0}
-\winhelponly{\author{by Julian Smart, Anthemion Software}
+\title{User Manual for Dialog Editor Version 2.0}
+\winhelpignore{\author{Julian Smart, Anthemion Software}
 \date{December 1998}
 }
 \makeindex
@@ -24,10 +23,10 @@
 \setfooter{\thepage}{}{}{}{}{\thepage}%
 
 \begin{center}
-Copyright (c) 1998 Julian Smart et al
+Copyright (c) 1998 Julian Smart, Anthemion Software
 \end{center}
 
-Please see the wxWindows licence for licensing details.
+Please see the wxWindows licence for conditions of use.
 
 \input{body.tex}
 \input{changes.tex}
@@ -36,8 +35,14 @@ Please see the wxWindows licence for licensing details.
 
 %\newpage
 %
-\addcontentsline{toc}{chapter}{Index}%
-\printindex%
+% Note: In RTF, the \printindex must come before the
+% change of header/footer, since the \printindex inserts
+% the RTF \sect command which divides one chapter from
+% the next.
+\rtfonly{\printindex
+\addcontentsline{toc}{chapter}{Index}
 \setheader{{\it INDEX}}{}{}{}{}{{\it INDEX}}%
 \setfooter{\thepage}{}{}{}{}{\thepage}%
+}
 \end{document}
+
diff --git a/utils/dialoged/docs/tex2rtf.ini b/utils/dialoged/docs/tex2rtf.ini
index 89ea473d0c..8d897c9c63 100644
--- a/utils/dialoged/docs/tex2rtf.ini
+++ b/utils/dialoged/docs/tex2rtf.ini
@@ -1,4 +1,3 @@
-;    Last change:  JS   24 Dec 98    7:55 pm
 runTwice = yes
 titleFontSize = 12
 authorFontSize = 10
@@ -8,6 +7,7 @@ subsectionFontSize = 12
 headerRule = yes
 footerRule = yes
 useHeadingStyles = yes
+contentsDepth = 2
 listItemIndent=40
 generateHPJ = no
 htmlBrowseButtons = bitmap