Aditya Mahajan wrote:

On Mon, 31 Mar 2008, Vyatcheslav Yatskovsky wrote:

...

Hello,

Does anyone has a template for software manual? I have vague notion about how it should look like, but, well, I'll know when I see it. ;o) Most modern manuals have common design elements; I wish I had an environment which captures the spirit.

Needless to say, untouched LuaTex envinroment gives too much academic look.

Can anyone kindly suggest something?

Most of the manuals of GNU software are written using texinfo. The advantage is that it is easy to get HTML and info output. There is also docbook, which offers some features for documenting code.

Both of them have fairly simple look, so it should be easy to create a ConTeXt module for them.

If anybody knows of a API documentation style that can handle functions that both take variable arguments as well as return variable arguments, I am very interested in that. For example, there is a the luatex lua function tex.print, and it accepts the following types of calls: tex.print("string", ... ) -- multiple string args are possilbe tex.print(number, "string", ... ) -- number is catcode table And this is not a complex function at all. Here is kpse.find_file: f = kpse.find_file("filename") f = kpse.find_file("filename", 'ftype') f = kpse.find_file("filename", mustexist) f = kpse.find_file("filename", 'ftype', mustexist) f = kpse.find_file("filename", 'ftype', dpi) * "filename" must be a string, otherwise an error is generated * 'ftype' must be one specific value from an enumeration list, default "tex" * mustexist must be a boolean, default false * dpi must be a number, and only applies if 'ftype' is 'pk', 'gf', or 'bitmap font'. It is the "bitmap size". * f can either become a string, or nil It is quite hard to find a suitable documentation style for such functions. Best wishes, Taco