]> thyrsus.com Git - mad.git/commitdiff
Added example headers.
authorEric S. Raymond <esr@thyrsus,com>
Thu, 19 Feb 2004 03:07:03 +0000 (03:07 +0000)
committerEric S. Raymond <esr@thyrsus,com>
Thu, 19 Feb 2004 03:07:03 +0000 (03:07 +0000)
doc/mad-manual.xml

index 3f32b89a82e7060efca1d2f95a0ead803e5c3387..2d58116dfb6b7ced93ee05bca0ff86210259250f 100644 (file)
@@ -16,6 +16,7 @@
 <!ENTITY scope2 SYSTEM "scope2.xml">
 <!ENTITY scope3 SYSTEM "scope3.xml">
 <!ENTITY scope4 SYSTEM "scope4.xml">
+<!ENTITY retromuseum "http://catb.org/retro">
 
 <!ENTITY scriptA "<emphasis>A</emphasis>">
 <!ENTITY scriptF "<emphasis>B</emphasis>">
 <para>Most of this document is a faithful transcription of the
 reference manual for MAD (Michigan Algorithm Decoder), an early
 academic computer language from 1962.  The manual should be
-accompanied by an implementation.  MAD has been revived as a work of
-reconstructive archeology, so that language connoisseurs of the
-present and future will be able to appreciate what computing life was
-like back in that day.</para>
+accompanied by an implementation; if not, it can be found at the <ulink
+url='&retromuseum;'>Retrocomputing Museum</ulink>.  MAD has been revived
+as a work of reconstructive archeology, so that language connoisseurs
+of the present and future will be able to appreciate what computing
+life was like back in that day.</para>
 
 <para>MAD was an extended dialect of ALGOL 58, first released in 1959
 near the beginning of the great age of invention in compiled languages
@@ -319,6 +321,13 @@ in Chapter 1 include small hand-drawn geometrical shapes after each
 of the items A, B, and the words "diamonds" and "rectangles" in item
 D were corresponding shapes.</para>
 
+<para>In the original, each example in Chapter 3 was introduced by a
+centered numbered header "Example N" with no section numbering.  These
+headers have been turned into second-level sections, and descriptive
+titles added because the Contents page looked awful without
+them.  To remind the reader that these are additions by the redactor,
+they are highlighted like redactor's notes.</para>
+
 <para>The PIC diagrams preserve the logic of the original hand-drawn
 ones, but are not exact geometrical duplicates.  The proportions of
 the flowchart elements are slightly different.  One detail we have not
@@ -3016,7 +3025,7 @@ relation is true.</para>
 
 <sect1><title>Scientific Examples</title>
 
-<sect2><title>Example 1</title>
+<sect2><title>Example 1<emphasis role='note'>: Compute roots of linear and quadratic equations</emphasis></title>
 
 <para><emphasis>Problem:</emphasis> To solve the quadratic equation
 ax<superscript>2</superscript> + bx + c = 0 for vartious sets of
@@ -3061,7 +3070,7 @@ idea!).</para>
 </programlisting>
 
 </sect2>
-<sect2><title>Example 2</title>
+<sect2><title>Example 2<emphasis role='note'>: Printting the truth table of a Boolean expression</emphasis></title>
 
 <para><emphasis>Problem:</emphasis> A logical (Boolean) expression
 such as (P .AND. Q) .OR.(.NOT. P .AND. R .AND. S).OR.(R .OR. P) will
@@ -3171,7 +3180,7 @@ instead of the BOOLEAN declaration.</para>
 
 </sect2>
 <!-- beginpage -->
-<sect2><title>Example 3</title>
+<sect2><title>Example 3<emphasis role='note'>: Simpson's Rule approximation of a definite integral</emphasis></title>
 
 <para><emphasis>Problem:</emphasis> To approximate 
 <subscript>a</subscript>&int;<superscript>b</superscript> f(x) by Simpson's
@@ -3254,11 +3263,10 @@ READ    READ FORMAT INPUTS,A,B,N,R
 </programlisting>
 </sect2>
 <!-- beginpage -->
-<sect2><title>Example 4</title>
+<sect2><title>Example 4<emphasis role='note'>: Find roots of a function by half-interval approximation</emphasis></title>
 
 <!-- FIXME -->
 
-
 <!-- beginpage -->
 <para><emphasis>Flow diagram:</emphasis></para>
 
@@ -3289,7 +3297,7 @@ program deck.</para></note>
 </programlisting>
 </sect2>
 <!-- pagebreak -->
-<sect2><title>Example 5</title>
+<sect2><title>Example 5<emphasis role='note'>: Compute the transpose of a matrix</emphasis></title>
 
 <para><emphasis>Problem:</emphasis> Find the transpose A' of an n&times;n
 matrix A = (a<subscript>ij</subscript>).</para>
@@ -3324,7 +3332,7 @@ function would be <emphasis>called</emphasis> with a statement of the
 form EXECUTE TRANS.(A, N).</para>
 </sect2>
 <!-- pagebreak -->
-<sect2><title>Example 6</title>
+<sect2><title>Example 6<emphasis role='note'>: Matrix multiplication</emphasis></title>
 
 <para><emphasis>Problem:</emphasis> Multiply the matrix A =
 (a<subscript>ij</subscript>) by the matrix B =