Received: from localhost (maia-2.hub.org [200.46.204.187]) by postgresql.org (Postfix) with ESMTP id 7E9189FA56C for ; Wed, 29 Aug 2007 16:09:34 -0300 (ADT) Received: from postgresql.org ([200.46.204.71]) by localhost (mx1.hub.org [200.46.204.187]) (amavisd-maia, port 10024) with ESMTP id 17568-01-9 for ; Wed, 29 Aug 2007 16:09:24 -0300 (ADT) X-Greylist: domain auto-whitelisted by SQLgrey-1.7.5 Received: from nz-out-0506.google.com (nz-out-0506.google.com [64.233.162.237]) by postgresql.org (Postfix) with ESMTP id 48A6D9FA5D4 for ; Wed, 29 Aug 2007 16:09:15 -0300 (ADT) Received: by nz-out-0506.google.com with SMTP id l8so215709nzf for ; Wed, 29 Aug 2007 12:09:14 -0700 (PDT) DKIM-Signature: a=rsa-sha1; c=relaxed/relaxed; d=gmail.com; s=beta; h=domainkey-signature:received:received:message-id:date:from:to:subject:cc:in-reply-to:mime-version:content-type:content-transfer-encoding:content-disposition:references; b=Tn5q7gIe3V5bVIZrPretJfhG8qQ/eg7Ck4Tj/QtkzCDn1LBXb2NRVV8qw5OVFo0UWuA54dtLNOLX49XaJfbTllEBnSohJ9Vrch7thpclnoSS2GKqOb/GTKxy0yQliYDHzY7VRXbHpEaXar5LYeWzXm2nKmwQDwvp3R5+wakXGS4= DomainKey-Signature: a=rsa-sha1; c=nofws; d=gmail.com; s=beta; h=received:message-id:date:from:to:subject:cc:in-reply-to:mime-version:content-type:content-transfer-encoding:content-disposition:references; b=r+ltEkg7398+J3q8FyeGI3Trn2OIkAUv2jxnP+/Kh8axNZ/8ijs9TJShpfLBCDZ8P4fg6UOwgW4Vr7yogY58Lr2OGmKws1TA9+NH9gAA3lHeavY32W136m8YrlPl8xlKxnBtKLvz6QyM3UCYcRPcBQ+3qtEwRfJ619CFFUDRrB8= Received: by 10.141.210.5 with SMTP id m5mr507876rvq.1188414553812; Wed, 29 Aug 2007 12:09:13 -0700 (PDT) Received: by 10.141.159.11 with HTTP; Wed, 29 Aug 2007 12:09:13 -0700 (PDT) Message-ID: Date: Wed, 29 Aug 2007 14:09:13 -0500 From: "Scott Marlowe" To: "Mario Gonzalez" Subject: Re: [HACKERS] Contrib modules documentation online Cc: "Neil Conway" , "Tom Lane" , "Josh Berkus" , pgsql-hackers@postgresql.org, "Albert Cervera i Areny" , pgsql-docs@postgresql.org In-Reply-To: <2065a6cf0708291127j3b0ee41bp1ca5b9391935af67@mail.gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset=ISO-8859-1 Content-Transfer-Encoding: 7bit Content-Disposition: inline References: <200708290157.07968.albert@nan-tic.com> <200708291009.07942.josh@agliodbs.com> <7046.1188410001@sss.pgh.pa.us> <1188411524.32003.6.camel@dell.linuxdev.us.dell.com> <2065a6cf0708291127j3b0ee41bp1ca5b9391935af67@mail.gmail.com> X-Virus-Scanned: Maia Mailguard 1.0.1 X-Archive-Number: 200708/30 X-Sequence-Number: 4377 On 8/29/07, Mario Gonzalez wrote: > On 29/08/2007, Neil Conway wrote: > > > > I wonder if it would be possible to keep the master version of the > > contrib docs as SGML, and generate plaintext READMEs from it during the > > documentation build. > > > > Hello Neil, I think I'm doing something similar but not with README > files. Currently I'm writing the FAQ into Docbook XML, that's why we > can build the HTML and plain text at one. While I like the idea of the READMEs from contrib being in the docs, I can't tell you the number of times I've installed a contrib module in a dark ops center at 2am with no html browser handy (or at best a text based one) or with no access to external internet etc... and just needed a line or two from the README file that came with the contrib module. Could the contrib README files couldn't be generated from the same source as the docs (i.e. sgml) and then put into the appropriate contrib/module/ directory.