From mboxrd@z Thu Jan 1 00:00:00 1970 X-Msuck: nntp://news.gmane.io/gmane.comp.tex.context/81291 Path: news.gmane.org!not-for-mail From: Hans Hagen Newsgroups: gmane.comp.tex.context Subject: Re: man pages for ConTeXt: looking for volunteers Date: Thu, 21 Mar 2013 17:35:02 +0100 Message-ID: <514B36B6.8000807@wxs.nl> References: Reply-To: mailing list for ConTeXt users NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii"; Format="flowed" Content-Transfer-Encoding: 7bit X-Trace: ger.gmane.org 1363883706 21455 80.91.229.3 (21 Mar 2013 16:35:06 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Thu, 21 Mar 2013 16:35:06 +0000 (UTC) To: mailing list for ConTeXt users Original-X-From: ntg-context-bounces@ntg.nl Thu Mar 21 17:35:32 2013 Return-path: Envelope-to: gctc-ntg-context-518@m.gmane.org Original-Received: from balder.ntg.nl ([195.12.62.10]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1UIiSi-0004oA-4A for gctc-ntg-context-518@m.gmane.org; Thu, 21 Mar 2013 17:35:32 +0100 Original-Received: from localhost (localhost [127.0.0.1]) by balder.ntg.nl (Postfix) with ESMTP id 7BFFB101EF; Thu, 21 Mar 2013 17:35:08 +0100 (CET) X-Virus-Scanned: Debian amavisd-new at balder.ntg.nl Original-Received: from balder.ntg.nl ([127.0.0.1]) by localhost (balder.ntg.nl [127.0.0.1]) (amavisd-new, port 10024) with LMTP id N7HOXsveIYMX; Thu, 21 Mar 2013 17:35:06 +0100 (CET) Original-Received: from balder.ntg.nl (localhost [IPv6:::1]) by balder.ntg.nl (Postfix) with ESMTP id 676AB101E7; Thu, 21 Mar 2013 17:35:06 +0100 (CET) Original-Received: from localhost (localhost [127.0.0.1]) by balder.ntg.nl (Postfix) with ESMTP id 8ADD8101E7 for ; Thu, 21 Mar 2013 17:35:04 +0100 (CET) X-Virus-Scanned: Debian amavisd-new at balder.ntg.nl Original-Received: from balder.ntg.nl ([127.0.0.1]) by localhost (balder.ntg.nl [127.0.0.1]) (amavisd-new, port 10024) with LMTP id NQtWv9yPa6EX for ; Thu, 21 Mar 2013 17:35:03 +0100 (CET) Original-Received: from filter2-til.mf.surf.net (filter2-til.mf.surf.net [194.171.167.218]) by balder.ntg.nl (Postfix) with ESMTP id 5BB42101E3 for ; Thu, 21 Mar 2013 17:35:03 +0100 (CET) Original-Received: from smtp.ziggozakelijk.nl (D57D1DA2.static.ziggozakelijk.nl [213.125.29.162]) by filter2-til.mf.surf.net (8.14.3/8.14.3/Debian-9.4) with ESMTP id r2LGZ2gb020235 for ; Thu, 21 Mar 2013 17:35:02 +0100 X-Default-Received-SPF: pass (skip=loggedin (res=PASS)) x-ip-name=10.100.1.100; Original-Received: from [10.100.1.100] (unverified [10.100.1.100]) by pragma-net.nl (SurgeMail 6.1c) with ESMTP (TLS) id 12342-1713362 for multiple; Thu, 21 Mar 2013 17:35:00 +0100 User-Agent: Mozilla/5.0 (Windows NT 6.2; rv:17.0) Gecko/20130307 Thunderbird/17.0.4 In-Reply-To: X-Authenticated-User: hagen@controller-9 X-Bayes-Prob: 0.0001 (Score 0, tokens from: @@RPTN) X-CanIt-Geo: ip=213.125.29.162; country=NL; region=11; city=Den Haag; latitude=52.0833; longitude=4.3000; http://maps.google.com/maps?q=52.0833,4.3000&z=6 X-CanItPRO-Stream: uu:ntg-context@ntg.nl (inherits from uu:default, base:default) X-Canit-Stats-ID: 0TJegz2kE - 989007d7af5e - 20130321 (trained as not-spam) X-Scanned-By: CanIt (www . roaringpenguin . com) on 194.171.167.218 X-BeenThere: ntg-context@ntg.nl X-Mailman-Version: 2.1.14 Precedence: list List-Id: mailing list for ConTeXt users List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: ntg-context-bounces@ntg.nl Original-Sender: ntg-context-bounces@ntg.nl Xref: news.gmane.org gmane.comp.tex.context:81291 Archived-At: On 3/21/2013 3:44 PM, Sietse Brouwer wrote: > Mojca wrote: >> Hans just implemented auto-conversion of help into man pages for the >> lua scripts. > >> but if >> there are any volunteers to help polishing out and provide either >> more extensive descriptions, examples, ... or overall improvements, > > An excellent idea. To cut the work into bite-sized pieces: over the > coming weeks, I will post these files on the list one by one and > solicit specific improvements / check for befuddlement. First, though, > I have some questions: > > 1. I assume the man pages are created from the XML files, and we > should edit the XML files -- is this correct? no, they are (since yesterday) generated from the scripts themselves: mtxrun --script fonts --exporthelp=man|xml|html|all > 2. Is the XML-to-man script included in the distribution? That would > (a) make it easier to check the result of an edit, and (b) make it > easier to find the answer to question 3 for myself. ;-) they are in the scripts ... the helpinfo is a xml blob in the script and that one is the base for help info ... so, any 'fixes' have to go in there > 3. Is there a key to specify bold and italic in the XML? (\fB...\fP > and \fI...\fP in the man page.) Or, if you want to keep it semantic: > are (\fB) and (\fI, or also \fB) supported? no, we keep it simple ... all we can do is make the to-man converter better if needed > 4. I really really like the groupings of the flags in > the XML files. This useful grouping doesn't show up in the man pages, > however. Perhaps the end of a subcategory could correspond to i must say that i have no clue what the man pages look like but suggestions are welcome > .TP > ---- > > in the man pages? just tell me what to do > 5. Lastly, I think it would be good to include a standard SEE ALSO > block at the end of each man page, to list all the scripts we have man > pages for. This will make it easier for users to discover the man > pages. Example below. If such a block could be supported, I would be > happy to write it. > > > > > > sure, we can add stuff Hans ----------------------------------------------------------------- Hans Hagen | PRAGMA ADE Ridderstraat 27 | 8061 GH Hasselt | The Netherlands tel: 038 477 53 69 | voip: 087 875 68 74 | www.pragma-ade.com | www.pragma-pod.nl ----------------------------------------------------------------- ___________________________________________________________________________________ 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 : http://foundry.supelec.fr/projects/contextrev/ wiki : http://contextgarden.net ___________________________________________________________________________________