File: type_printed.html

package info (click to toggle)
funnelweb-doc 3.2d-4.2
links: PTS
area: main
in suites: forky, sid, trixie
size: 3,744 kB
sloc: perl: 241; makefile: 23
file content (248 lines) | stat: -rw-r--r-- 8,195 bytes
parent folder | download | duplicates (5)

<HTML>
<!--
***********************************************************************
FUNNELWEB MANUAL WEB PAGE
=========================
Copyright (c) Ross N. Williams 1992,1999. All rights reserved.

Permission is granted to redistribute and use this manual in
any medium, with or without modification, provided that all
notices (including, without limitation, the copyright
notice, this permission notice, any record of modification,
and all legal notices) are preserved on all copies, that all
modifications are clearly marked, and that modified versions
are not represented as the original version unless all the
modifications since the manual's original release by Ross N.
Williams (www.ross.net) consist of translations or other
transformations that alter only the manual's form, not its
content. THIS MANUAL IS PROVIDED "AS IS" AND WITHOUT ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT
LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND
FITNESS FOR A PARTICULAR PURPOSE. TO THE EXTENT PERMITTED BY
LAW THERE IS ABSOLUTELY NO WARRANTY.

***********************************************************************
-->

<HEAD>
<TITLE>3.4 Understanding the Printed Documentation</TITLE>
<STYLE TYPE="text/css"> <!-- A {text-decoration: none} // --> </STYLE>
</HEAD>
<BODY BACKGROUND="binary/background.gif"
      BGCOLOR="#FFFFFF"
      TEXT="#000000"
      VLINK="#660000"
      LINK="#FF0000"
      ALINK="#CC0000">

<TABLE WIDTH="490">
<TR>
<TD WIDTH="130" VALIGN="top">
<IMG SRC="binary/d_clear.gif" ALT="" WIDTH="130" HEIGHT="1"><BR>

<FONT SIZE="2">
<BR>

<A HREF="http://www.ross.net/"
 TARGET="rosshome"
 onClick="window.open('','rosshome','location,status,menubar,scrollbars,resizable',false).focus(); return true;"
>
 <IMG SRC="binary/rossnet_logo.gif"
  WIDTH="64" HEIGHT="32"
  BORDER="0" ALT="RossNet"
  HSPACE="0" VSPACE="1"></A><BR>
<BR>

<A HREF="../index.shtml"
 TARGET="funnelweb"
 onClick="window.open('','funnelweb','location,status,menubar,scrollbars,resizable',false).focus(); return true;"
>
 <IMG SRC="binary/linklogo.gif"
  WIDTH="64" HEIGHT="32"
  BORDER="0" ALT="FunnelWeb"
  HSPACE="0" VSPACE="1"></A><BR>
<BR>
<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0><TR><TD BGCOLOR="#000000">
<A HREF="../reference/index.html"
 TARGET="funnelwebreference"
 onClick="window.open('','funnelwebreference','location,status,menubar,scrollbars,resizable',false).focus(); return true;"
><FONT COLOR="#FFFFFF"><B>Reference</B></FONT></A><BR>
<BR>
<A HREF="../developer/index.html"
 TARGET="funnelwebdeveloper"
 onClick="window.open('','funnelwebdeveloper','location,status,menubar,scrollbars,resizable',false).focus(); return true;"
><FONT COLOR="#FFFFFF"><B>Developer</B></FONT></A><BR>
<BR>
<A HREF="index.html"><FONT COLOR="#FFFFFF"><B>Tutorial</B></FONT></A><BR>
<A HREF="intro.html"><FONT COLOR="#FFFFFF">1 Introduction</FONT></A><BR>
<A HREF="macro.html"><FONT COLOR="#FFFFFF">2 Macros</FONT></A><BR>
<A HREF="type.html"><FONT COLOR="#FFFFFF">3 Typesetting</FONT></A><BR>
<A HREF="example.html"><FONT COLOR="#FFFFFF">4 Example</FONT></A><BR>
<A HREF="hints.html"><FONT COLOR="#FFFFFF">5 Hints</FONT></A><BR>
<A HREF="examples.html"><FONT COLOR="#FFFFFF">6 Examples</FONT></A><BR>
<A HREF="web.html"><FONT COLOR="#FFFFFF">7 Webmaking</FONT></A><BR>

<BR>
<A HREF="search.html"><FONT COLOR="#FFFFFF"><B>SEARCH</B></FONT></A><BR>
</FONT>
</TD></TR></TABLE>


</TD>
<TD WIDTH="360" VALIGN="top">
<FONT SIZE="3">


<A HREF="../reference/index.html"><IMG SRC="binary/title.gif"
 WIDTH="302" HEIGHT="24"
 BORDER="0" ALT="FunnelWeb Tutorial Manual"
 HSPACE="0" VSPACE="0"></A>
<P><FONT SIZE="5">3.4 Understanding the Printed Documentation</FONT><BR>


<P>Type in the following file, and use FunnelWeb and TeX
to generate the corresponding printed
documentation.


<P>
<PRE>
@A@&lt;Table of Contents@&gt;

@t table_of_contents

