Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 185477 - devmanual as a single file
Summary: devmanual as a single file
Status: CONFIRMED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Devmanual (show other bugs)
Hardware: All Linux
: High enhancement (vote)
Assignee: Gentoo Devmanual Team
URL:
Whiteboard:
Keywords:
: 215236 281157 320833 (view as bug list)
Depends on:
Blocks:
 
Reported: 2007-07-15 23:17 UTC by pavel sanda
Modified: 2020-01-28 03:02 UTC (History)
6 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 pavel sanda 2007-07-15 23:17:51 UTC
hello,
it would be very helpful if the structured documentation on 
http://devmanual.gentoo.org/ can be viewed also as one single html file.
searching in such structured doc is very annoying.

thanks.

(btw. href to bugzilla on intro page is wrong.)

Reproducible: Always
Comment 1 Petteri Räty (RETIRED) gentoo-dev 2007-07-18 19:20:54 UTC
If you have the skills the sources can be found via:
http://anonsvn.gentoo.org/
Comment 2 Mark Loeser (RETIRED) gentoo-dev 2008-01-18 01:56:44 UTC
Good idea, but I don't think any of us have the necessary skills or time at this point to do anything about this.

We'll definitely revisit it later though.
Comment 3 Mark Loeser (RETIRED) gentoo-dev 2008-03-28 20:32:37 UTC
*** Bug 215236 has been marked as a duplicate of this bug. ***
Comment 4 Mark Loeser (RETIRED) gentoo-dev 2009-08-12 01:15:02 UTC
*** Bug 281157 has been marked as a duplicate of this bug. ***
Comment 5 Mark Loeser (RETIRED) gentoo-dev 2010-05-23 02:49:45 UTC
*** Bug 320833 has been marked as a duplicate of this bug. ***
Comment 6 P.B. Lecavalier 2015-01-27 16:07:51 UTC
<ping!>

I was gonna file the same bug (enhancement request), and found out that one.

When I take the time to carefully RTFM, I like to do so away from the computer (printed or ereader), so a single-page helps to do that.

So… that was already six years ago? I think even the website's framework changed since then. For instance, "Comment 1" points to the location of the source… which does not exist anymore. What would be involved to perform that?

Does someone finally know how to get it implemented? If not, well, I understand, as I'm sorry to tell you I don't know that either…
Comment 7 Göktürk Yüksek archtester gentoo-dev 2016-03-30 02:28:49 UTC
Something like this could be useful perhaps, courtesy of NP-Hardass:
http://blog.siphos.be/2013/04/transforming-guidexml-to-docbook/
Comment 8 Alice Ferrazzi Gentoo Infrastructure gentoo-dev 2016-09-18 17:53:38 UTC
would be nice :)
Comment 9 Göktürk Yüksek archtester gentoo-dev 2016-09-25 00:08:27 UTC
I couldn't invest much time in this but with a short time of hacking I got this: http://dev.gentoo.org/~gokturk/devmanual/bug185477/text.pdf. It should be fairly straightforward for someone who knows more xsl than I do :)
Comment 10 Ulrich Müller gentoo-dev 2020-01-23 11:08:12 UTC
I this still an issue, now that we have search functionality?
Comment 11 Michael Orlitzky gentoo-dev 2020-01-23 16:19:29 UTC
(In reply to Ulrich Müller from comment #10)
> I this still an issue, now that we have search functionality?

This would still be nice for printing, and the javascript search is really hacky. Ctrl-f is better in every way, so I'd much rather have this than that. (Or both, if there's any reason to keep the JS search around too.)
Comment 12 Göktürk Yüksek archtester gentoo-dev 2020-01-28 00:37:58 UTC
(In reply to Michael Orlitzky from comment #11)
> (In reply to Ulrich Müller from comment #10)
> > I this still an issue, now that we have search functionality?
> 
> This would still be nice for printing, and the javascript search is really
> hacky. Ctrl-f is better in every way, so I'd much rather have this than
> that. (Or both, if there's any reason to keep the JS search around too.)

JS search does stemming on search terms. So if you search for "package", it'll stem it down to "packag" and match things like "package", "packaging" etc. Also, multi-term search in JS would perform better than your ctrl-f.
Comment 13 Michael Orlitzky gentoo-dev 2020-01-28 02:11:11 UTC
(In reply to Göktürk Yüksek from comment #12)
> 
> JS search does stemming on search terms. So if you search for "package",
> it'll stem it down to "packag" and match things like "package", "packaging"
> etc. Also, multi-term search in JS would perform better than your ctrl-f.

If the JS search returns results that I didn't search for, that's another reason to prefer ctrl-f =P

In this case, as soon as I type the "packag" part of "packaging", firefox will do exactly the same thing. If I type the rest of the word, then clearly I don't want things that only contain "packag". The best user interface is the one that does what I asked it to.
Comment 14 Göktürk Yüksek archtester gentoo-dev 2020-01-28 02:54:59 UTC
(In reply to Michael Orlitzky from comment #13)
> (In reply to Göktürk Yüksek from comment #12)
> > 
> > JS search does stemming on search terms. So if you search for "package",
> > it'll stem it down to "packag" and match things like "package", "packaging"
> > etc. Also, multi-term search in JS would perform better than your ctrl-f.
> 
> If the JS search returns results that I didn't search for, that's another
> reason to prefer ctrl-f =P
> 
> In this case, as soon as I type the "packag" part of "packaging", firefox
> will do exactly the same thing. If I type the rest of the word, then clearly
> I don't want things that only contain "packag". The best user interface is
> the one that does what I asked it to.

I provided a very simple stemming example. The stemming is decided based on the overall content, so it's a bit smarter than you think. If we're gonna follow that line of arguing, I can also ctrl-f the search results to look for an exact match :P

Your argument is rather personal however. When I type package, I do want things that contain package, packaged, packaging etc. I like the fact that I search for "remove ebuilds" and I get a hit for "removing an ebuild". You on the other hand want an exact match. We can see if we are able to facilitate searches without stemming. The point is that ctrl-f doesn't achieve what I want, but I can achieve what you want with a bit more programming. I don't see much value arguing that ctrl-f is superior to a search mechanism though. Maybe what lunr.js does is overkill to your search needs but clearly it is more feature-rich than ctrl-f.
Comment 15 Michael Orlitzky gentoo-dev 2020-01-28 03:02:27 UTC
(In reply to Göktürk Yüksek from comment #14)
> 
> Your argument is rather personal however.

Sure, all I'm saying is that personally I prefer ctrl-f and no javascript. And when I was still learning this stuff, a printable devmanual would have been awesome.