Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 80519 - long <pre> lines make the page far too wide [patch attached]
Summary: long <pre> lines make the page far too wide [patch attached]
Status: RESOLVED FIXED
Alias: None
Product: [OLD] Docs-user
Classification: Unclassified
Component: Gentoo Linux FAQ (show other bugs)
Hardware: x86 Linux
: High normal (vote)
Assignee: Sven Vermeulen (RETIRED)
URL: http://www.gentoo.org/doc/en/faq.xml
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2005-02-02 14:31 UTC by Benno Schulenberg
Modified: 2005-02-04 03:11 UTC (History)
1 user (show)

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


Attachments
hardwraps two lines (faq-shorter-pre-lines.patch,803 bytes, patch)
2005-02-02 14:32 UTC, Benno Schulenberg
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Benno Schulenberg 2005-02-02 14:31:27 UTC
Code Listing 3.5: /etc/make.conf contains two lines that are over 
100 characters long.  As this is a preformatted section, it forces 
the entire page to be the same width, which for me is some 25 percent 
wider than the browser window.  A smaller font is unreadable for me.

Please ensure that the preformatted sections of all documents do not 
exceed 80 characters in length.  The attached patch fixes the FAQ.

Reproducible: Always
Steps to Reproduce:
1.
2.
3.
Comment 1 Benno Schulenberg 2005-02-02 14:32:29 UTC
Created attachment 50233 [details, diff]
hardwraps two lines
Comment 2 SpanKY gentoo-dev 2005-02-02 15:06:38 UTC
sounds like you use konq

known issue
Comment 3 Benno Schulenberg 2005-02-03 02:10:54 UTC
> sounds like you use konq

No, Firefox.

Try it, set Proportional (Serif) to 20 pixels, and see.
Comment 4 Sven Vermeulen (RETIRED) gentoo-dev 2005-02-03 11:16:54 UTC
Thanks; fixed in CVS.
Comment 5 Benno Schulenberg 2005-02-03 14:34:24 UTC
That's a lot better, thanks.

But looking at it closely now, I see three nits:
the second wget command has a /usr/bin prefixed, the first not
the resume command has an extra space on its second line
putting the -c directly after wget would make the difference clearer
Comment 6 Sven Vermeulen (RETIRED) gentoo-dev 2005-02-04 02:24:06 UTC
Using the full path isn't mandatory here as Portage knows of the PATH environment variable. I don't see an additional space on the second line of the resume command, but whitespace doesn't generate errors. And putting the "-c" after wget would make it less pertinent imho, now you can see a distinction between the two second lines.
Comment 7 Benno Schulenberg 2005-02-04 02:57:19 UTC
> Using the full path isn't mandatory here

Of course, but it looks silly to have the full path on one command 
and none on the other, especially when you're trying to see what the 
difference is between the two commands.

> I don't see an additional space on the second line of the resume command,

But there is: fourteen spaces before the -t, fifteen before the -c.

> And putting the "-c" after wget would make it less pertinent imho,

Allright, a matter of taste.

Ehm, what about overly long <pre> lines in other documents, do you want 
patches for those as well?  Or are you going to make some policy to warn 
authors to look out for this?

And why is it that only in Gentoo docs long <pre> lines force the entire 
page to their width, whereas on other websites the overly long <pre> lines 
happily run off the page while all the other text stays within the window?
Comment 8 Sven Vermeulen (RETIRED) gentoo-dev 2005-02-04 03:11:10 UTC
It's a bit strange yes, but every time I update a document the translation teams have to update their translation as well. If there is no error in the docs, I rather not update them until we do a major overhaul/audit of the document.

The additional space is because the FETCH is one character shorter than RESUME :) Using this additional space, the lines are aligned correctly with the first line.

We generally don't fix <pre>'s for this unless the documentation is critical (such as the installation instructions) but when it's too long regardless of the document status, I tend to make an exception.

I don't know why our pre's and text width is correlated, probably a CSS setting somewhere.