From mboxrd@z Thu Jan 1 00:00:00 1970 X-Spam-Checker-Version: SpamAssassin 4.0.0 (2022-12-14) on finch.gentoo.org X-Spam-Level: X-Spam-Status: No, score=0.2 required=5.0 tests=DATE_IN_PAST_12_24, INVALID_DATE,MAILING_LIST_MULTI,NO_RELAYS autolearn=no autolearn_force=no version=4.0.0 Received: from drobbins by cvs.gentoo.org with local (Exim 3.22 #1) id 14hEXR-0000wF-00 for gentoo-dev@gentoo.org; Sun, 25 Mar 2001 10:42:49 -0700 To: gentoo-dev@gentoo.org Subject: Re: [gentoo-dev] Gentoo Documentation Considerations Message-ID: <20010325104248.A3589@cvs.gentoo.org> References: <3ABE1B4D.7804C925@gottinger.de> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline User-Agent: Mutt/1.2.5i In-Reply-To: <3ABE1B4D.7804C925@gottinger.de>; from AGottinger@t-online.de on Sun, Mar 25, 2001 at 06:22:37PM +0200 From: Sender: gentoo-dev-admin@gentoo.org Errors-To: gentoo-dev-admin@gentoo.org X-BeenThere: gentoo-dev@gentoo.org X-Mailman-Version: 2.0 Precedence: bulk Reply-To: gentoo-dev@gentoo.org List-Help: List-Post: List-Subscribe: , List-Id: Gentoo Linux development list List-Unsubscribe: , List-Archive: Date: Sun Mar 25 10:43:01 2001 X-Original-Date: Sun, 25 Mar 2001 10:42:48 -0700 X-Archives-Salt: ce32bf30-0a8d-45f2-9fda-bebc8cde9283 X-Archives-Hash: d84fa0ccd5abe81d84e93b4b92c891ae On Sun, Mar 25, 2001 at 06:22:37PM +0200, Achim Gottinger wrote: > I have a few thoughts how we can handle the documentation for gentoo in a way > that we can use it for our webpage and independently for a printable book. > Now my plan. We separate the articles from the build packages. This means > we create gentoo-install, gentoo-portage, gentoo-ebuild, gentoo-man which > contain either gentoo-xsl or docbook style docs and those docs only get > installed to /usr/share/doc/gentoo/[guide|docbook]. Once daniel has finished > his gentoo->html xsl stylesheet, I create a gentoo->docbook xsl-sheet. Yes, I'd like to use "guide" as our official format and use XSLT to convert from there. I can focus on the guide -> HTML XSLT, and if you can focus on the guide -> docbook XSLT, then that would be great. Right now, web page HTML documentation is our number one priority, but it would also be nice to use "guide" XML as the master file for our man pages. > gentoo-web now can contain an global xml file which is generated dynamic from > the content of /usr/share/doc/gentoo/guide. It generates the website-content > from this global file. And I'm guessing that we should design it this way so that I need to remerge the actual documentation before it goes "live" on the website? Because, if it pulled the docs directly from /usr/portage instead, then it could be using documentation that's currently in development and not yet production-ready? > gentoo-doc must convert the guide-style files to docbook. After that it > generates a global docbook book file and creates prinatble output. OK, so we have the following XML packages, each one containing a master document in "guide" XML format: gentoo-install gentoo-portage gentoo-ebuild gentoo-man Then, we have two "target" packages that generate content from these packages: gentoo-web gentoo-doc > This way we have our docs allways up to date on the web and as a book. Sounds good... I'll need to think about how this will work from the webmaster's (my) perspective. -- Daniel Robbins President/CEO http://www.gentoo.org Gentoo Technologies, Inc.