Gmane
Favicon Gravatar
From: Sven Vermeulen <swift <at> gentoo.org>
Subject: App to download documentation
Newsgroups: gmane.linux.gentoo.documentation
Date: 2003-10-30 13:41:17 GMT (5 years, 35 weeks, 4 days and 56 minutes ago)
Hi,

Although I could write it, it isn't on my todo-list really, and I think there
are ppl here with a lot more scripting experience than me. Anyway, perhaps
they could make a userfriendly _and_ wellwritten tool for offsite gentoo
documentation.

For instance a "gdoc" tool, with
  $ gdoc --update
downloading the xml-files (in GuideXML format) from the English repository, or
  $ gdoc --lang=nl --update
downloading the xml-files (in GuideXML format) from the Dutch repository. Then
  $ gdoc --list
would show a listing of all available documentation, using the filename and
abstract information as description:
  $ gdoc --list
    gentoo-x86-install    These instructions step you through the process of
                          installing Gentoo Linux 1.4, release version (not 
                          _rc versions). The Gentoo Linux installation
                          process supports various installation approaches, 
                          depending upon how much of the system you want to 
                          custom-build from scratch.
    [...]

Then a special feature would make it possible to convert the guide to html
(using xsltproc) or pdf (using fop) to it is readable by the user.
  $ gdoc --export html gentoo-x86-install
  -- Gentoo x86 Installation Guide --
  Processing gentoo-x86-install.xml
  gentoo-x86-install.html saved in html/
  $ 

The gdoc-utility could store the xml-files in /var/cache/gdp (or somewhere
else) and internally use xsltproc or fop with a local guide.xsl file.

This should be doable, and deliver the possibility for the users to have the
gentoo documentation offline if they want.

Other ideas?

Wkr,
	Sven Vermeulen 

-- 
 ^__^   And Larry saw that it was Good.
 (oo)                                      Sven Vermeulen
 (__)   http://www.gentoo.org              Gentoo Documentation Project