From mboxrd@z Thu Jan 1 00:00:00 1970 X-Msuck: nntp://news.gmane.io/gmane.comp.tex.context/39767 Path: news.gmane.org!not-for-mail From: Taco Hoekwater Newsgroups: gmane.comp.tex.context Subject: Re: Software manual template request Date: Tue, 01 Apr 2008 09:03:15 +0200 Message-ID: <47F1DE33.5030201@elvenkind.com> References: <1786062481.20080331025335@gmail.com> Reply-To: mailing list for ConTeXt users NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Trace: ger.gmane.org 1207033526 3790 80.91.229.12 (1 Apr 2008 07:05:26 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Tue, 1 Apr 2008 07:05:26 +0000 (UTC) Cc: Yatskovsky To: mailing list for ConTeXt users Original-X-From: ntg-context-bounces@ntg.nl Tue Apr 01 09:05:56 2008 Return-path: Envelope-to: gctc-ntg-context-518@m.gmane.org Original-Received: from ronja.vet.uu.nl ([131.211.172.88] helo=ronja.ntg.nl) by lo.gmane.org with esmtp (Exim 4.50) id 1JgaYS-0001lG-QI for gctc-ntg-context-518@m.gmane.org; Tue, 01 Apr 2008 09:05:38 +0200 Original-Received: from localhost (localhost [127.0.0.1]) by ronja.ntg.nl (Postfix) with ESMTP id E10571FB95; Tue, 1 Apr 2008 09:04:33 +0200 (CEST) Original-Received: from ronja.ntg.nl ([127.0.0.1]) by localhost (smtp.ntg.nl [127.0.0.1]) (amavisd-new, port 10024) with LMTP id 26793-02; Tue, 1 Apr 2008 09:03:53 +0200 (CEST) Original-Received: from ronja.vet.uu.nl (localhost [127.0.0.1]) by ronja.ntg.nl (Postfix) with ESMTP id 9FD061FB57; Tue, 1 Apr 2008 09:03:53 +0200 (CEST) Original-Received: from localhost (localhost [127.0.0.1]) by ronja.ntg.nl (Postfix) with ESMTP id 2A6621FB38 for ; Tue, 1 Apr 2008 09:03:52 +0200 (CEST) Original-Received: from ronja.ntg.nl ([127.0.0.1]) by localhost (smtp.ntg.nl [127.0.0.1]) (amavisd-new, port 10024) with LMTP id 27163-01 for ; Tue, 1 Apr 2008 09:03:17 +0200 (CEST) Original-Received: from smtp-vbr8.xs4all.nl (smtp-vbr8.xs4all.nl [194.109.24.28]) by ronja.ntg.nl (Postfix) with ESMTP id 5B8941FADF for ; Tue, 1 Apr 2008 09:03:17 +0200 (CEST) Original-Received: from [10.10.0.6] (boo.demon.nl [82.161.175.147]) (authenticated bits=0) by smtp-vbr8.xs4all.nl (8.13.8/8.13.8) with ESMTP id m3173Fp8063451; Tue, 1 Apr 2008 09:03:16 +0200 (CEST) (envelope-from taco@elvenkind.com) User-Agent: Thunderbird 1.5.0.10 (X11/20070305) In-Reply-To: X-Virus-Scanned: by XS4ALL Virus Scanner X-Virus-Scanned: amavisd-new at ntg.nl X-BeenThere: ntg-context@ntg.nl X-Mailman-Version: 2.1.9 Precedence: list List-Id: mailing list for ConTeXt users List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: ntg-context-bounces@ntg.nl Errors-To: ntg-context-bounces@ntg.nl X-Virus-Scanned: amavisd-new at ntg.nl Xref: news.gmane.org gmane.comp.tex.context:39767 Archived-At: 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 ___________________________________________________________________________________