home *** CD-ROM | disk | FTP | other *** search
/ NetNews Usenet Archive 1993 #3 / NN_1993_3.iso / spool / misc / writing / 4232 < prev    next >
Encoding:
Text File  |  1993-01-23  |  2.2 KB  |  58 lines
  1. Newsgroups: misc.writing
  2. Path: sparky!uunet!van-bc!sqwest!marcy
  3. From: marcy@sqwest.wimsey.bc.ca (Marcy Thompson)
  4. Subject: Indexing (was: *** Why is rewriting bad?)
  5. Message-ID: <1993Jan22.210427.2947@sqwest.wimsey.bc.ca>
  6. Organization: SoftQuad Inc., Surrey, British Columbia, CANADA
  7. References: <77124@apple.apple.COM> <1993Jan21.203546.45088@datamark.co.nz> <C19EqC.6s5@unx.sas.com>
  8. Date: Fri, 22 Jan 1993 21:04:27 GMT
  9. Lines: 47
  10.  
  11. In a recent misc.writing article, Len Olszewski wrote:
  12. >
  13. >In article Thomas Beagle writes:
  14. >
  15. >|> ObWriting : When writing a manual, do you index as you go (and risk
  16. >|> all sorts of incompatibilities) or do you index after the bulk of the
  17. >|> manual is written?
  18. >
  19. >After its finished. The way we lay it out here, setting the final page 
  20. >breaks is an important pre-index requirement. Also, you never know 
  21. >what's going to be in or out in some books, really, until the last
  22. >minute. You've already mentioned consistency as good reason to wait.
  23. >Also, the editors get the book last, and they can introduce all kinds of 
  24. >changes.
  25.  
  26. As we go. We use SGML and our document structure includes index elements.
  27. You can put them in as you go. ("Oh, I'm writing about error messages. That
  28. should go into the index. BANG! There it is.")
  29.  
  30. When the document is done and printed, the printing software doesn't print
  31. these elements, it just notes them and the page number on which they appear.
  32. So the index is created as the document is printed. ("Look, Sadie, there's
  33. a discussion of error messages on page 67!") Usually, we massge the index
  34. entries when we look at the first page proofs, which are intended to be
  35. drafts anyway.
  36.  
  37. The index element (in case anyone cares) allows you to specify the index
  38. entry, including a parent entry if you want. As a result, we get index
  39. entries which look like:
  40.  
  41.  
  42.     Equation delimiters  . . 36
  43.     Errors
  44.        conditions  . . . . . 72-75
  45.        messages  . . . . . . 67, B.1-9
  46.        testing in macros . . B10
  47.  
  48. I've worked in shops where the indexing was done by hand at the end of the
  49. process. This is much, much better. Much better. 
  50.  
  51. Marcy
  52.  
  53. -- 
  54.  
  55. Marcy Thompson        
  56.   SoftQuad (West)            
  57.     marcy@sqwest.wimsey.bc.ca (preferred) or marcy@sq.com
  58.