Re: Online Help in eLua?

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

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 :-)

True, but we'll make this configurable like everything else we have, so this shouldn't be such a big problem.
 

   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'd go with the XML version, since it's way easier to standardize. Different people working on the same HTML document have different ideas about formatting (I don't have to tell you that :) ), or about using new style=... args or opting for older HTML tags, or other things like this. A XML file would only have content, thus this problem is gone. No need to parse HTML anymore. The formatting part of HTML will be generated by a simple Lua script from the XML.

Best,
Bogdan

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