home *** CD-ROM | disk | FTP | other *** search
/ NetNews Usenet Archive 1993 #3 / NN_1993_3.iso / spool / misc / writing / 4286 < prev    next >
Encoding:
Text File  |  1993-01-27  |  2.4 KB  |  59 lines
  1. Newsgroups: misc.writing
  2. Path: sparky!uunet!destroyer!cs.ubc.ca!van-bc!sqwest!marcy
  3. From: marcy@sqwest.wimsey.bc.ca (Marcy Thompson)
  4. Subject: Re: Indexing (was: *** Why is rewriting bad?)
  5. Message-ID: <1993Jan26.181754.9854@sqwest.wimsey.bc.ca>
  6. Organization: SoftQuad Inc., Surrey, British Columbia, CANADA
  7. References: <C19EqC.6s5@unx.sas.com> <1993Jan22.210427.2947@sqwest.wimsey.bc.ca> <1993Jan25.192738.51901@datamark.co.nz>
  8. Date: Tue, 26 Jan 1993 18:17:54 GMT
  9. Lines: 48
  10.  
  11. In a recent misc.writing article, Thomas Beagle wrote (quoting me): 
  12.  
  13. >>We use SGML and our document structure includes index elements.
  14. >>You can put them in as you go. ("Oh, I'm writing about error messages. That
  15. >>should go into the index. BANG! There it is.")
  16. >
  17. >But when indexing as you go, how do you ensure that the index will be
  18. >internally consistent?
  19.  
  20. Two ways:
  21.  
  22.   1. First, we have an informal standard for how we think index entries
  23.      should be made. Essentially, it says "Index as much as possible, with
  24.      as many headings as possible". (This is oversimplified, of course,
  25.      but the idea is to give the user as many entries into the material
  26.      as possible.)
  27.  
  28.      That means if I'm writing about the "Validate Document" command, I'll
  29.      put in index tags for: Validate Document command, Special Menu commands
  30.      (with a sub entry of Validate Document), SGML Parser (because that's
  31.      what Validate really is), Error-checking (because that's what Validate
  32.      does).
  33.  
  34.   2. Then in the first-printing edit stage, we standardize the entries. 
  35.      This seems to come down to standardizing capitalization, mostly.
  36.  
  37.      It is very easy to find any entries that need to be changed, because
  38.      the entries are (SGML jargon alert!) attributes to the index element
  39.      and because (product plug alert!) the software has a powerful find
  40.      function that lets me say "Find me the index element with the ENTRY
  41.      attribute set to `Error-checking'".
  42.  
  43. >>I've worked in shops where the indexing was done by hand at the end of the
  44. >>process. This is much, much better. Much better. 
  45. >
  46. >I can't help thinking that indexing by hand should be banned under the
  47. >Geneva Convention. :-)
  48.  
  49. No argument here. I think it also contravenes the constitutional ban on
  50. cruel and unusual punishment if you happen to be in the US. :-)
  51.  
  52. Marcy
  53.  
  54. -- 
  55.  
  56. Marcy Thompson        
  57.   SoftQuad (West)            
  58.     marcy@sqwest.wimsey.bc.ca (preferred) or marcy@sq.com
  59.