improve doc links for Brush,Color,Font,Pattern + test html/README

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

Patch:	ivtools-000113-johnston-007
For:	ivtools-0.7.10
Author:	joh...@us...

This is an intermediate patch to ivtools-0.7.10.  To apply, cd to the
top-level directory of the ivtools source tree (the directory with src
and config subdirs), and apply like this:

	patch -s <ThisFile

Summary of Changes:

- embed documentation to extract with PERCEPS that links the Brush,
Color, Font, and Pattern web pages to the InterViews 3.1 reference
manual and pspaint(3) man page.

- test and revise the src/html/README that describes how to gen a set
of ivtools html documentation.

Index: include_interviews/brush.h
diff -c include_interviews/brush.h:1.1 include_interviews/brush.h:1.2
*** include_interviews/brush.h:1.1	Thu Jan 13 22:24:37 2000
--- src/include/InterViews/brush.h	Thu Jan 13 22:24:37 2000
***************
*** 38,43 ****
--- 38,46 ----
  class BrushImpl;
  class Display;

+ //: a brush style object
+ // defines the line thickness and line style for drawing operations.
+ // <p><a href=../refman3.1/refman.html#PAGE37>in reference manual</a>.
  class Brush : public Resource {
  public:
      Brush(Coord width);
Index: include_interviews/color.h
diff -c include_interviews/color.h:1.1 include_interviews/color.h:1.2
*** include_interviews/color.h:1.1	Thu Jan 13 22:24:37 2000
--- src/include/InterViews/color.h	Thu Jan 13 22:24:37 2000
***************
*** 38,43 ****
--- 38,47 ----
  typedef float ColorIntensity;
  typedef unsigned int ColorOp;

+ //: an RGB-alpha color object
+ // defines an output color, which is specified by a mix of RGB (red,<BR>
+ green, and blue) intensities, and an alpha value for blending
+ // <p><a href=../refman3.1/refman.html#PAGE38>in reference manual</a>.
  class Color : public Resource {
  public:
      enum { Copy, Xor, Invisible };
Index: include_interviews/font.h
diff -c include_interviews/font.h:1.1 include_interviews/font.h:1.2
*** include_interviews/font.h:1.1	Thu Jan 13 22:24:37 2000
--- src/include/InterViews/font.h	Thu Jan 13 22:24:37 2000
***************
*** 96,103 ****
  inline Coord FontBoundingBox::font_ascent() const { return font_ascent_; }
  inline Coord FontBoundingBox::font_descent() const { return font_descent_; }

! //: InterViews font class.
! // <a href=../refman3.1/refman.html#PAGE39>in reference manual</a>
  class Font : public Resource {
  public:
      Font(const String&, float scale = 1.0);
--- 96,104 ----
  inline Coord FontBoundingBox::font_ascent() const { return font_ascent_; }
  inline Coord FontBoundingBox::font_descent() const { return font_descent_; }

! //: a font object
! // defines a mapping between character codes and their appearance on the screen.
! // <p><a href=../refman3.1/refman.html#PAGE39>in reference manual</a>
  class Font : public Resource {
  public:
      Font(const String&, float scale = 1.0);
Index: include_interviews/pattern.h
diff -c include_interviews/pattern.h:1.1 include_interviews/pattern.h:1.2
*** include_interviews/pattern.h:1.1	Thu Jan 13 22:24:37 2000
--- src/include/InterViews/pattern.h	Thu Jan 13 22:24:37 2000
***************
*** 35,40 ****
--- 35,43 ----

  class PatternRep;

+ //: a pattern object
+ // defines a pattern for rendering operations
+ // <p><a href=../man3.1/pspaint3.html>pspaint(3)</a>.
  class Pattern : public Resource {
  public:
      enum {
Index: man3_ivtools/pspaint.3
diff -c man3_ivtools/pspaint.3:1.1 man3_ivtools/pspaint.3:1.2
*** man3_ivtools/pspaint.3:1.1	Thu Jan 13 22:24:47 2000
--- src/man/man3/pspaint.3	Thu Jan 13 22:24:47 2000
***************
*** 117,120 ****
  Return the array that defines the replicated pattern and its size, if
  the pattern was constructed with one.
  .SH SEE ALSO
! Brush(3I), Color(3I), Font(3I), Pattern(3I), idraw(1I)
--- 117,120 ----
  Return the array that defines the replicated pattern and its size, if
  the pattern was constructed with one.
  .SH SEE ALSO
!  idraw(1I), pspaint(3I), and the InterViews 3.1 reference manual
Index: html_ivtools/README
diff -c html_ivtools/README:1.1 html_ivtools/README:1.2
*** html_ivtools/README:1.1	Thu Jan 13 22:24:49 2000
--- src/html/README	Thu Jan 13 22:24:49 2000
***************
*** 4,11 ****
  1. Background

  ivtools header files (.h files) include comments that can be extracted
! the PERCEPS, an automatic documentation generator for C++ written in
! Perl (http://friga.mer.utexas.edu/mark/perl/perceps/).  

  ivtools uses three techniques supported by PERCEPS for embedding
  extractable comments:
--- 4,11 ----
  1. Background

  ivtools header files (.h files) include comments that can be extracted
! by PERCEPS, an automatic documentation generator for C++ written in
! Perl (http://starship.python.net/crew/tbryan/PERCEPS/).

  ivtools uses three techniques supported by PERCEPS for embedding
  extractable comments:
***************
*** 37,45 ****
  ivtools, do the following:

  	2.1 Acquire and install a copy of PERCEPS, Version 3.4.1 or
! 	greater.  Get it from the author's website:

! 		http://friga.mer.utexas.edu/mark/perl/perceps/	

  	or from here:

--- 37,45 ----
  ivtools, do the following:

  	2.1 Acquire and install a copy of PERCEPS, Version 3.4.1 or
! 	greater.  Get it from the maintainers's website:

! 		http://starship.python.net/crew/tbryan/PERCEPS/

  	or from here:

***************
*** 50,61 ****
  		perl --version

! 	2.3 Verify your copy of Perl is installed at /usr/local/bin/perl:

  		which perl

  	    If it is not at that location, edit the first line of the 
! 	    perceps script in this directory to reflect the actual location.

  	2.4 Run the following commands to generate the html:
--- 50,62 ----
  		perl --version

! 	2.3 Verify your copy of Perl is installed at /bin/perl:

  		which perl

  	    If it is not at that location, edit the first line of the 
! 	    perceps script in this directory to reflect the actual
! 	location, or make a symbol link for.

  	2.4 Run the following commands to generate the html:
***************
*** 101,111 ****

  	Run the shell script getman31.sh from this directory.
  	Requires an installed and working copy of the ivtools utility
! 	ivdl.

  	4.2 HTML versions of InterViews 3.1 reference manual

  	Run the shell script getrefman31.sh from this directory.
  	Requires an installed and working copy of the ivtools utility
! 	ivdl.

--- 102,114 ----

  	Run the shell script getman31.sh from this directory.
  	Requires an installed and working copy of the ivtools utility
! 	ivdl.  The script can be edited to use w3c or curl or any other
! 	command line URL grabber.

  	4.2 HTML versions of InterViews 3.1 reference manual

  	Run the shell script getrefman31.sh from this directory.
  	Requires an installed and working copy of the ivtools utility
! 	ivdl.  The script can be edited to use w3c or curl or any other
! 	command line URL grabber.