* Software manual template request [not found] <mailman.3960.1206900497.4340.ntg-context@ntg.nl> @ 2008-03-30 23:53 ` Vyatcheslav Yatskovsky 2008-03-31 15:27 ` Aditya Mahajan 0 siblings, 1 reply; 4+ messages in thread From: Vyatcheslav Yatskovsky @ 2008-03-30 23:53 UTC (permalink / raw) To: ntg-context-request@ntg.nl 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? Best regards, Vyatcheslav Yatskovsky ___________________________________________________________________________________ If your question is of interest to others as well, please add an entry to the Wiki! maillist : ntg-context@ntg.nl / http://www.ntg.nl/mailman/listinfo/ntg-context webpage : http://www.pragma-ade.nl / http://tex.aanhet.net archive : https://foundry.supelec.fr/projects/contextrev/ wiki : http://contextgarden.net ___________________________________________________________________________________ ^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: Software manual template request 2008-03-30 23:53 ` Software manual template request Vyatcheslav Yatskovsky @ 2008-03-31 15:27 ` Aditya Mahajan 2008-04-01 7:03 ` Taco Hoekwater 0 siblings, 1 reply; 4+ messages in thread From: Aditya Mahajan @ 2008-03-31 15:27 UTC (permalink / raw) To: Yatskovsky, mailing list for ConTeXt users 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. Aditya ___________________________________________________________________________________ If your question is of interest to others as well, please add an entry to the Wiki! maillist : ntg-context@ntg.nl / http://www.ntg.nl/mailman/listinfo/ntg-context webpage : http://www.pragma-ade.nl / http://tex.aanhet.net archive : https://foundry.supelec.fr/projects/contextrev/ wiki : http://contextgarden.net ___________________________________________________________________________________ ^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: Software manual template request 2008-03-31 15:27 ` Aditya Mahajan @ 2008-04-01 7:03 ` Taco Hoekwater 2008-04-01 8:18 ` luigi scarso 0 siblings, 1 reply; 4+ messages in thread From: Taco Hoekwater @ 2008-04-01 7:03 UTC (permalink / raw) To: mailing list for ConTeXt users; +Cc: Yatskovsky 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 ___________________________________________________________________________________ If your question is of interest to others as well, please add an entry to the Wiki! maillist : ntg-context@ntg.nl / http://www.ntg.nl/mailman/listinfo/ntg-context webpage : http://www.pragma-ade.nl / http://tex.aanhet.net archive : https://foundry.supelec.fr/projects/contextrev/ wiki : http://contextgarden.net ___________________________________________________________________________________ ^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: Software manual template request 2008-04-01 7:03 ` Taco Hoekwater @ 2008-04-01 8:18 ` luigi scarso 0 siblings, 0 replies; 4+ messages in thread From: luigi scarso @ 2008-04-01 8:18 UTC (permalink / raw) To: mailing list for ConTeXt users Until now we have two way to document sources: for *tex file texmfstart texexec --luatex --modules somefile.tex for lua texmfstart texexec --luatex --ctx=x-ldx somefile.lua (both may need some setup to work) Actually this is the quickest way to have the more accurate dev. documentation, and I don't think we need something else . -- luigi it's new . it's powerful . it's luatex . http://www.luatex.org ___________________________________________________________________________________ If your question is of interest to others as well, please add an entry to the Wiki! maillist : ntg-context@ntg.nl / http://www.ntg.nl/mailman/listinfo/ntg-context webpage : http://www.pragma-ade.nl / http://tex.aanhet.net archive : https://foundry.supelec.fr/projects/contextrev/ wiki : http://contextgarden.net ___________________________________________________________________________________ ^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2008-04-01 8:18 UTC | newest] Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed) -- links below jump to the message on this page -- [not found] <mailman.3960.1206900497.4340.ntg-context@ntg.nl> 2008-03-30 23:53 ` Software manual template request Vyatcheslav Yatskovsky 2008-03-31 15:27 ` Aditya Mahajan 2008-04-01 7:03 ` Taco Hoekwater 2008-04-01 8:18 ` luigi scarso
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for NNTP newsgroup(s).