@A@&lt;Macros for Moral Support@&gt;

The following macro contain comments that provide moral
support.

@$@&lt;Programmer's Cheer@&gt;@M==@{
-- Shift to the left!
-- Shift to the right!
-- Pop up, push down!
-- Byte! Byte! Byte!
-- (From "The New Hacker's Dictionary").
@}

The next macro is similar but is
distributed throughout the program.

@$@&lt;Hacker's Cheer@&gt;+=@{
-- Pointer to the left@+@}

@A@&lt;An Extremely Imperative Stack Abstraction@&gt;

@B@&lt;Define the Stack@&gt;

@$@&lt;Hacker's Cheer@&gt;+=@{@-
-- Pointer to the right@+@}

@$@&lt;Stack Type@&gt;@Z==@{@-
type stack = record ... end;@}

@B@&lt;Push the Stack@&gt;

@$@&lt;Hacker's Cheer@&gt;+=@{@-
-- Hack that code@+@}

@$@&lt;Push Procedure@&gt;@Z==@{@-
procedure push(var b:stack; v:value);
@&lt;Programmer's Cheer@&gt; {...}@}

@B@&lt;Pop the Stack@&gt;

@$@&lt;Hacker's Cheer@&gt;+=@{@-
-- Tight! Tight! Tight!@+@}

@$@&lt;Pop Procedure@&gt;@Z==@{@-
procedure pop(var b:stack);

@&lt;Programmer's Cheer@&gt; {...}@}

@B@&lt;Rough the Stack Up a Bit@&gt;

@$@&lt;Hacker's Cheer@&gt;+=@{@-
-- (RNW, 04-Jan-1991).@+@}

@$@&lt;Rough Procedure@&gt;@Z==@{@-
procedure rough(var b:stack);
@&lt;Hacker's Cheer@&gt; {...}@}

@O@&lt;dummy.txt@&gt;==@{dummy@+@}
</PRE>

<P>An examination of the printed documentation reveals a
lot about how FunnelWeb's presentation works.

<P>First, notice how the <SAMP>@t</SAMP> typesetter
directive at the top of the file has caused a table of
contents to appear. This is one of FunnelWeb's typesetting
features and is discussed in a later section. The table of
contents shows that the sections have been numbered
hierarchically.

<P>Now take a look at the typeset macro definitions. Most
important are the numbers in square brackets that follow
each macro name. As well as numbering the headings
<I>hierarchically</I>&nbsp;, FunnelWeb <I>independently</I>&nbsp;
numbers the macro definitions <I>sequentially</I>&nbsp;. The
first macro definition (for "Programmer's Cheer") is
numbered 1. The second (for "Hacker's Cheer") is
numbered 2 and so on. Note that it is not macros that are
numbered, but macro definitions. The distinction is
necessary because some macros (such as the "Hacker's
                                            Cheer" macro) are additive. It is important to realize that
there is no relationship between the numbers of the headings
and the numbers of the macro definitions.

<P>Now take a look at the notes beneath the body of each
macro definition. All macro definitions are followed by a
note indicating the definitions in which the macro is
called. Additive macros have an additional list, listing the
definitions in which they are defined.

<P>Finally, take a look at the macro <I>call</I>&nbsp; of
"Programmer's Cheer" in section&nbsp;3.2 of the printed
documentation. Macro calls are set in slanted roman (so that
they can be distinguished from the <SAMP>tt font</SAMP> code)
and are followed by the number of the defining macro
definition. In this case, the macro was defined in
definition&nbsp;1. Further down, the call to the "Hacker's
                                                  Cheer" macro indicates that the macro was defined in
definition&nbsp;2. In fact the macro is additive and definition&nbsp;2
is just the first of many definitions. To list all
definitions in a call to an additive macro would be
unnecessarily messy.


<P>
<TABLE WIDTH="100%">
<TR>
<TD ALIGN="left"   VALIGN="bottom"><A HREF="type_hierarchy.html"><IMG SRC="binary/fw_left.gif" HEIGHT="32" WIDTH="32" BORDER="0" ALT="Prev"></A></TD>
<TD ALIGN="center" VALIGN="bottom"><A HREF="type.html"><IMG SRC="binary/fw_up.gif" HEIGHT="32" WIDTH="32" BORDER="0" ALT="Up"></A></TD>
<TD ALIGN="right"  VALIGN="bottom"><A HREF="type_literals.html"><IMG SRC="binary/fw_right.gif" HEIGHT="32" WIDTH="32" BORDER="0" ALT="Next"></A></TD>
</TR>
</TABLE>



<HR>
<FONT SIZE="2">
<A HREF="mailto:webmaster@ross.net">Webmaster</A>&nbsp;&nbsp;&nbsp;
<A HREF="copyright.html">Copyright &copy; Ross N. Williams 1992,1999. All rights reserved.</A><BR>
</FONT>

</FONT>
</TD>
</TR>
</TABLE>


</BODY>

<!-- *********************************************************************** -->
<!--      End Of A FunnelWeb Manual Web Page (www.ross.net/funnelweb/)       -->
<!-- *********************************************************************** -->

</HTML>