From fdrake@acm.org Mon Dec 3 21:25:48 2001 From: fdrake@acm.org (Fred L. Drake) Date: Mon, 3 Dec 2001 16:25:48 -0500 (EST) Subject: [Doc-SIG] [development doc updates] Message-ID: <20011203212548.5590C28698@cj42289-a.reston1.va.home.com> The development version of the documentation has been updated: http://python.sourceforge.net/devel-docs/ Added documentation for the ScrolledText module. From fdrake@acm.org Tue Dec 4 17:03:32 2001 From: fdrake@acm.org (Fred L. Drake) Date: Tue, 4 Dec 2001 12:03:32 -0500 (EST) Subject: [Doc-SIG] [development doc updates] Message-ID: <20011204170332.0B76A28698@beowolf.digicool.com> The development version of the documentation has been updated: http://python.sourceforge.net/devel-docs/ The indexes are now working for the Python/C API manual and the Reference Manual. From fdrake@acm.org Wed Dec 5 05:49:19 2001 From: fdrake@acm.org (Fred L. Drake) Date: Wed, 5 Dec 2001 00:49:19 -0500 (EST) Subject: [Doc-SIG] [development doc updates] Message-ID: <20011205054919.A1E7B28698@beowolf.digicool.com> The development version of the documentation has been updated: http://python.sourceforge.net/devel-docs/ A wide variety of minor additions and clarifications. From Keila - Curitiba" Ol=E1! Veja meu site pessoal. Basta clicar no endere=E7o abaixo. GARANTO SER SUI-GENERIS - CLIQUE ABAIXO: http://www.pastorinha.atfreeweb.com Mais de 162.000 internautas visitaram a PG., existe 6 =C1lbuns: Se voc=EA quiser, por favor, indique minha Home Page, a outros Internautas. Mais detalhes, se comunique, passe um e-mail, que responderei brevemente. Dentro da Home Page, ao lado das fotos, voc=EA poder=E1 saber muito mais sobre mim! Obrigada. e-mail: arosadesaron@zipmail.com.br Beijos:- Keila - Curitiba - Pr - Podes falar comigo, direto dela. Brevemente uma Carta Aberta. - Embora derrubem a p=E1gina eu a subo em 3 horas novamente. "Esta mensagem =E9 enviada com a complac=EAncia da nova legisla=E7=E3o=20 sobre correio eletr=F4nico, Se=E7=E3o 301, Par=E1grafo (a) (2) (c) Decreto S. 1= 618, T=EDtulo Terceiro aprovado pelo "105=BA Congresso Base das Normativas Internacionais sobre o SPAM". Este E-mail n=E3o poder=E1 ser considerado SPAM quando incluir uma forma de ser removido. Para ser removido de futuros correios, simplesmente responda indicando no Assunto: REMOVER" From fdrake@acm.org Sat Dec 8 06:30:53 2001 From: fdrake@acm.org (Fred L. Drake) Date: Sat, 8 Dec 2001 01:30:53 -0500 (EST) Subject: [Doc-SIG] [development doc updates] Message-ID: <20011208063053.2367D286BC@beowolf.digicool.com> The development version of the documentation has been updated: http://python.sourceforge.net/devel-docs/ Another day of updates; various fixes and clarifications. From fdrake@acm.org Tue Dec 11 22:16:01 2001 From: fdrake@acm.org (Fred L. Drake) Date: Tue, 11 Dec 2001 17:16:01 -0500 (EST) Subject: [Doc-SIG] [development doc updates] Message-ID: <20011211221601.DB780286BC@cj42289-a.reston1.va.home.com> The development version of the documentation has been updated: http://python.sourceforge.net/devel-docs/ Many various updates, including documentation for generators and extended call syntax. From ngps@netmemetic.com Thu Dec 13 16:00:40 2001 From: ngps@netmemetic.com (Ng Pheng Siong) Date: Fri, 14 Dec 2001 00:00:40 +0800 Subject: [Doc-SIG] Docbook "user exit"? Message-ID: <20011214000040.A985@madcap.netmemetic.com> Hi, I'm writing my second Python programming HOWTO in Docbook. Naturally, my Docbook file contains fragments of Python code. There exist neat Python code colourisers and I want to use one of these on my docu to produce prettier output. Is there a "user exit" mechanism in Docbook to allow me to call said code colouriser? I'm invoking Jade thusly: jade -V nochunks -d /.../html/docbook.dsl f.docbook > f.html TIA. Cheers. (I'm not subscribed to either list. Please cc replies. Thanks.) -- Ng Pheng Siong * http://www.netmemetic.com From fdrake@acm.org Thu Dec 13 19:08:41 2001 From: fdrake@acm.org (Fred L. Drake) Date: Thu, 13 Dec 2001 14:08:41 -0500 (EST) Subject: [Doc-SIG] [development doc updates] Message-ID: <20011213190841.2EF95286BC@cj42289-a.reston1.va.home.com> The development version of the documentation has been updated: http://python.sourceforge.net/devel-docs/ Updated the build instructions for extensions on Windows. From fdrake@acm.org Thu Dec 13 20:02:45 2001 From: fdrake@acm.org (Fred L. Drake, Jr.) Date: Thu, 13 Dec 2001 15:02:45 -0500 Subject: [Doc-SIG] Doc/ tree closed for release Message-ID: <15385.2405.102160.574585@grendel.zope.com> The Doc/ tree is now closed so I can prepare for the release. -Fred -- Fred L. Drake, Jr. PythonLabs at Zope Corporation From Juergen Hermann" Message-ID: On Fri, 14 Dec 2001 00:00:40 +0800, Ng Pheng Siong wrote: >Is there a "user exit" mechanism in Docbook to allow me to call said co= de >colouriser? I could rewrite mine to emit docbook (it's a thing I'll need anyway), so= you could pre-process sources and then include them as entities. Ciao, J=FCrgen From fdrake@acm.org Fri Dec 14 04:25:14 2001 From: fdrake@acm.org (Fred L. Drake) Date: Thu, 13 Dec 2001 23:25:14 -0500 (EST) Subject: [Doc-SIG] [development doc updates] Message-ID: <20011214042514.2204B286BC@beowolf.digicool.com> The development version of the documentation has been updated: http://python.sourceforge.net/devel-docs/ Final 2.2c1 documentation. From ydirson@fr.alcove.com Fri Dec 14 13:50:57 2001 From: ydirson@fr.alcove.com (Yann Dirson) Date: Fri, 14 Dec 2001 14:50:57 +0100 Subject: DOCBOOK: Re: [Doc-SIG] Docbook "user exit"? In-Reply-To: References: <20011214000040.A985@madcap.netmemetic.com> Message-ID: <20011214145057.C25612@kasba.alcove-fr> On Fri, Dec 14, 2001 at 12:07:18AM +0100, Juergen Hermann wrote: > On Fri, 14 Dec 2001 00:00:40 +0800, Ng Pheng Siong wrote: > > >Is there a "user exit" mechanism in Docbook to allow me to call said code > >colouriser? > > I could rewrite mine to emit docbook (it's a thing I'll need anyway), so you > could pre-process sources and then include them as entities. Sorry to ask - what's yours ? Regards, -- Yann Dirson http://www.alcove.com/ Free-Software Engineer Ingénieur Logiciel-Libre Free-Software time manager Responsable du temps Informatique-Libre Debian GNU/Linux developper From Juergen Hermann" Message-ID: On Fri, 14 Dec 2001 14:50:57 +0100, Yann Dirson wrote: >Sorry to ask - what's yours ? http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/52298 Ciao, J=FCrgen From ngps@netmemetic.com Sat Dec 15 16:57:14 2001 From: ngps@netmemetic.com (Ng Pheng Siong) Date: Sun, 16 Dec 2001 00:57:14 +0800 Subject: [Doc-SIG] Docbook "user exit"? In-Reply-To: ; from jh@web.de on Fri, Dec 14, 2001 at 12:07:18AM +0100 References: <20011214000040.A985@madcap.netmemetic.com> Message-ID: <20011216005714.A635@madcap.netmemetic.com> On Fri, Dec 14, 2001 at 12:07:18AM +0100, Juergen Hermann wrote: > >Is there a "user exit" mechanism in Docbook to allow me to call said code > >colouriser? > > I could rewrite mine to emit docbook (it's a thing I'll need anyway), so you > could pre-process sources and then include them as entities. Yes, this sounds like a better approach. Thanks. Here's a feature request: When your tool is munching a piece of Python source into Docbook, have it somehow associate "labels" to the code. This way, one can use these labels to refer to the Python code while discussing it in the body text. Easier to keep the code and discussion text in sync than using just plain line numbers (which one still needs to add to the rendered Python code somehow). Cheers. -- Ng Pheng Siong * http://www.netmemetic.com From fdrake@beowolf.digicool.com Sat Dec 15 20:44:16 2001 From: fdrake@beowolf.digicool.com (Fred Drake) Date: Sat, 15 Dec 2001 15:44:16 -0500 (EST) Subject: [Doc-SIG] [maintenance doc updates] Message-ID: <20011215204416.B421F286BC@beowolf.digicool.com> The development version of the documentation has been updated: http://python.sourceforge.net/maint-docs/ Miscellaneous minor updates/fixes. From fdrake@acm.org Sat Dec 15 20:46:40 2001 From: fdrake@acm.org (Fred L. Drake) Date: Sat, 15 Dec 2001 15:46:40 -0500 (EST) Subject: [Doc-SIG] [development doc updates] Message-ID: <20011215204640.8FF5E286BC@beowolf.digicool.com> The development version of the documentation has been updated: http://python.sourceforge.net/devel-docs/ Miscellaneous minor updates/fixes post 2.2c1. From ydirson@fr.alcove.com Mon Dec 17 09:34:34 2001 From: ydirson@fr.alcove.com (Yann Dirson) Date: Mon, 17 Dec 2001 10:34:34 +0100 Subject: DOCBOOK: Re: [Doc-SIG] Docbook "user exit"? In-Reply-To: <20011216005714.A635@madcap.netmemetic.com> References: <20011214000040.A985@madcap.netmemetic.com> <20011216005714.A635@madcap.netmemetic.com> Message-ID: <20011217103434.B11140@kasba.alcove-fr> On Sun, Dec 16, 2001 at 12:57:14AM +0800, Ng Pheng Siong wrote: > Here's a feature request: When your tool is munching a piece of Python > source into Docbook, have it somehow associate "labels" to the code. Probably generating a ProgramListingCO would be more appropriate ? This way we would use already existing rendering code... -- Yann Dirson http://www.alcove.com/ Free-Software Engineer Ingénieur Logiciel-Libre Free-Software time manager Responsable du temps Informatique-Libre Debian GNU/Linux developper From fdrake@acm.org Tue Dec 18 17:26:36 2001 From: fdrake@acm.org (Fred L. Drake) Date: Tue, 18 Dec 2001 12:26:36 -0500 (EST) Subject: [Doc-SIG] [development doc updates] Message-ID: <20011218172636.9E823286BC@cj42289-a.reston1.va.home.com> The development version of the documentation has been updated: http://python.sourceforge.net/devel-docs/ Added documentation for pydoc. Misc. other fixes. From thomas@co-buero.de Mon Dec 24 00:44:56 2001 From: thomas@co-buero.de (thomas@co-buero.de) Date: Mon, 24 Dec 2001 01:44:56 +0100 Subject: [Doc-SIG] (no subject) Message-ID: <004601c18c14$35adc620$1f01a8c0@local.cobuero.de> From fdrake@acm.org Fri Dec 28 04:56:31 2001 From: fdrake@acm.org (Fred L. Drake, Jr.) Date: Thu, 27 Dec 2001 23:56:31 -0500 (EST) Subject: [Doc-SIG] Documentation for Python 2.2.1 Message-ID: <15403.64383.728258.799543@cj42289-a.reston1.va.home.com> I've brought the docs in Python's release22-maint branch up to date with the corrections that have been made on the trunk. I'll be checking in relevant additions to this branch as well as the trunk when I make the trunk changes. When anyone else makes a change on the trunk which should also be made on the 2.2 maintenance branch, feel free to check it in in both places, or add a note to the checkin message noting that it should be made on the branch as well, and I'll try to make sure that gets done. The 2.2 maintenance branch has replaced the 2.1 maintenance branch as the "maintenance version" at http://python.sourceforge.net/; if anyone thinks we should continue to offer the 2.1 maintenance docs there, please let me know. I don't think we have a Patch Czar for 2.2.1 yet; if anyone would like to take that duty for the documentation tree, I'd certainly appreciate the help! Thanks! -Fred -- Fred L. Drake, Jr. PythonLabs at Zope Corporation From fdrake@acm.org Fri Dec 28 04:59:57 2001 From: fdrake@acm.org (Fred L. Drake) Date: Thu, 27 Dec 2001 23:59:57 -0500 (EST) Subject: [Doc-SIG] [development doc updates] Message-ID: <20011228045957.6E9FD286BB@beowolf.digicool.com> The development version of the documentation has been updated: http://python.sourceforge.net/maint-docs/ The "maintenance version" of the Python documentation on the Python development site at SourceForge has been updated to show the docs being developed for Python 2.2.1. From fdrake@acm.org Fri Dec 28 05:03:42 2001 From: fdrake@acm.org (Fred L. Drake) Date: Fri, 28 Dec 2001 00:03:42 -0500 (EST) Subject: [Doc-SIG] [development doc updates] Message-ID: <20011228050342.CB129286BB@beowolf.digicool.com> The development version of the documentation has been updated: http://python.sourceforge.net/devel-docs/ A variety of updates made since Python 2.2 was released. From goodger@users.sourceforge.net Sun Dec 30 20:40:58 2001 From: goodger@users.sourceforge.net (David Goodger) Date: Sun, 30 Dec 2001 15:40:58 -0500 Subject: [Doc-SIG] Re: support for translations in reStructuredText In-Reply-To: <004e01c18c16$6d081560$1f01a8c0@local.cobuero.de> Message-ID: thomas@co-buero.de recently wrote to me: > Hello, >=20 > I'm thinking about multilingual texts, where the source for every languag= e > will be in one source file. I would like to know, wether > there exist some type of > markup in reStructuredText, which could support something like this (whic= h I > would love to have for example in MoinMoin to support > multilanguage Wikis). >=20 > To explain, what I mean, take a look at this example: >=20 > ----------- >=20 > :lang:en >=20 > Headline > {de}=DCberschrift > =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D >=20 > This is the first line of the first paragraph. > {de} Dies ist die erste Zeile des ersten Paragraphen. > {sp} .... >=20 > {de} Diese Zeile gibt es nur auf Deutsch >=20 > {en} This line exists only in english language. >=20 > ---- >=20 > For output this text should be rendered according to user preferences, > showing only the language best matching the users skills. >=20 >=20 > I'm sorry in case this is not the right place to discuss this topic and i= n > this case would be glad to know about the right one. > Thank You, > Thomas Kalka Hi Thomas, Doc-SIG is the best place to discuss this topic. I don't think anybody has addressed multilingual texts in reStructuredText yet, so the field is wide open. I don't see any reason why it cannot be done, with a little bit of work. When I worked for an SGML data processing company in Tokyo, I dealt with multilingual documents. We would receive a document in one language (typically English) and prepare it for translation (by professional translators) into one or more other languages. The solution we came up with involved marked sections. I wrote a program (in my Perl days) which was fed the document and a description of the translation unit granularity (typically, paragraph-equivalent elements). Given an original text like::

