Re: [Tads3] Eric Eve's Getting Started guide

["Mike Roberts" <mjr_@xxxxxxxxxxx>]

"Eric Eve" <eric.eve@harris-manchester.oxford.ac.uk> wrote:
> One piece of HTML documentation I find particularly usable is, perhaps
> ironically enough, the TADS 3 proto-documentation generated by Edward 
> Stauff
> and recommended at the end of my Guide (see
> http://www.stauffconsulting.com/tads3doc ). Of course this is nothing like 
> a
> manual, but as a reference that helps me find my way round the TADS 3
> library it's proved invaluable (it also demonstrates, I think, how 
> radically
> something that works well as HTML can differ from something conceived in
> book format).
Agreed - the tads3doc format is essentially the same as the javadoc format, 
which I've found pretty useful (although even as reference material, the 
javadoc format rapidly becomes unwieldy as the number of methods in the 
class grows).  As you say, though, it's not clear how to apply this kind of 
reference format to more tutorial or narrative material.  I guess it's not 
surprising that HTML is better as a cross-referenced format than as a 
sequential format, since the former is the application it was conceived for.

--Mike

_________________________________________________________________
Compare Cable, DSL or Satellite plans: As low as $29.95.  
https://broadband.msn.com