[comp.lang.forth] Documentation

UNBCIC@BRFAPESP.BITNET (05/22/91)

=> I sure can't argue with you Ray.  I've experienced everything you mentioned
=> with regard to shadow blocks.  Yet, there's something about the vertical
=> formatting that doesn't quite work for me either. I supposed with block or
=> text files or any other "linear" approach to source management, I'm not going
=> to be satisfied.  I haven't experimented with the hypertext type systems yet.
=> Maybe they might hold some promise.
=>
=> Has anyone done hypertext source code documentation?  I think the FPC might
=> have the facilities to do it.  Has anyone used them for program documentation
=> yet?

I do use, but there are two "levels" possible in F-PC. First level: in a system
already compiled, you can go to the place where was the word was defined or to
another file in a place where you can find more information (this file must
have the extension .HLP). I do use this. Abstraction in documentation...

Second level: really hypertext. You mark some keywords with two different
symbols. The first one is the "source", a "jump point". The second one is the
point where more information about the topic (keyword) can be found. This kind
of documentation is difficult to make. FPC use this as the on-line help, just
like Borland languages. I don't have experience with this "level".

                              (8-DCS)
Daniel C. Sobral
UNBCIC@BRFAPESP.BITNET