Mailman 3 January 1999 - Doc-SIG

pythondoc on ScientificTools
by Berthold Höllmann Jan. 22, 1999

Jan. 22, 1999

Hello, I tried to run pythondoc on all the modules in the package, but I get an error in all the modules using "indexing.py" and the indexing module itself. I get the following messages: --- snip --- Traceback (innermost last): File "<stdin>", line 37, in ? File "/usr/local/lib/python1.5/site-packages/pythondoc/pythondoc.py", line 256, in generate_pages docobject = docobjects.create_docobject(object) File "/usr/local/lib/python1.5/site-packages/pythondoc/docobjects.py", line 479, in create_docobject object = _class_map[type(pyobject)](pyobject) #, name) File "/usr/local/lib/python1.5/site-packages/pythondoc/docobjects.py", line 211, in __init__ Composite.__init__(self, object, name) File "/usr/local/lib/python1.5/site-packages/pythondoc/docobjects.py", line 154, in __init__ Object.__init__(self, object, name) File "/usr/local/lib/python1.5/site-packages/pythondoc/docobjects.py", line 40, in __init__ self.subobjects() File "/usr/local/lib/python1.5/site-packages/pythondoc/docobjects.py", line 95, in subobjects self.__subobjects = self.get_subobjects() File "/usr/local/lib/python1.5/site-packages/pythondoc/docobjects.py", line 175, in get_subobjects subobj = self.make_childobject(key, object) File "/usr/local/lib/python1.5/site-packages/pythondoc/docobjects.py", line 271, in make_childobject return Composite.make_childobject(self, name, object) File "/usr/local/lib/python1.5/site-packages/pythondoc/docobjects.py", line 165, in make_childobject return create_docobject(object, name) File "/usr/local/lib/python1.5/site-packages/pythondoc/docobjects.py", line 479, in create_docobject object = _class_map[type(pyobject)](pyobject) #, name) File "/usr/local/lib/python1.5/site-packages/pythondoc/docobjects.py", line 154, in __init__ Object.__init__(self, object, name) File "/usr/local/lib/python1.5/site-packages/pythondoc/docobjects.py", line 40, in __init__ self.subobjects() File "/usr/local/lib/python1.5/site-packages/pythondoc/docobjects.py", line 95, in subobjects self.__subobjects = self.get_subobjects() File "/usr/local/lib/python1.5/site-packages/pythondoc/docobjects.py", line 175, in get_subobjects subobj = self.make_childobject(key, object) File "/usr/local/lib/python1.5/site-packages/pythondoc/docobjects.py", line 165, in make_childobject return create_docobject(object, name) File "/usr/local/lib/python1.5/site-packages/pythondoc/docobjects.py", line 475, in create_docobject if type(pobject) == types.ModuleType and \ AttributeError: __file__ --- snip --- --- snip --- >python Python 1.5.2b1 (#8, Jan 6 1999, 11:22:29) [GCC egcs-2.91.60 19981201 (e on linux2 Copyright 1991-1995 Stichting Mathematisch Centrum, Amsterdam >>> import indexing >>> indexing.__file__ '/usr/local/lib/python1.5/site-packages/ScientificPython/indexing.pyc' >>> --- snip --- Any idea what happens here? Cheers Berthold -- se6y095(a)public.uni-hamburg.de It is unlawful to use this email address for unsolicited ads (USC Title 47 Sec.227). I will assess a US$500 charge for reviewing and deleting each unsolicited ad.

1 0

Conversion of documentation to SGML
by Fred L. Drake Jan. 18, 1999

Jan. 18, 1999

As has been promised for quite a long time now, I've been working on tools to convert the current LaTeX markup of the standard documentation to SGML. During 1998, a lot of effort went into making the LaTeX markup more rational, and I think the effort has paid off twofold: 1) it's easier to make intelligent markup decisions for the current LaTeX documents, and make the HTML output more reasonable, and 2) it's easier to parse with Python! In fact, the current documents are sufficiently easy to parse with regular expressions that I've written a script that reads the LaTeX documents and produces a stream of ESIS events similar to what's produced by powerful SGML parsers. With this, the documents can be loaded into DOM tree using the XML-SIG's package. Another script does this and performs a number of transformations, producing another ESIS event stream which can then be converted to either SGML or XML. The conversion produces something not substantially different from the current structure, but with a few changes. Tables are almost compliant with the OASIS Exchange model; the differences can be addressed with a little more work. There are a probably a few other things that should be changed before freezing the structure enough to actually write down the DTD. The index entries are something I haven't addressed at all, and will need a bit more work, but I'm going to hold off on that for now. My intention is that the LaTeX-->SGML conversion will be automated at least to the 95% level, to allow further changes to the DTD until we're ready to go production with it, as well as to ease the transition for authors of other Python manuals and HOWTOs. For the moment, I'm interested in determining what structural changes should be made to the SGML, whether there's enough information encoded in the markup, what allowance needs to be made for enhanced versions of the DTD (once defined) to avoid having to actually change the document files, and what it will take to produce formatted output. In general, I'd like people who might either author documentation in the future or help with developing the formatting processes to take a look at it and provide input. At this point, there is no process that *uses* the documents in their SGML form; I'm interested in help on this. I think there must be at least a PDF generator and an HTML generator for this to even go into a "Beta" stage (providing it on python.org, etc.). This is my next task, and I'd really appreciate a bit of help. I don't know DSSSL yet, so that'll be my next project. If anyone would like to work on either the print or online stylesheet, I'd really appreciate the help. A package containing the SGML and updated tools to do the conversion (substantially updated since the recent documentation release) is available at ftp://ftp.python.org/pub/python/doc/1.5.2/test. Please take a look at it and let me know what you think. -Fred -- Fred L. Drake, Jr. <fdrake(a)acm.org> Corporation for National Research Initiatives 1895 Preston White Dr. Reston, VA 20191

