Re: Online Help in eLua?

Posted by jbsnyder on
URL: http://elua-development.15.s1.nabble.com/Online-Help-in-eLua-tp2456949p2457207.html

On Mar 10, 2009, at 1:44 PM, Dado Sutter wrote:

Hello,
   I had thought about a "help module" once. It would not depend on modules's metatables (to be implemented by each new module) but would be a separate module and have something like your help() function.
   The problem is that, with our current main target boards, we just can't affoard so much ram and even flash. (Remember, some crazy guys are talking seriously about eLua on 8 bits :)
   If architectured as an optional module, it could be interesting to have in the next generation of chips/boards, that promisse to come with plenty of space to play with. (they are actually out there already ! :)

Right, and it could be traded for functionality on space-impaired platforms.

I'm not sure how large this would end up being if it were really kept as simple as possible, but space is always at a premium :-)

   We also want to concentrate the doc in a single place and the move we've made (comming on v0.6) to webbook proves that. But not all the project's "doc" is related to the modules, their functions or even the code implementation. This would be more of a "Reference Manual", which is one of the sections of the new "site/doc".

This is true.  What I was thinking of was less something that would regenerate the docs from scratch and more something that would parse documentation strings in the code and the HTML in the docs and update text sections in the HTML they didn't match the code.  This way could could selectively slave parts of the HTML documentation contents off of descriptions in the code.

I suppose something like this could also run the other way.  If the reference manual HTML is regularized enough, you could scrape the module documentation from the html and generate some sort of packed doc that could live in romfs or on an SD card, and then you could get your documentation from there.  This might be the easiest solution and keeps the webbook docs as the master.

--

James Snyder

Biomedical Engineering

Northwestern University

[hidden email]

http://fanplastic.org/key.txt

_______________________________________________
Elua-dev mailing list
[hidden email]
https://lists.berlios.de/mailman/listinfo/elua-dev