home *** CD-ROM | disk | FTP | other *** search
/ NetNews Usenet Archive 1992 #16 / NN_1992_16.iso / spool / comp / binaries / ibm / pc / archives / 3577 < prev    next >
Encoding:
Text File  |  1992-07-24  |  3.9 KB  |  91 lines
  1. Newsgroups: comp.binaries.ibm.pc.archives
  2. Path: sparky!uunet!mcsun!news.funet.fi!ajk.tele.fi!funic!nic.funet.fi!garbo.uwasa.fi!hv
  3. From: hv@garbo.uwasa.fi (Harri Valkama)
  4. Subject: SCANH204.ZIP- Automatically build help files from .PAS source
  5. In-Reply-To: Duncan Murdoch's message of Tue, 14 Jul 92 22:12:20 EDT <9207150212.AA25414@mast.mast.QueensU.CA>
  6. Message-ID: <9207241815.AA25434@garbo.uwasa.fi>
  7. Sender: root@nic.funet.fi (The FUnny NET guru)
  8. Organization: Finnish Academic and Research Network Project - FUNET
  9. Date: Fri, 24 Jul 1992 21:15:00 +0300
  10. Lines: 79
  11.  
  12.  
  13.    Date: Tue, 14 Jul 92 22:12:20 EDT
  14.    From: dmurdoch@mast.QueensU.CA (Duncan Murdoch)
  15.  
  16.  
  17.    This may be of interest to Timo:
  18.  
  19.    File name:                  scanh204.zip
  20.    One line description:       Builds help file from .pas source
  21.    Suggested directory:        /pc/turbopas
  22.    Uploader name & email:      Duncan Murdoch
  23.                    dmurdoch@mast.queensu.ca
  24.    Author or company:          same
  25.    Special requirements:       TurboPower POPHELP and MAKEHELP
  26.    Shareware payment required: None!  
  27.    Self-documenting:           Not really.
  28.    External documentation included: 12K DOC file
  29.    Source included:            No, not yet
  30.    Size:                       29K/58K
  31.    Replaces:                   /pc/turbopas/scan200a.zip
  32.    10 lines description:  (Actually, 11):
  33.  
  34.    TurboPower Software wrote and released to the public domain a program
  35.    to build a skeleton of a help file for a TP unit library by parsing the
  36.    interface sections of the source files.  This is an update to that
  37.    program; it attempts to produce a final version of a help file, that's 
  38.    good enough to use without any manual editing.  I use it for online
  39.    documentation for my own personal unit library.
  40.  
  41.    Compared to the original 2.00alpha which was on garbo, this version:
  42.    -adds /O option to create an output file listing all .TXT files created
  43.    -adds embedded cross references within comment text
  44.    -fixes a few bugs
  45.  
  46.    Long description:
  47.  
  48.    SCANHELP was one of TurboPower's Help Tools, released to the public
  49.    domain in January 1990.  It was designed to create an outline for a help
  50.    database describing the interface to a Turbo Pascal unit; the assumption
  51.    was that the user would make major modifications to the outline to
  52.    produce a polished help system.
  53.  
  54.    I wanted something different:  I wanted documentation for myself, and I
  55.    wanted it to be easy to produce.  I've found that it's too easy for
  56.    printed documentation to get out of synch with the source code when the
  57.    code is under development; even my online documentation kept falling
  58.    behind, because it was just too much trouble to go to the *.TXT file and
  59.    correct the documentation when I made a small change.
  60.  
  61.    The design aim for SCANHELP 2 is thus to produce complete *.TXT files,
  62.    suitable for input to MAKEHELP.  These should be good enough for
  63.    internal use without any manual editing.  It should be possible to
  64.    customize them by working within the original *.PAS source code;
  65.    duplicate documentation should not be necessary.
  66.  
  67.    Some other things I've attempted to do, with varying success:
  68.     - produce documentation for *every* interfaced symbol
  69.     - have a minimal impact on the source code, i.e. existing source code
  70.     should produce reasonable help files without substantial changes
  71.     - handle multiple source files, so cross references to other units are
  72.        possible
  73.     - work with Pascal scoping rules, so that cross references are easy.
  74.  
  75.     THIS IS A TEST VERSION!
  76.  
  77.    This version of SCANHELP is far from complete.  I'm releasing it because
  78.    I'd like to get other people's suggestions for useful features.
  79.    If you try it out, *please* send me a message saying what you like
  80.    about it and what you dislike, and let me know of any gross bugs.  (There
  81.    are lots of minor bugs; I'm not going to worry about those, until the
  82.    design stabilizes.)
  83.  
  84.  
  85.  
  86. Thank you for your contribution. This is now available as:
  87.  
  88. garbo.uwasa.fi:/pc/turbopas/scanh204.zip
  89.  
  90. -harri-
  91.