[comp.sys.amiga.tech] autodoc reader

dlarson@blake.u.washington.edu (Dale Larson) (08/14/90)

<eat me>

Does anyone know where I can get a good autodoc reader?
(better than "more" or "less" :-)
--
	There are two ways to improve on human factors in computing:
 to make the programmers less stupid and/or to make the users less stupid.  
		Both are necessary, but neither is likely.
     -Dale Larson, Digital Teddy Bear (dlarson@blake.acs.washington.edu)

peter@cbmvax.commodore.com (Peter Cherna) (08/14/90)

In article <6265@milton.u.washington.edu> dlarson@blake.u.washington.edu (Dale Larson) writes:
><eat me>
>
>Does anyone know where I can get a good autodoc reader?
>(better than "more" or "less" :-)

Fish disk 297 includes the DevKit, which is a collection of ARexx macros
and C-programs for integrating CygnusEd into the autodocs and includes, etc.
There is a stand-alone program called GetAutoDoc that is part of it.

You can just type:

	GetAutoDoc OpenWindow

and poof, you'll get that autodoc.  It's quite fast, since it works off
an index.

Oh yeah, I wrote it :-)

>     -Dale Larson, Digital Teddy Bear (dlarson@blake.acs.washington.edu)

     Peter
--
     Peter Cherna, Software Engineer, Commodore-Amiga, Inc.
     {uunet|rutgers}!cbmvax!peter    peter@cbmvax.cbm.commodore.com
My opinions do not necessarily represent the opinions of my employer.
"This is a one line proof...if we start sufficiently far to the left."

mwm@raven.pa.dec.com (Mike (Real Amigas have keyboard garages) Meyer) (08/15/90)

In article <13794@cbmvax.commodore.com> peter@cbmvax.commodore.com (Peter Cherna) writes:

   Path: bacchus.pa.dec.com!decwrl!uunet!cs.utexas.edu!rutgers!cbmvax!peter
   From: peter@cbmvax.commodore.com (Peter Cherna)
   Newsgroups: comp.sys.amiga.tech
   Date: 14 Aug 90 14:45:00 GMT
   References: <6265@milton.u.washington.edu>
   Reply-To: peter@cbmvax (Peter Cherna)
   Organization: Commodore, West Chester, PA
   Lines: 27

   In article <6265@milton.u.washington.edu> dlarson@blake.u.washington.edu (Dale Larson) writes:
   ><eat me>
   >
   >Does anyone know where I can get a good autodoc reader?
   >(better than "more" or "less" :-)

   Fish disk 297 includes the DevKit, which is a collection of ARexx macros
   and C-programs for integrating CygnusEd into the autodocs and includes, etc.
   There is a stand-alone program called GetAutoDoc that is part of it.

I've got (had? - depends on many other things) a version of the 2.0
AutoDocs loaded into the hypertext system "Thinker". When CBM gets
more 3000's so they can ship me one, I'm going to try it with the
read-only demo version.

The results look more like the infominder version than getautodoc, but
it's got one advantage over both: given an autodoc that references
another function, you can click on the names of functions, and get the
docs for the referenced function. Your choice of doing it in the
current window, another window, or any open thinker window.

Unfortunately, building those thinker documents was a lot of work, and
it's not liable to be repeated. Nor am I sure about how I can
distribute them - after all, they're covered by some funny agreement I
had to sign to get them.

It'd help a lot of the autodocs had a consistent format, instead of
whatever whoever wrote them thought would work best. Then again, that
would probably help _everybody_ who wanted to load the autodocs into
some form of "intelligent reader".

	<mike
--
When logic and proportion have fallen softly dead,	Mike Meyer
And the white knight is talking backwards,		mwm@relay.pa.dec.com
And the red queen's off her head,			decwrl!mwm
Remember what the dormouse said.

GIAMPAL@auvm.auvm.edu (08/15/90)

