From mboxrd@z Thu Jan 1 00:00:00 1970 X-Msuck: nntp://news.gmane.io/gmane.comp.tex.context/24378 Path: news.gmane.org!not-for-mail From: =?ISO-8859-1?Q?J=E9r=F4me_Laurens?= Newsgroups: gmane.comp.tex.context Subject: Re: What about dynamic documentation? Date: Fri, 16 Dec 2005 08:31:45 +0100 Message-ID: References: <1bbbbe0f95e365f76129a09c0e9f2841@u-bourgogne.fr> <43959947.6050409@elvenkind.com> Reply-To: mailing list for ConTeXt users NNTP-Posting-Host: main.gmane.org Mime-Version: 1.0 (Apple Message framework v623) Content-Type: text/plain; charset=ISO-8859-1; format=flowed Content-Transfer-Encoding: quoted-printable X-Trace: sea.gmane.org 1134718353 11493 80.91.229.2 (16 Dec 2005 07:32:33 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Fri, 16 Dec 2005 07:32:33 +0000 (UTC) Original-X-From: ntg-context-bounces@ntg.nl Fri Dec 16 08:32:32 2005 Return-path: Original-Received: from ronja.vet.uu.nl ([131.211.172.88] helo=ronja.ntg.nl) by ciao.gmane.org with esmtp (Exim 4.43) id 1EnA4I-00047S-1t for gctc-ntg-context-518@m.gmane.org; Fri, 16 Dec 2005 08:31:54 +0100 Original-Received: from localhost (localhost [127.0.0.1]) by ronja.ntg.nl (Postfix) with ESMTP id 8EEC91281A; Fri, 16 Dec 2005 08:31:53 +0100 (CET) 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 19965-04; Fri, 16 Dec 2005 08:31:49 +0100 (CET) Original-Received: from ronja.vet.uu.nl (localhost [127.0.0.1]) by ronja.ntg.nl (Postfix) with ESMTP id 56A7E1280E; Fri, 16 Dec 2005 08:31:49 +0100 (CET) Original-Received: from localhost (localhost [127.0.0.1]) by ronja.ntg.nl (Postfix) with ESMTP id 042E21280E for ; Fri, 16 Dec 2005 08:31:48 +0100 (CET) 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 19939-07 for ; Fri, 16 Dec 2005 08:31:46 +0100 (CET) Original-Received: from haydn2002.u-bourgogne.fr (haydn2002.u-bourgogne.fr [193.50.50.62]) by ronja.ntg.nl (Postfix) with ESMTP id A2DE61278A for ; Fri, 16 Dec 2005 08:31:46 +0100 (CET) Original-Received: from [193.50.49.80] (fermat.u-bourgogne.fr [193.50.49.80]) by haydn2002.u-bourgogne.fr (8.12.11/8.12.11) with ESMTP id jBG7VjBl004560 for ; Fri, 16 Dec 2005 08:31:45 +0100 In-Reply-To: <43959947.6050409@elvenkind.com> Original-To: mailing list for ConTeXt users X-Mailer: Apple Mail (2.623) X-Scanned-By: milter-limit/0.6.61 (haydn2002.u-bourgogne.fr [193.50.50.62]); Fri, 16 Dec 2005 08:31:45 +0100 X-Miltered: at haydn02.u-bourgogne.fr with ID 43A26D61.000 by Joe's j-chkmail (http://j-chkmail.ensmp.fr)! X-Virus-Scanned: amavisd-new at ntg.nl X-BeenThere: ntg-context@ntg.nl X-Mailman-Version: 2.1.5 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:24378 Archived-At: Le 6 d=E9c. 05, =E0 14:59, Taco Hoekwater a =E9crit : > > Hi J=E9r=F4me, > > Before you go any further on this, please check out: > > http://texshow.contextgarden.net > Thanks, here is at least a starting point. However, this seems rather far from the pdf manuals and does not really=20= help a newbie as I am. More precisely: 0 - Category search is missing. It is well known that searching by=20 contents or by command name won't give the proper result if the search=20= request is not well formed a priori. Each command should have a list of associated key words, allowing smart=20= navigation and filtering For example, the sectionning commands (including toc, headers and so=20 on) could be gathered in one big category. 1 - The examples oftenly need output to let the user really understand=20= the effect. Moreover, the information available in the graphical output is more=20 obvious thus more efficient. 2 - Missing code template(s) to paste into the source, copy/paste does=20= noot help when really needed. Of course, I can grab them from=20 contextgarden but it is there both hidden and not well formatted. 3 - The description only concerns the command. Each key should also have its own description. Each predefined value should also have its own description. Then the user interface can provide a layout a la headerdoc or some=20 kind of rollup tooltips. 4 - The data storage model for a size range seems weird. The range 5pt=20= ... 12pt is coded with an ordered list of 3 values "5pt" '..." and=20 "12pt" whereas it means an unordered list of 8 values: "5pt", "6pt",=20 ..., "12pt". This latter data model obviously turns into a pop up=20 button with a list of sizes. 5 - The command variants might need specials (eg \setupinterlinespace). 6 - Sometimes the acceptable values depend on the context (eg arguments=20= of \ref), it means that all the relevant information is not static and=20= the data model should provide some entry points. But at first glance=20 this is a very advanced feature which cost might be unaffordable. Finally, it seems that the underlying data model needs more entropy. A - Comments? > The backbone of texshow-web is a set of XML files that > are already present in the distribution (look for cont-en.xml) > > Cheers, Taco > > J=E9r=F4me Laurens wrote: >> Hi all, >> Is is extremely useful for a newbie as I am to have access to the=20 >> manuals electronically. >> You just open the pdf and search to obtain what you need. >> In general, you end up with a command that you have to copy from the=20= >> pdf then paste to your source file. >> Another solution is to use the text editor completion feature, which=20= >> is available only once you know the correct command name, at least=20 >> the beginning... >> What I am missing is a button in the pdf itself that would=20 >> automagically insert the proper code in my source. >> To be more concrete, here is what could be done (on Mac OS X at=20 >> least). >> 0 - Define a data model. >> 1 - For a reasonnable set of commands, define dedicated GUIs panels. >> 2 - Write a dedicated browser >> As there is a huge amount of "reasonnable" TeX and ConTeXt commands,=20= >> it is -not- reasonnable to fine tune a dedicated GUI for each one. >> But with some perl I think it would be possible to turn for example=20= >> the Quick References Manuals into a set of xml files, each one=20 >> dedicated to its own command. If these files are just HTML forms=20 >> (modulo the proper style and automagic filter), we have the GUI for=20= >> free using a web browser. The communication between the browser and=20= >> the text editor could come from SUBMIT. At least a "copy/paste" phase=20= >> would be enough. >> I already have a custom web browser that can insert some text=20 >> directly in a text editor (iTeXMac) It is based on Mac OS X WebKit. >> Which means that I will incorporate this browser directly into iTM,=20= >> but this not the question so far. >> All this makes points 1 and 2 above acceptable IMHO. >> The problems come from point 0. >> I think a good thing would be to create a subsection of the context=20= >> garden, or another wiki, gathering all the sources. >> The seed would come from the actual documentation with automagic=20 >> scripts and people would update at will. >> Then people would be able to work on a local version using a web=20 >> sucker. >> We can imagine searching facilities as well >> BTW, Sometimes it is necessary to have some output to understand the=20= >> real effect of a command. This should enter into consideration. >> How does it sound? >> _______________________________________________ >> ntg-context mailing list >> ntg-context@ntg.nl >> http://www.ntg.nl/mailman/listinfo/ntg-context > _______________________________________________ > ntg-context mailing list > ntg-context@ntg.nl > http://www.ntg.nl/mailman/listinfo/ntg-context > =20=