[boost] Re: Formal Review: The Spirit Parser Framework.

From: Christopher Currie (christopher_at_[hidden])
Date: 2002-10-14 19:59:02

Joel,

An amazing piece of work, I look forward to examining it more fully. I
just have one minor nit to pick about the documentation: please add
"alt" tags to your images, such as:

<img src="theme/spirit.gif" alt="Spirit Logo">

These are particularly useful when applied to navigation icons; those of
us who use lynx to browse the docs over slow connections, as well as those
who use accessability software, will thank you for the effort.

I've included a sample patch to preface.html as an example.

Congratulations on a remarkable achievement.

Christopher

Index: preface.html
===================================================================
RCS file: /cvsroot/spirit/spirit/libs/spirit/doc/preface.html,v
retrieving revision 1.15
diff -u -r1.15 preface.html
--- preface.html	2 Oct 2002 03:44:32 -0000	1.15
+++ preface.html	15 Oct 2002 00:52:40 -0000
@@ -13,16 +13,16 @@
     <td width="85%"> 
       <font size="6" face="Verdana, Arial, Helvetica, sans-serif"><b>Preface</b></font>
     </td>
-    <td width="112">
</td>
+    <td width="112">
</td>
   </tr>
 </table>
 <br>
 <table border="0">
   <tr>
     <td width="10"></td>
-    <td width="30">
</td>
-    <td width="30"><img src="theme/l_arr_disabled.gif" width="20" height="19"></td>
-    <td width="20">
</td>
+    <td width="30">
</td>
+    <td width="30"><img alt="" src="theme/l_arr_disabled.gif" width="20" height="19"></td>
+    <td width="20">
</td>
    </tr>
 </table>
 <br>
@@ -109,26 +109,26 @@
           <td colspan="3" class="table_title">Icons</td>
         </tr>
         <tr> 
-          <td width="19" class="table_cells"><img src="theme/note.gif" width="16" height="16"></td>
+          <td width="19" class="table_cells"><img alt="*Note*" src="theme/note.gif" width="16" height="16"></td>
           <td width="58" class="table_cells"> <b>Note</b></td>
           <td width="627" class="table_cells"> Information provided is moderately 
             important and should be noted by the reader.</td>
         </tr>
         <tr> 
-          <td width="19" class="table_cells"><img src="theme/alert.gif"></td>
+          <td width="19" class="table_cells"><img alt="!Alert!" src="theme/alert.gif"></td>
           <td width="58" class="table_cells"> <b>Alert</b></td>
           <td width="627" class="table_cells"> Information provided is of utmost 
             importance.</td>
         </tr>
         <tr> 
-          <td width="19" class="table_cells"><img src="theme/lens.gif" width="15" height="16"></td>
+          <td width="19" class="table_cells"><img alt="Detail:" src="theme/lens.gif" width="15" height="16"></td>
           <td width="58" class="table_cells"> <b>Detail</b></td>
           <td width="627" class="table_cells"> Information provided is auxiliary 
             but will give the reader a deeper insight into a specific topic. May 
             be skipped.</td>
         </tr>
         <tr> 
-          <td width="19" class="table_cells"><img src="theme/bulb.gif" width="13" height="18"></td>
+          <td width="19" class="table_cells"><img alt="Tip:" src="theme/bulb.gif" width="13" height="18"></td>
           <td width="58" class="table_cells"> <b>Tip</b></td>
           <td width="627" class="table_cells"> A potentially useful and helpful 
             piece of information.</td>
@@ -174,9 +174,9 @@
 <table border="0">
   <tr> 
     <td width="10"></td>
-    <td width="30">
</td>
-    <td width="30"><img src="theme/l_arr_disabled.gif" width="20" height="19"></td>
-    <td width="20">
</td>
+    <td width="30">
</td>
+    <td width="30"><img alt="" src="theme/l_arr_disabled.gif" width="20" height="19"></td>
+    <td width="20">
</td>
   </tr>
 </table>
 <br>