In addition, Matt Dillon's DME has a "reference" feature that cover both
the Includes AND Autodocs.  While editing your code, you simply position
your cursor on the structure/function you wish to look up, press Cntrl-
(that's supposed to be control-close bracket) and DME will pop up the exact
reference in a window which is sized to fit the reference.

Works great for me (and I don't have to use another program, I just edit
my sources with DME and I'm all set).  Of course if you don't like DME
then it isn't much use.

The DME archive I got even had the "reference" files already set up.

--dominic

guineau@wjg.enet.dec.com (08/16/90)

In article <MWM.90Aug14134103@raven.pa.dec.com>, mwm@raven.pa.dec.com (Mike
(Real Amigas have keyboard garages) Meyer) writes:
|> From: mwm@raven.pa.dec.com (Mike (Real Amigas have keyboard garages) Meyer)
|> Newsgroups: comp.sys.amiga.tech
|> Subject: Re: autodoc reader
|> 
|> In article <13794@cbmvax.commodore.com> peter@cbmvax.commodore.com (Peter
Cherna) writes:
|> 
|>    Path: bacchus.pa.dec.com!decwrl!uunet!cs.utexas.edu!rutgers!cbmvax!peter
|>    From: peter@cbmvax.commodore.com (Peter Cherna)
|>    Newsgroups: comp.sys.amiga.tech
|>    Date: 14 Aug 90 14:45:00 GMT
|>    References: <6265@milton.u.washington.edu>
|>    Reply-To: peter@cbmvax (Peter Cherna)
|>    Organization: Commodore, West Chester, PA
|>    Lines: 27
|> 
|>    In article <6265@milton.u.washington.edu> dlarson@blake.u.washington.edu
(Dale Larson) writes:
|>    ><eat me>
|>    >
|>    >Does anyone know where I can get a good autodoc reader?
|>    >(better than "more" or "less" :-)
|> 
|>    Fish disk 297 includes the DevKit, which is a collection of ARexx macros
|>    and C-programs for integrating CygnusEd into the autodocs and includes,
etc.
|>    There is a stand-alone program called GetAutoDoc that is part of it.
|> 
|> I've got (had? - depends on many other things) a version of the 2.0
|> AutoDocs loaded into the hypertext system "Thinker". When CBM gets
|> more 3000's so they can ship me one, I'm going to try it with the
|> read-only demo version.
|> 
|> The results look more like the infominder version than getautodoc, but
|> it's got one advantage over both: given an autodoc that references
|> another function, you can click on the names of functions, and get the
|> docs for the referenced function. Your choice of doing it in the
|> current window, another window, or any open thinker window.
|> 
|> Unfortunately, building those thinker documents was a lot of work, and
|> it's not liable to be repeated. Nor am I sure about how I can
|> distribute them - after all, they're covered by some funny agreement I
|> had to sign to get them.
|> 
|> It'd help a lot of the autodocs had a consistent format, instead of
|> whatever whoever wrote them thought would work best. Then again, that
|> would probably help _everybody_ who wanted to load the autodocs into
|> some form of "intelligent reader".
|> 
|> 	<mike
|> --
|> When logic and proportion have fallen softly dead,	Mike Meyer
|> And the white knight is talking backwards,		mwm@relay.pa.dec.com
|> And the red queen's off her head,			decwrl!mwm
|> Remember what the dormouse said.
|> 

It would be nice if the autodocs came with a decent reader/cross referencer...

--
W. John Guineau   			guineau@wjg.enet.dec.com
Digital Equipment Corporation
Marlboro MA. 01752

dillon@overload.Berkeley.CA.US (Matthew Dillon) (08/19/90)

>In article <90227.090231GIAMPAL@auvm.auvm.edu> GIAMPAL@auvm.auvm.edu writes:
>In addition, Matt Dillon's DME has a "reference" feature that cover both
>the Includes AND Autodocs.  While editing your code, you simply position
>...
>The DME archive I got even had the "reference" files already set up.
>
>--dominic

    The 'autorefs' program, part of the DME distribution, scans specified
    files and generates the ref file that DME uses to lookup the reference...
    for those of you running 2.0 autodocs and includes the refs file included
    with the distribution will not work since all the file offsets are
    different.

    The next release of DME will fix several bugs in this area.  I've found
    it to be invaluable as well!

					-Matt
--

    Matthew Dillon	    dillon@Overload.Berkeley.CA.US
    891 Regal Rd.	    uunet.uu.net!overload!dillon
    Berkeley, Ca. 94708
    USA