On Sun, Feb 16, 2014 at 02:51:23PM +0000, Bjarni Ingi Gislason wrote: > Source: dialog > Version: 1.2-20140112 > Severity: minor > Tags: patch > > Dear Maintainer, > > * What led up to the situation? > > Testing a man page > > * What exactly did you do (or not do) that was effective (or > ineffective)? > > groff -b -mandoc -t -z -ww < dialog.1 > > * What was the outcome of this action? > > groff:<standard input>:1540: warning: number register `"' not defined
ok - that's a fix. However - see below. > ##### > > QUESTION: What does the unit "kb" mean? Should be made more clear. I'm not going to get into kibibytes :-) Perhaps s/kb/KB/ although I found no credible source which distinguishes the two in a quick search. The reader will know that the data used consistent units. > Changes: > > String "ASCII hyphens" changed to "ASCII hyphen-minuses' no... see for example https://www.cs.tut.fi/~jkorpela/dashes.html There's two problems with using a compound word: it's not idiomatic (in English), and it doesn't improve clarity. > - changed to \- if it means a minus not always. Looking at the change before/after, in both pdf and html, (though I'll pick through this for special cases), s/--/\\-\\-/g makes the presentation almost always visually distracting and decidedly less like the view in a terminal emulator. I didn't _overlook_ these, I did consider them before and didn't change them when I noticed this issue. Looking now, I see that except for one case, I'm using \- only for an endash... It would have been nice if groff's hackers had chosen to provide an unambiguous single-width "-". They didn't. "\-" gives a character twice as wide as the characters it is next to. I know about CW, but it's clumsy, less portable, and in the tests I've made is always a lighter-weight font than the normal. I'm assuming the last was done deliberately, to dissuade people from using it. That's talking about PDFs. Groff's html is poor to begin with, it's worse when everything becomes "−". > \\ changed to \e if it means a printable escape character I don't see a visual difference, but see that there's a very old occurrence in dialog.1 which I didn't remove. > '.TP 5' changed to '.TP 7' to keep the tag and text on the same line. > Otherwise the paragraphs do not look alike. ok (though my explanation would be that there are different types of paragraphs adjacent, and this change lessens discord between the types). > Comma (,) added before "and" after a series of "words" ok. > \/ added between an italic and a roman character > > Single - changed to \- if it means an option > > 'and' added between the last two words in a series of words > > Quotes (", `, and ') moved outside of an italic region (with macro > .RI) ok... though the macros don't improve readability of the source. I would have suggested (adding your hint of \/): "\/\fI\en\/" rather than .RI """" \e """" > Tilde (~) made bigger to be better visible in the output of troff looking at pdf - The size increase is less noticeable than seeing the character shifted up. A tilde should be just above the midpoint, not at the very top of the cell, above even capital letters. > Two spaces between words reduced to one ok. > Unpaddabe space (\ ) put between a number and an unit. (These are two > words.) in English that space usually isn't used... > " - " changed to " \(en " as a separator ... > To make the patch smaller, changes "--" to "\-\-" (for options) were > not made. That can easily be done with an editor (or "sed") after the > patch is applied. > > The patch is in the attachment. > > -- System Information: > Debian Release: jessie/sid > APT prefers stable-updates > APT policy: (500, 'stable-updates'), (500, 'proposed-updates'), (500, > 'testing'), (500, 'stable') > Architecture: i386 (i586) > > Kernel: Linux 3.2.53-rt75-1 > Locale: LANG=is_IS, LC_CTYPE=is_IS (charmap=ISO-8859-1) > Shell: /bin/sh linked to /bin/dash > > -- no debconf information > > -- > Bjarni I. Gislason -- Thomas E. Dickey <dic...@invisible-island.net> http://invisible-island.net ftp://invisible-island.net
signature.asc
Description: Digital signature