summaryrefslogtreecommitdiff
path: root/documentation
diff options
context:
space:
mode:
authorAlbrecht Schlosser <albrechts.fltk@online.de>2008-09-21 14:06:57 +0000
committerAlbrecht Schlosser <albrechts.fltk@online.de>2008-09-21 14:06:57 +0000
commit9ce5dd8c736f6fb9fe130256279f4541740c6817 (patch)
treed7e3132f31fb07ad1f78a59c36185ff708e37d8a /documentation
parent31ad4d23cf12d6dccd6175f4bac4dd3732c0c971 (diff)
Updated lots of links in text documentation.
Added missing file "tiny.gif" for html_footer. Updated html_footer (copyright, no date/time, no line break). git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6333 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'documentation')
-rw-r--r--documentation/common.dox6
-rw-r--r--documentation/development.dox77
-rw-r--r--documentation/drawing.dox8
-rw-r--r--documentation/events.dox15
-rw-r--r--documentation/fluid.dox6
-rw-r--r--documentation/glut.dox3
-rw-r--r--documentation/html_footer6
-rw-r--r--documentation/index.dox54
-rw-r--r--documentation/tiny.gifbin0 -> 95 bytes
9 files changed, 122 insertions, 53 deletions
diff --git a/documentation/common.dox b/documentation/common.dox
index fb30b492a..963edbbfd 100644
--- a/documentation/common.dox
+++ b/documentation/common.dox
@@ -244,7 +244,8 @@ method:</P>
button->labelcolor(FL_WHITE);
\endcode
-<H2><A NAME="boxtypes">Box Types</A></H2>
+<A NAME="boxtypes"></A> <!-- For old HTML links only ! -->
+\section common_boxtypes Box Types
<P>The type <TT>Fl_Boxtype</TT> stored and returned in Fl_Widget::box()
is an enumeration defined in Enumerations.H.
@@ -342,7 +343,8 @@ value evenly divideable by two.
<TT><A HREF="#fl_frame">fl_frame(Fl_Boxtype)</A></TT>
expects the <TT>UP_BOX</TT> design at a value divideable by four.</P>
-<H2><A NAME="labels">Labels and Label Types</A></H2>
+<A NAME="labels"></A> <!-- For old HTML links only ! -->
+\section common_labels Labels and Label Types
<P>The <TT>label()</TT>, <TT>align()</TT>, <TT>labelfont()</TT>,
<TT>labelsize()</TT>, <TT>labeltype()</TT>, <TT>image()</TT>, and
diff --git a/documentation/development.dox b/documentation/development.dox
index c6c5002f4..a8b6a7d58 100644
--- a/documentation/development.dox
+++ b/documentation/development.dox
@@ -208,10 +208,14 @@ This will appear in the document:
\li \b \\page creates a named page
\li \b \\section creates a named section within that page
- \li \b \\subsection creates a named subsection within that page
+ \li \b \\subsection creates a named subsection within the current section
+ \li \b \\subsubsection creates a named subsubsection within the current subsection
+
+All these statements take a "name" as their first argument, and a title
+as their second argument. The title can contain spaces.
The page, section, and subsection titles are formatted in blue color and
-a size like \b "<H1>", \b "<H2>", and \b "<H3>", respectively.
+a size like \b "<H1>", \b "<H2>", and \b "<H3>", and \b "<H4>", respectively.
By <b>FLTK documentation convention</b>, a file like this one with a doxygen
documentation chapter has the name <b>"<chapter>.dox".</b>
@@ -219,16 +223,14 @@ The \b \\page statement at the top of the page is
<b>"\page <chapter> This is the title"</b>.
Sections within a documentation page must be called \b "<chapter>_<section>",
where \b "<chapter>" is the name part of the file, and \b "<section>" is a
-unique section name within the page that can be referenced in links.
+unique section name within the page that can be referenced in links. The
+same for subsections and subsubsections.
These doxygen page and section commands work only in special documentation
chapters, not within normal source or header documentation blocks. However,
links \b from normal (e.g. class) documentation \b to documentation sections
\b do \b work.
-\todo Verify, that links in (from) source documentation to documentation
- pages and sections or subsections work.
-
This page has
\code
\page development I - Developer Information
@@ -287,6 +289,69 @@ appears as:
see section \ref development_non-ascii
+\section development_old-links Changing Old Links
+
+Old HTML links and anchors in text documentation pages should be changed
+as follows:
+
+\code
+<H2><A name="event_xxx">Fl::event_*() methods</A></H2>
+
+becomes:
+
+<A NAME="event_xxx"></A> <!-- For old HTML links only ! -->
+\section events_event_xxx Fl::event_*() methods
+\endcode
+
+The additional HTML "<A NAME=...>" statement is temporary needed, until
+all links (references) are modified, then:
+
+\code
+<H2><A name="event_xxx">Fl::event_*() methods</A></H2>
+
+becomes:
+
+\section events_event_xxx Fl::event_*() methods
+\endcode
+
+The "\section" statement can also be a "\subsection" or "\subsubsection"
+statement.
+
+The references (in this example from index.dox) are changes as follows:
+
+\code
+
+ \subpage events
+
+ <B>
+ <UL>
+ <LI><A HREF="events.html#event_xxx">Fl::event_*() methods</A></LI>
+ <LI><A HREF="events.html#propagation">Event Propagation</A></LI>
+ </UL>
+ </B>
+
+becomes:
+
+ \subpage events
+
+ <b>
+ \li \ref events_event_xxx
+ \li \ref events_propagation
+ </b>
+
+\endcode
+
+\section development_html_footer Hack for missing gif file
+
+ \todo
+ *HACK* : include image file for footer. Doxygen does not include
+ the file tiny.gif from "html_footer" in its output html dir.
+ Find out, how this can be done, or avoid using an image in
+ the HTML footer.
+
+ \image html tiny.gif
+
+
\section navigation_elements Example Navigation Elements
<hr>
diff --git a/documentation/drawing.dox b/documentation/drawing.dox
index 209ebf492..d793f2215 100644
--- a/documentation/drawing.dox
+++ b/documentation/drawing.dox
@@ -176,7 +176,9 @@ set to zero if the rectangle is completely outside the region.
Fl_Region is an operating system specific type. The second form returns
the current clipping region.
-<H3><A name="colors">Colors</A></H3>
+
+<A NAME="colors"></A> <!-- For old HTML links only ! -->
+\section drawing_colors Colors
<P>FLTK manages colors as 32-bit unsigned integers. Values from
0 to 255 represent colors from the FLTK 1.0.x standard colormap
@@ -695,7 +697,9 @@ fl_overlay_rect() after FL_DRAG events, and
should call fl_overlay_clear() after a
FL_RELEASE event.</P>
-<H2><A name="images">Drawing Images</A></H2>
+
+<A NAME="images"></A> <!-- For old HTML links only ! -->
+\section drawing_images Drawing Images
<P>To draw images, you can either do it directly from data in
your memory, or you can create a Fl_Image object. The advantage of
diff --git a/documentation/events.dox b/documentation/events.dox
index d2610064e..031885ddb 100644
--- a/documentation/events.dox
+++ b/documentation/events.dox
@@ -15,11 +15,10 @@ window manager.
<P>Events are identified by the integer argument passed to the
<A href="subclassing.html#handle"><TT>Fl_Widget::handle()</TT></A> virtual
method. Other information about the most recent event is stored in
-static locations and acquired by calling the <A
-href="#event_xxx"><TT>Fl::event_*()</TT></A> methods. This static
-information remains valid until the next event is read from the window
-system, so it is ok to look at it outside of the <TT>handle()</TT>
-method.
+static locations and acquired by calling the \ref events_event_xxx
+methods. This static information remains valid until the next event
+is read from the window system, so it is ok to look at it outside
+of the <TT>handle()</TT> method.
<H2>Mouse Events</H2>
@@ -271,7 +270,8 @@ the immediatly following FL_PASTE event.
<!-- NEED 6in -->
-<H2><A name="event_xxx">Fl::event_*() methods</A></H2>
+<A NAME="event_xxx"></A> <!-- For old HTML links only ! -->
+\section events_event_xxx Fl::event_*() methods
<P>FLTK keeps the information about the most recent event in
static storage. This information is good until the next event is
@@ -318,7 +318,8 @@ processed. Thus it is valid inside <TT>handle()</TT> and
</UL>
-<H2><A name=propagation>Event Propagation</A></H2>
+<A NAME="event_xxx"></A> <!-- For old HTML links only ! -->
+\section events_propagation Event Propagation
<P>FLTK follows very simple and unchangeable rules for sending
events. The major innovation is that widgets can indicate (by
diff --git a/documentation/fluid.dox b/documentation/fluid.dox
index 17b25297d..5a8323abe 100644
--- a/documentation/fluid.dox
+++ b/documentation/fluid.dox
@@ -825,7 +825,7 @@ undone, however.
\image html fluid_widget_gui.gif "Figure 9-8: The FLUID widget GUI attributes"
-<H3><A name="widget_attributes">GUI Attributes</A></H3>
+\section fluid_widget_attributes GUI Attributes
<H4>Label (text field)</H4>
@@ -1100,7 +1100,7 @@ the extra code fields to put these values in.</P>
<P>The <B>No Change</B> button means the callback is done on the
matching event even if the data is not changed.
-<H3>Selecting and Moving Widgets</H3>
+\section fluid_selecting_moving Selecting and Moving Widgets
<P>Double-clicking a window name in the browser will display it,
if not displayed yet. From this display you can select widgets,
@@ -1155,7 +1155,7 @@ different.</P>
it) is almost identical to the panel for any other Fl_Widget.
There are three extra items:</P>
-<H3><A name="images">Images</A></H3>
+\section fluid_images Image Labels
<P>The <I>contents</I> of the image files in the <B>Image</B>
and <B>Inactive</B> text fields are written to the <TT>.cxx</TT>
diff --git a/documentation/glut.dox b/documentation/glut.dox
index de3da719c..8ef1a32f5 100644
--- a/documentation/glut.dox
+++ b/documentation/glut.dox
@@ -77,7 +77,8 @@ glutCreateWindow()</TT>! </LI>
loop calling <TT>Fl::wait()</TT> to run the program. </LI>
</UL>
<HR break>
-<H2><A name=Fl_Glut_Window>class Fl_Glut_Window</A></H2>
+ <A NAME="Fl_Glut_Window"></A> <!-- For old HTML links only ! -->
+ \section glut_Fl_Glut_Window class Fl_Glut_Window
<HR>
<H3>Class Hierarchy</H3>
\code
diff --git a/documentation/html_footer b/documentation/html_footer
index d273d2ff1..9c15979d7 100644
--- a/documentation/html_footer
+++ b/documentation/html_footer
@@ -1,9 +1,9 @@
<hr>
<address><small>
-$datetime.
+<!-- $datetime. -->
<a href="http://www.fltk.org"><img src="tiny.gif" align="bottom" alt="FLTK"></a>
-&copy;2008 Bill Spitzak and others.
-<br>Permission is granted to reproduce this manual or any portion for
+&copy; 1998-2008 by Bill Spitzak and others.&nbsp;&nbsp;&nbsp;
+Permission is granted to reproduce this manual or any portion for
any purpose, provided this copyright and permission notice are preserved.
</small></address>
</body></html>
diff --git a/documentation/index.dox b/documentation/index.dox
index 7c42b5bbf..b6b33a4c3 100644
--- a/documentation/index.dox
+++ b/documentation/index.dox
@@ -28,40 +28,36 @@
\subpage basics
\subpage common
- <B>
- <UL>
- <LI><A HREF="drawing.html#colors">Colors</A></LI>
- <LI><A HREF="common.html#boxtypes">Box Types</A></LI>
- <LI><A HREF="common.html#labels">Labels and Label Types</A></LI>
- <LI><A HREF="drawing.html#images">Images</A></LI>
- <LI>class Fl_Pixmap</LI>
- </UL>
- </B>
+
+ <b>
+ \li \ref drawing_colors
+ \li \ref common_boxtypes
+ \li \ref common_labels
+ \li \ref drawing_images
+ </b>
\subpage editor
\subpage drawing
\subpage events
- <B>
- <UL>
- <LI><A HREF="events.html#event_xxx">Fl::event_*() methods</A></LI>
- <LI><A HREF="events.html#propagation">Event Propagation</A></LI>
- </UL>
- </B>
+
+ <b>
+ \li \ref events_event_xxx
+ \li \ref events_propagation
+ </b>
\subpage subclassing
\subpage opengl
\subpage fluid
- <B>
- <UL>
- <LI><A HREF="fluid.html#widget_attributes">Widget Attributes</A></LI>
- <LI><A HREF="fluid.html#widget_attributes">Selecting Moving Widgets</A></LI>
- <LI><A HREF="fluid.html#images">Image Labels</A></LI>
- </UL>
- </B>
+
+ <b>
+ \li \ref fluid_widget_attributes
+ \li \ref fluid_selecting_moving
+ \li \ref fluid_images
+ </b>
</TD>
@@ -71,18 +67,18 @@
\subpage unicode
- <B><A HREF="classes.html">A - Class Reference</A></B>
+ <b><A HREF="classes.html">A - Class Reference</A></b>
- <B><A HREF="globals_func.html">B - Function Reference</A></B>
+ <b><A HREF="globals_func.html">B - Function Reference</A></b>
\subpage enumerations
\subpage glut
- <B>
- <UL>
- <LI><A HREF="glut.html#Fl_Glut_Window">class Fl_Glut_Window</A></LI>
- </UL>
- </B>
+
+ <b>
+ \li \ref glut_Fl_Glut_Window
+ <!-- \li Fl_Glut_Window (not yet commented ?) -->
+ </b>
\subpage forms
diff --git a/documentation/tiny.gif b/documentation/tiny.gif
new file mode 100644
index 000000000..df06e15df
--- /dev/null
+++ b/documentation/tiny.gif
Binary files differ