2 2

Relative sectioning, and more tools for documentation
by Manuel Gutierrez Algaba Jan. 16, 1999

Jan. 16, 1999

TeXtoolspro This is a small set of utility very useful for doing documenation in LaTeX . It's intended mainly for programmers. It's composed of : boxerer.py: - It creates structured boxes, one inside another so the structure of data and functions can be easily shown -It creates black boxes ( diagrams who show the inputs,outputs and functions of a module or a function). sectioner.py : - This is a front-end filter of LaTeX-modified ( very little ) code, so you can write sections in a relative way ( not \section, but \+, \4- , \n , and so on ). This is in fact a really new thing in LaTeX(AFAIK) and quite worthy. miarticle.cls: This is a LaTeX class that allows up to 14 levels of nesting, needed for doing documentations ( usually 7 levels are not enough). All that in: http://www.ctv.es/USERS/irmina/texpython.htm Perhaps, some of the XML boys might want to have a look at sectioner.py. It's by far the most interesting thing, although it's quite simple. Regards/Saludos Manolo ------------- My addresses / mis direcciones: www.ctv.es/USERS/irmina ---> lritaunas peki project/proyecto in python www.ctv.es/USERS/irmina/pyttex.htm ---> page of spanish users of latex / pagina de usuarios en espanyol de latex www.ctv.es/USERS/irmina/texpython.htm --> page of drawing utility for tex / pagina de utilidad de dibujo para Latex www.ctv.es/USERS/irmina/cruo/cruo.html --> +Wordland ( fun and education), Crucilandia (sopas de letras) "...abandoneis el campo y vuestras casas y acudais a defender el mar y la ciudad...no lamentarse por las casas o la tierra, sino por las vidas humanas, pues aquellas no nos proporcionan hombres, sino los hombres aquellas "-Pericles

1 0

Crosswords for python
by Manuel Gutierrez Algaba Jan. 7, 1999

Jan. 7, 1999

Sometime ago , we were discussing about an apropos utility. Finally, nobody had the time/interest enough for doing it ( me included ), except Fred that offered himself. Well, this Christmas I was learning Java(script), in fact I haven't learned too much, because at the few days I discovered a java games site. Instantly I started to hack, and ... I realised that the entries of crosswords are semic descriptions of concepts. I mean, that crosswords are useful to do apropos utilities, and what's more important. People will have time to play and to send ( increase the database ) crosswords, or that's what I think. So: http://www.ctv.es/USERS/irmina/cruo/cruopyt.htm I've already done one. I intend to collect information about the gimp, linux,... with this method. I intend this to be announced to the main list. Regards/Saludos Manolo

1 0

consdiag 1.0 released
by Manuel Gutierrez Algaba Jan. 4, 1999

Jan. 4, 1999

At last, I've finished one of my (sub)projects: "consdiag", yeah, that utility for making Rumbaugh OO boxes easily. I'll be greatly honoured if you include this piece of software in your contributed ftp dirs, and if you announce to the python community. Although it's not a general purpose/use utility, every student that has to do a practice/program in C/C++/Java/Python and decides to use LaTeX, will be very happy of having such utility in one corner of his hard disk. You'll find in: http://www.ctv.es/USERS/irmina/texpython.htm Besides, this utility is so simple to use that brings another questions: "To draw all the library of python " This is just to take all the libraries, all the classes, all the attributes and functions and with this utility generate the drawings, it's more a matter of time than anything else. I imagine a wall full of pieces of paper with the classes of the library. To find a determined function would be as easy as to look at the walls ( something that people does very often ). If you think it's worthy, tell me ! It's reasonably easy ! consdiag is limited (it can't do very, very complex drawings ), but even so , the results can be interesting. I got more news about doc-related-stuff, but,.... next week! Happy new year! ;) Regards/Saludos Manolo ------------- My addresses / mis direcciones: www.ctv.es/USERS/irmina ---> lritaunas peki project/proyecto in python www.ctv.es/USERS/irmina/pyttex.htm ---> page of spanish users of latex / pagina de usuarios en espanyol de latex www.ctv.es/USERS/irmina/texpython.htm --> page of drawing utility for tex / pagina de utilidad de dibujo para Latex www.ctv.es/USERS/irmina/croscruci.htm --> +Wordland ( fun and education), Crucilandia (sopas de letras) "...abandoneis el campo y vuestras casas y acudais a defender el mar y la ciudad...no lamentarse por las casas o la tierra, sino por las vidas humanas, pues aquellas no nos proporcionan hombres, sino los hombres aquellas "-Pericles

2 1