This is a paragraph in English

The program would produce something like this (may be syntax errors)::

English ]]> ]]>

The translators would fill in the "%chinese;" section, using & rearranging any inline tags present. When processing, we would set the "english" parameter entity to "INCLUDE" to get the English version, or set "chinese" to "INCLUDE" to get the Chinese version (default for parameter entities was "IGNORE"). This data-level approach was moderately successful. There wasn't time or budget for any kind of tool-level support. I don't know what the state of the art in multilingual applications of XML/SGML is now, but I could imagine a similar approach for a reStructuredText document. A directive would do the trick:: .. language:: en This section of the document is in English. .. language:: fr Ceci est en francais. A bunch of pre-defined language directives would also do fine: ".. en::", ".. fr::", ".. de::", ".. jp::", etc. These directives would act on all following text up to the next such directive: simply keep the text if it's the desired language, or discard it if not. You would have to choose the granularity level to suit your data & application. I think a paragraph-level translation unit is appropriate for most cases. I wouldn't want to interleave sentences of different languages in a single paragraph: too confusing. Section-level granularity might be better for some documents, or document-level granularity (the entire Englis= h version, followed by the entire German version, etc.). Some kind of editor-level support could also be very useful. Perhaps a mino= r mode for the hypothetical emacs reStructuredText mode? There hasn't been any progress with reStructuredText/DPS/DocUtils of late, due to a convergence of factors (busy at work; busy at home; holidays). But I do intend to get back to them soon. The projects are hibernating temporarily, and will be revived shortly. --=20 David Goodger goodger@users.sourceforge.net Open-source projects: - Python Docstring Processing System: http://docstring.sourceforge.net - reStructuredText: http://structuredtext.sourceforge.net - The Go Tools Project: http://gotools.sourceforge.net From ngps@netmemetic.com Mon Dec 31 16:10:38 2001 From: ngps@netmemetic.com (Ng Pheng Siong) Date: Tue, 1 Jan 2002 00:10:38 +0800 Subject: DOCBOOK: Re: [Doc-SIG] Docbook "user exit"? In-Reply-To: <20011217103434.B11140@kasba.alcove-fr>; from ydirson@fr.alcove.com on Mon, Dec 17, 2001 at 10:34:34AM +0100 References: <20011214000040.A985@madcap.netmemetic.com> <20011216005714.A635@madcap.netmemetic.com> <20011217103434.B11140@kasba.alcove-fr> Message-ID: <20020101001038.C306@madcap.netmemetic.com> On Mon, Dec 17, 2001 at 10:34:34AM +0100, Yann Dirson wrote: > On Sun, Dec 16, 2001 at 12:57:14AM +0800, Ng Pheng Siong wrote: > > Here's a feature request: When your tool is munching a piece of Python > > source into Docbook, have it somehow associate "labels" to the code. > > Probably generating a ProgramListingCO would be more appropriate ? > This way we would use already existing rendering code... I dunno - I'm really rather clueless about this. All I want to do is to write computing documentation using tools that are based on fairly open standards and are not a hassle to use. ;-) Happy New Year! -- Ng Pheng Siong * http://www.netmemetic.com