Bug 41791
| Summary: | Documentation formatting error | ||
|---|---|---|---|
| Product: | Documentation | Reporter: | Jerry Dunham <jdunham> |
| Component: | Books & Articles | Assignee: | Giorgos Keramidas <keramida> |
| Status: | Closed FIXED | ||
| Severity: | Affects Only Me | ||
| Priority: | Normal | ||
| Version: | Latest | ||
| Hardware: | Any | ||
| OS: | Any | ||
|
Description
Jerry Dunham
2002-08-19 21:00:03 UTC
On 2002-08-19 12:50 +0000, Jerry Dunham wrote:
> I'm installing 4.6 for the first time. I read all the
> documentation accessed via sysinstall, but had a minor problem. All
> the documentation appears to be exactly one character wider than my
> screen. I'm losing the rightmost character of many lines.
I think I know why this happens...
sysinstall uses libdialog as the interface library. The READMEs and
other text files are displayed in a text dialog box that is COLS
columns wide and ROWS rows high. The rightmost and leftmost columns
are saved for the libdialog borders. Thus the maximum visible width
of a text file in libdialog is (COLS-2) columns. In an 80-column
terminal, this is 78. But the documentation files are formatted with
a -width option of 80 and thus sometimes wrap at 79 columns.
I think we should probably set HTML2TXTFLAGS to add extra `-width 78'
options to links while building the release notes.
Bruce, what do you think abou this?
- Giorgos
If memory serves me right, Giorgos Keramidas wrote: > On 2002-08-19 12:50 +0000, Jerry Dunham wrote: > > I'm installing 4.6 for the first time. I read all the > > documentation accessed via sysinstall, but had a minor problem. All > > the documentation appears to be exactly one character wider than my > > screen. I'm losing the rightmost character of many lines. FYI: Horizontal scrolling when viewing files works. That's not a solution to the real problem, but just mentioning this fact. > I think I know why this happens... > > sysinstall uses libdialog as the interface library. The READMEs and > other text files are displayed in a text dialog box that is COLS > columns wide and ROWS rows high. The rightmost and leftmost columns > are saved for the libdialog borders. Thus the maximum visible width > of a text file in libdialog is (COLS-2) columns. In an 80-column > terminal, this is 78. But the documentation files are formatted with > a -width option of 80 and thus sometimes wrap at 79 columns. > > I think we should probably set HTML2TXTFLAGS to add extra `-width 78' > options to links while building the release notes. Does this option actually exist? My links might be out of date, but: nimitz:TRACES% links -dump -width 78 http://www.freebsd.org/index.html Unknown option -width Note that we use the www/links1 port, not www/links, for generating the text docs. > Bruce, what do you think abou this? No objections, subject to this actually working. :-) Thanks, Bruce. Responsible Changed From-To: freebsd-doc->keramida I'll work on fixing this. State Changed From-To: open->closed The default line length is now 72 columns. This should fix the problem described for running text. Inline ASCII art is usually enclosed in <pre> tags in the HTML output and left intact in text-only output, so some parts of the release notes *may* still cross the 78-column limit, but this should be very rare. Jerry, thanks for submitting the problem report and, most of all, thanks for reminding me that this needs handling despite the fact a long time passed. |
