Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 30457 - Gentoo Docs should be packaged
Summary: Gentoo Docs should be packaged
Status: RESOLVED WONTFIX
Alias: None
Product: [OLD] Docs-user
Classification: Unclassified
Component: Other (show other bugs)
Hardware: All Linux
: High normal (vote)
Assignee: Docs Team
URL:
Whiteboard:
Keywords:
: 125171 140239 (view as bug list)
Depends on:
Blocks:
 
Reported: 2003-10-05 20:11 UTC by Roger
Modified: 2006-07-14 00:38 UTC (History)
2 users (show)

See Also:
Package list:
Runtime testing required: ---


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Roger 2003-10-05 20:11:04 UTC
The docs at http://www.gentoo.org/main/en/docs.xml  should be have an option to
download this documentation via a tarball and/or maybe this documentation should
be packaged(?)

Reproducible: Always
Steps to Reproduce:
1.  Go travelling
2.  Discover that you don't have isp access and feel like doing something
creative with your gentoo laptop/box
3.  Figure out that you need access to the docs but can't get them, as such,
your sol and find some other playful thing to do like discovering files you
never knew you had in your ~/ folder.


Actual Results:  
finally got bored and went to sleep ;-)

Expected Results:  
tossed those babies within /usr/share/doc/gentoo  for those of us that go w/o
isp access for extended periods of time?

I have finally done the following to aquire teh docs:

wget -r --convert-links -E http://www.gentoo.org/main/en/docs.xml

but they are not easily browsable as this omitts the doc index page and then I
have to somehow recognize that the "doc/en/gentoo-howto.xml" file is the Ebuild
HowTo doc.  trivial!
Comment 1 Sven Vermeulen (RETIRED) gentoo-dev 2003-11-03 21:49:47 UTC
Using wget is the best method to download the documentation. Other methods
(a script that uses xsltproc, an ebuild providing txt/html/pdf, a tarball
downloaded) all have their deficiencies (xsltproc doesn't handle xslt's document()
function, ebuilds are already outdated when you download them, the tarball
provides too much and is even more outdated).

If you want all English documentation, use:
"""
wget --recursive --level=1 --no-parent --page-requisites --convert-link --no-host-directories
--html-extension http://www.gentoo.org/doc/en/index.xml
"""

See http://article.gmane.org/gmane.linux.gentoo.documentation/619 for the
discussion. You are free to participate further (you can download that mail
by using http://download.gmane.org/gmane.linux.gentoo.documentation/619/620).

I'm marking this as WONTFIX ('cause it doesn't seem that we are going to
provide the documentation in a package), although we will have the above
wget-rule mentioned somewhere. Eventually.
Comment 2 Xavier Neys (RETIRED) gentoo-dev 2006-03-06 01:44:09 UTC
*** Bug 125171 has been marked as a duplicate of this bug. ***
Comment 3 Łukasz Damentko (RETIRED) gentoo-dev 2006-07-13 08:16:07 UTC
*** Bug 140239 has been marked as a duplicate of this bug. ***
Comment 4 GNUtoo 2006-07-13 08:36:25 UTC
now after downloading the docs need to be renamed from xml to html
that's a big bug because most of the people can't view them ofline because they don't know how to do it
Comment 5 Curtis Napier (RETIRED) gentoo-dev 2006-07-13 16:20:09 UTC
(In reply to comment #4)
> now after downloading the docs need to be renamed from xml to html
> that's a big bug because most of the people can't view them ofline because they
> don't know how to do it
> 

You can view the xml docs natively using gorg[1]. It's in portage so you don't need to use the ebuild supplied there.


[1]http://gentoo.neysx.org/mystuff/gorg/gorg.xml 
Comment 6 GNUtoo 2006-07-13 21:29:13 UTC
(In reply to comment #5)
> (In reply to comment #4)
> > now after downloading the docs need to be renamed from xml to html
> > that's a big bug because most of the people can't view them ofline because they
> > don't know how to do it
> > 
> 
> You can view the xml docs natively using gorg[1]. It's in portage so you don't
> need to use the ebuild supplied there.
> 
> 
> [1]http://gentoo.neysx.org/mystuff/gorg/gorg.xml 
> 

thanks a lot but,again all users don't know that
Comment 7 Xavier Neys (RETIRED) gentoo-dev 2006-07-14 00:38:27 UTC
(In reply to comment #4)
> now after downloading the docs need to be renamed from xml to html
> that's a big bug because most of the people can't view them ofline because they
> don't know how to do it

They don't *have to* be renamed. They should only be renamed if you want to read them with a viewer that decides they must be xml files just because their name ends with .xml. Feel free to file an upstream bug against your viewer and tell them the days of DOS are over.

$ curl -o test.xml http://www.gentoo.org/doc/en/handbook/handbook-x86.xml?full=1 $ file test.xml
test.xml: HTML document text

Anyway, that still does not get you the css and images.

You can use the "Save As" menu item that many browsers have or wget as explained above.

You could also read http://www.gentoo.org/proj/en/gdp/doc/doc-tipsntricks.xml which explains how to render the original xml files into html yourself.

You can even get true XHTML from http://gentoo.neysx.org/ :)
$ curl -o test.xml http://gentoo.neysx.org/doc/en/handbook/handbook-x86.xml?full=1
$ file test.xml
test.xml: XML 1.0 document text