From blacherez@free.fr Wed Oct 4 14:54:52 2000 From: blacherez@free.fr (Benoit Lacherez) Date: Wed, 04 Oct 2000 15:54:52 +0200 Subject: [Doc-SIG] Fench Translation of Python Documentation Message-ID: <39DB36AC.E6FB3655@free.fr> Hello, I'm happy to announce that the website of the project for a French translation of Python Documentation is online on http://pythonfr.free.fr/ Bye -- Benoit Lacherez Libourne - France Projet de traduction de la documentation de Python: http://pythonfr.free.fr/ From fdrake@beopen.com Mon Oct 9 21:55:58 2000 From: fdrake@beopen.com (Fred L. Drake, Jr.) Date: Mon, 9 Oct 2000 16:55:58 -0400 (EDT) Subject: [Doc-SIG] Re: [XML-SIG] documentation In-Reply-To: <200010092050.WAA01029@loewis.home.cs.tu-berlin.de> References: <14791.56264.4267.959626@cj42289-a.reston1.va.home.com> <200010092050.WAA01029@loewis.home.cs.tu-berlin.de> Message-ID: <14818.12510.721242.680124@cj42289-a.reston1.va.home.com> [CC'd to the Doc-SIG as well.] Martin v. Loewis writes: > I'm currently working on the major body of the SAX interfaces, mostly > by extracting the doc strings into TeX. Great, since I was planning to work on them this week! I'll merge some of your xml.dom documentation with some that Paul sent directly to me, and get that in later this week. (Hopefully by Wed.) I've told Paul that I'd really like to have everything that will be in the final release in by Thursday, and will have a doc freeze on Friday. -Fred -- Fred L. Drake, Jr. BeOpen PythonLabs Team Member From Mike Miller" >Martin v. Loewis writes: > > I'm currently working on the major body of the SAX interfaces, mostly > > by extracting the doc strings into TeX. > > Great, since I was planning to work on them this week! I'll merge >some of your xml.dom documentation with some that Paul sent directly >to me, and get that in later this week. (Hopefully by Wed.) > I've told Paul that I'd really like to have everything that will be >in the final release in by Thursday, and will have a doc freeze on >Friday. Stupid question time. This isn't an automated process via pythondoc or happydoc? - Mike From fdrake@beopen.com Tue Oct 10 20:38:44 2000 From: fdrake@beopen.com (Fred L. Drake, Jr.) Date: Tue, 10 Oct 2000 15:38:44 -0400 (EDT) Subject: [Doc-SIG] library reference contents In-Reply-To: References: Message-ID: <14819.28740.66592.728420@cj42289-a.reston1.va.home.com> Ka-Ping Yee writes: > The contents page of the Library Reference has a few warts: Ok, I finally re-discovered this message and have fixed the problems you've identified, with the exception of... > - Description of 4.3 "regex" should probably say "old" or > "deprecated". this one! It doesn't seem useful since the docs for this module are no longer included in the formatted manuals. Thanks for sending the comments, and sorry for letting them sit idle for so long! -Fred -- Fred L. Drake, Jr. BeOpen PythonLabs Team Member From fdrake@beopen.com Tue Oct 10 21:22:36 2000 From: fdrake@beopen.com (Fred L. Drake, Jr.) Date: Tue, 10 Oct 2000 16:22:36 -0400 (EDT) Subject: [Doc-SIG] Nit in "urllib" library documentation In-Reply-To: References: Message-ID: <14819.31372.262366.515728@cj42289-a.reston1.va.home.com> [Still digging through old email...] Ka-Ping Yee writes: > The last chunk of the section on "urlopen" appears to be > repeated twice: Fixed in CVS, thanks! > Looks like some sort of TeX conversion problem -- the > "quote" and "unquote" sections don't display the tilde > characters as intended, so they look puzzling: This one was fixed in the interim -- gosh, my inbox is deep! ;) -Fred -- Fred L. Drake, Jr. BeOpen PythonLabs Team Member From dyoo@hkn.eecs.berkeley.edu Wed Oct 11 02:58:25 2000 From: dyoo@hkn.eecs.berkeley.edu (Daniel Yoo) Date: Tue, 10 Oct 2000 18:58:25 -0700 (PDT) Subject: [Doc-SIG] DocBook introduction? Message-ID: A while ago, I made a random comment about wanting to write a "Best Hits of tutor@python.org" page. Now that I think about it, that sounds like a fun and useful project. I can't have too much fun, so I'd like to use this as an excuse to learn DocBook. Hmm... is there a gentle introduction to DocBook? The Definitive Guide looks like rough going, although I'm sure I'll figure things out with time. If you have any suggestions on this "Best Hits", I'd be glad to hear them. Thanks! From Marc.Poinot@onera.fr Wed Oct 11 08:46:03 2000 From: Marc.Poinot@onera.fr (Marc Poinot) Date: Wed, 11 Oct 2000 09:46:03 +0200 Subject: [Doc-SIG] Re: [XML-SIG] documentation References: <14791.56264.4267.959626@cj42289-a.reston1.va.home.com> <200010092050.WAA01029@loewis.home.cs.tu-berlin.de> <14818.12510.721242.680124@cj42289-a.reston1.va.home.com> Message-ID: <39E41ABB.8CEB37B6@onera.fr> Hi all, Now Python has unicode strings ;) Did you plan something for non-english documentation support in your doc production process. I mean, 98% of the doc process is unchanged, the files are duplicated and some extra LaTeX packages are required. Is there already something planned, did you have an idea ? - put specific source directories with traduction-dependant parts ? (this should only affect *.tex in each lib/api/ext... directories and perhaps a traduction-dependant .tex specified with a make variable ?) - Let the source tree unchanged, make separate CVS branches for traduction variant files ? I have no other idea, but the first one looks far better than the second one. Marcvs [alias By the way, why didn't you put $Id$ CVS keywords in your source files ?] From Marc.Poinot@onera.fr Wed Oct 11 08:53:38 2000 From: Marc.Poinot@onera.fr (Marc Poinot) Date: Wed, 11 Oct 2000 09:53:38 +0200 Subject: [Doc-SIG] Documentation translation References: <14791.56264.4267.959626@cj42289-a.reston1.va.home.com> <200010092050.WAA01029@loewis.home.cs.tu-berlin.de> <14818.12510.721242.680124@cj42289-a.reston1.va.home.com> <39E41ABB.8CEB37B6@onera.fr> Message-ID: <39E41C82.3D6E3C3F@onera.fr> > Hi all, > > Now Python has unicode strings ;) > > Did you plan something for non-english documentation support > in your doc production process. I mean, 98% of the doc process > is unchanged, the files are duplicated and some extra LaTeX > packages are required. > > Is there already something planned, did you have an idea ? > > - put specific source directories with traduction-dependant parts ? > (this should only affect *.tex in each lib/api/ext... directories > and perhaps a traduction-dependant .tex specified with a make > variable ?) > > - Let the source tree unchanged, make separate CVS branches for > traduction variant files ? > > I have no other idea, but the first one looks far better than the second one. > > Marcvs [alias By the way, why didn't you put $Id$ CVS keywords in your > source files ?] Sorry for this previous email subject, I have made a reply, subject and XML thread will be polluted :( Marcvs [alias People should read translation instead of traduction in my email] From dyoo@hkn.eecs.berkeley.edu Fri Oct 13 02:09:24 2000 From: dyoo@hkn.eecs.berkeley.edu (Daniel Yoo) Date: Thu, 12 Oct 2000 18:09:24 -0700 (PDT) Subject: [Doc-SIG] DocBook introduction? In-Reply-To: <200010121759.KAA23457@plxw0015.pdx.intel.com> Message-ID: On Thu, 12 Oct 2000, Mike Miller wrote: > > >Hmm... is there a gentle introduction to DocBook? The Definitive Guide > >looks like rough going, although I'm sure I'll figure things out with > >time. > > Did you get any responses? I'm using DocBook some now but it's pretty > shakey. 'The Definitive Guide' is rough, and I'd like to supplement my > knowledge from some better sources. Actually, I did receive a few responses. The Gnome project has quite a few good links to DocBook stuff: http://developer.gnome.org/projects/gdp/handbook/gdp-handbook/ From fdrake@acm.org Wed Oct 18 22:40:10 2000 From: fdrake@acm.org (Fred L. Drake, Jr.) Date: Wed, 18 Oct 2000 17:40:10 -0400 (EDT) Subject: [Doc-SIG] Too many files! Message-ID: <14830.6330.940655.151776@cj42289-a.reston1.va.home.com> The Python 2.0 documentation was released as 18(!) different files. There are three different formatted versions (HTML, PDF, PostScript), with two paper sizes for each of the later, and a documentation source package. For each of these variants, three different archive formats are provided. At some point, I'd like to provide HTML Help as well. This has been provided by a volunteer in the past, and may be again (otherwise I get to do it). That's another file (making 19). Does anyone mind if I remove any of these from future releases? Which ones? The .tar.bz2 files are the best compressed, and there are reports that tools are available to handle these on Windows. Would anyone object if I removed the .tgz and .zip archives? -Fred -- Fred L. Drake, Jr. PythonLabs Team Member From Juergen Hermann" Message-ID: On Wed, 18 Oct 2000 17:40:10 -0400 (EDT), Fred L. Drake, Jr. wrote: > Does anyone mind if I remove any of these from future releases? >Which ones? The .tar.bz2 files are the best compressed, and there are >reports that tools are available to handle these on Windows. Would >anyone object if I removed the .tgz and .zip archives? I'd say we could at least remove the .tgz in favour of the .bz2 ones (both are "unix formats"). bzip2 _IS_ available for Win32, but if WinZip does not handle bz2, I'd say many users will be unable to handle = it. [I do not use WinZip, so don't ask me if it supports bz2. :) ] BTW, I just downloaded the M$ html help workshop and will give the .CHM = format a try. You have better things to do. ;) Bye, J=FCrgen From robin@alldunn.com Wed Oct 18 23:16:50 2000 From: robin@alldunn.com (Robin Dunn) Date: Wed, 18 Oct 2000 15:16:50 -0700 Subject: [Doc-SIG] Too many files! References: <14830.6330.940655.151776@cj42289-a.reston1.va.home.com> Message-ID: <01e501c03951$1d9174e0$3225d2d1@ARES> > At some point, I'd like to provide HTML Help as well. This has been > provided by a volunteer in the past, and may be again (otherwise I get > to do it). That's another file (making 19). I've already done it. It's at http://alldunn.com/python/py2docs.zip -- Robin Dunn Software Craftsman robin@AllDunn.com http://wxPython.org Java give you jitters? http://wxPROs.com Relax with wxPython! From RobinFriedrich@pdq.net Thu Oct 19 00:15:36 2000 From: RobinFriedrich@pdq.net (Robin Friedrich) Date: Wed, 18 Oct 2000 18:15:36 -0500 Subject: [Doc-SIG] Too many files! In-Reply-To: <14830.6330.940655.151776@cj42289-a.reston1.va.home.com> Message-ID: on 10/18/00 4:40 PM, Fred L. Drake, Jr. at fdrake@acm.org wrote: ..... > Would anyone object if I removed the .tgz and .zip archives? I would. If you're on a platform without the latest GNU tools then BZ2 is alien and unusable. Why can't these formats be automatically generated? Fred will have to be more clear as to what exactly is complicated about this. If you do want to get an indication of what format is most useful just look at the download metrics from your server for the respective formats. That would be interesting. -Robin From fdrake@acm.org Thu Oct 19 02:40:12 2000 From: fdrake@acm.org (Fred L. Drake, Jr.) Date: Wed, 18 Oct 2000 21:40:12 -0400 (EDT) Subject: [Doc-SIG] Too many files! In-Reply-To: References: <14830.6330.940655.151776@cj42289-a.reston1.va.home.com> Message-ID: <14830.20732.284083.700757@cj42289-a.reston1.va.home.com> Robin Friedrich writes: > I would. If you're on a platform without the latest GNU tools then BZ2 is > alien and unusable. Why can't these formats be automatically generated? > Fred will have to be more clear as to what exactly is complicated about > this. If you do want to get an indication of what format is most useful > just look at the download metrics from your server for the respective > formats. That would be interesting. The archives are all built automatically from the Makefile, it's just a lot of files. I'll see if I can get download statistics for these. -Fred -- Fred L. Drake, Jr. PythonLabs Team Member From tim_one@email.msn.com Thu Oct 19 05:43:04 2000 From: tim_one@email.msn.com (Tim Peters) Date: Thu, 19 Oct 2000 00:43:04 -0400 Subject: [Doc-SIG] Too many files! In-Reply-To: <14830.20732.284083.700757@cj42289-a.reston1.va.home.com> Message-ID: [Fred] > The archives are all built automatically from the Makefile, it's > just a lot of files. I'll see if I can get download statistics for > these. Prior to 2.0 final, the HTML zip and tgz files were most popular, followed by PDF zip and tgz. There were relatively few downloads of bz2 format doc files, and the postscript docs don't show up at all in the summary download stats for September or October. In other words, take your prejudices and turn them inside out <0.9 wink>. From uche.ogbuji@fourthought.com Sun Oct 29 19:16:53 2000 From: uche.ogbuji@fourthought.com (uche.ogbuji@fourthought.com) Date: Sun, 29 Oct 2000 12:16:53 -0700 Subject: [Doc-SIG] Error in pyexpat docs Message-ID: <200010291916.MAA16420@localhost.localdomain> An excerpt from the Python 2.0 docs for pyexpat: """ ParseFile (file) Parse XML data reading from the object file. file only needs to provide the read(nbytes) method, returning the empty string when there's no more data. [snip] The following attributes contain values relating to the most recent error encountered by an xmlparser object, and will only have correct values once a call to Parse() or ParseFile() has raised a xml.parsers.expat.error exception. ErrorByteIndex Byte index at which an error occurred. [etc.] """ The wrong, "xml.parsers.expat" is the first indicator that there might be a problem, yet I took the docs at their word and wrapped the call to ParseFile in a blanket try/except, only to find that no exception of any sort is ever raised by ParseFile. It turns out that ParseFile actually returns 0 on error, returning 1 otherwise. The first matter is that the code and the docs need to be reconciled. However, I would _much_ rather prefer that things were as in the docs. I think ParseFile should raise an exception rather than return an error flag. Interestingly enough, this is the same argument I had with a colleague just last week. -- Uche Ogbuji Principal Consultant uche.ogbuji@fourthought.com +1 303 583 9900 x 101 Fourthought, Inc. http://Fourthought.com 4735 East Walnut St, Ste. C, Boulder, CO 80301-2537, USA Software-engineering, knowledge-management, XML, CORBA, Linux, Python