To LUGNET HomepageTo LUGNET News HomepageTo LUGNET Guide Homepage
 Help on Searching
 
Post new message to lugnet.robotics.rcx.legosOpen lugnet.robotics.rcx.legos in your NNTP NewsreaderTo LUGNET News Traffic PageSign In (Members)
 Robotics / RCX / legOS / 7
6  |  8
Subject: 
Re: legOS docs - what do people want?
Newsgroups: 
lugnet.robotics.rcx.legos
Date: 
Sat, 20 Feb 1999 00:32:47 GMT
Viewed: 
1234 times
  
Todd Lehman wrote:

I think it would be coolest (and most helpful) if the docs were in a super-
portable format, either PDF or, heck, just darn plain old HTML.

I'd vote for PDF over HTML.  For one thing, a PDF document will be considerably
smaller in size than an equivalent HTML document.  HTML also has the less-than
desirable characteristic (in my opinion) of "fragmenting" a hypertext document
across multiple files, which complicates backup and restore procedures slightly
(not insurmountably, of course, but it's still annoying).  Adobe Acrobat Reader is
freely available for almost any hardware/OS platform you might be able to name off
the top of your head anyways (oh, I know there is somebody out there who wants to
argue with me on this... take it to lugnet.off-topic.debate please, or keep it to
email), and is freely distributable so it can readily be made available to people
who obtain the documentation.

HTML would be great because it could easily go on the CD-ROM (if there is one)
for Jonathan's O'Reilly book as well as Markus's website and also into the
standard legOS tarball distribution for offline reading and printing hardcopy.

PDF could also do this.

Certainly, proprietary formats like Windows help files would be least useful,
unless they were automatically generated from a master source document (SGML or
HTML maybe).

Agreed. I would not want it in Windows Help format either.

I'd like (personally) to see a short tutorial with a couple examples (maybe
just a couple quick canned demos) and a high-level overview with rationale
and features and something to help people decide if it's something they really
want to get into.  Maybe something comparing it to the standard RCX firmware
and why it's better for serious geek-types.

Yup, yup, yup.

But examples will probably be plentiful, and focusing on the API documentation
(completeness, correctness, etc.) may be the only thing that truly matters.

--Todd

LegOS is the best thing I've seen yet for the RCX (h8forth looks intriguing to me
too, but its documentation is even poorer and I haven't been able to decipher
through it yet).  LegOS's only down-side in my view is that it's quite difficult to
get up to speed with it, at least compared to other environments like rcxcc.  I
think that the best place to begin with LegOS documentation is with a really good
installation and usage tutorial.

Mark



Message has 3 Replies:
  Re: legOS docs - what do people want?
 
Mark Tarrabain wrote in message <36CE02AF.8C000243@l....bc.ca>... (...) Yes this is a brilliant Idea! I agree. LINC (26 years ago, 20-Feb-99, to lugnet.robotics.rcx.legos)
  PDF (was Re: legOS docs - what do people want?)
 
More than a few people have emailed me already telling me that PDF is not the way to go because it will limit who can contribute to it (thank you to those people, by the way, for keeping such comments to email rather than cluttering the newsgroup (...) (26 years ago, 20-Feb-99, to lugnet.robotics.rcx.legos)
  Re: legOS docs - what do people want?
 
Mark Tarrabain a écrit dans le message <36CE02AF.8C000243@l....bc.ca>... (...) super- (...) considerably (...) less-than not when compressed (...) document (...) slightly you can always have one html file (...) Reader is (...) name I agree with the (...) (26 years ago, 21-Feb-99, to lugnet.robotics.rcx.legos)

Message is in Reply To:
  Re: legOS docs - what do people want?
 
(...) I think it would be coolest (and most helpful) if the docs were in a super- portable format, either PDF or, heck, just darn plain old HTML. HTML would be great because it could easily go on the CD-ROM (if there is one) for Jonathan's O'Reilly (...) (26 years ago, 20-Feb-99, to lugnet.robotics.rcx.legos)

31 Messages in This Thread:













Entire Thread on One Page:
Nested:  All | Brief | Compact | Dots
Linear:  All | Brief | Compact

This Message and its Replies on One Page:
Nested:  All | Brief | Compact | Dots
Linear:  All | Brief | Compact
    

Custom Search

©2005 LUGNET. All rights reserved. - hosted by steinbruch.info GbR