bug-texinfo
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Some typos in the current manual


From: Gavin Smith
Subject: Re: Some typos in the current manual
Date: Thu, 2 Jan 2020 19:03:57 +0000
User-agent: Mutt/1.9.4 (2018-02-28)

On Thu, Dec 26, 2019 at 10:17:28PM +0900, Jean-Christophe Helary wrote:
> I was looking for info on the HTML output options and found a few typos. So I 
> decided to check the whole document.

Thanks for looking at this.  I agree with some of your changes and 
disagree with others.  It's quite time-consuming to review the entire 
change because it is so big.  Hence, my comments below are not 
comprehensive.

I went through your patch with "git add -p" and made a smaller patch 
(attached) of the changes I agree with.


***************
*** 10600,10606 ****
  circle; in Info, this is @samp{(C)}.
  
  Legally, it's not necessary to use the copyright symbol; the English
! word `Copyright' suffices, according to international treaty.
  
  
  @node @code{@@registeredsymbol}
--- 10600,10606 ----
  circle; in Info, this is @samp{(C)}.
  
  Legally, it's not necessary to use the copyright symbol; the English
! word `Copyright' suffices, according to international treaties.

I don't agree with changing "treaty" to "treaties" here.  It is not 
referring to indiviual treaties but the concept of international 
diplomacy more generally.

 which led to the meaning of `argument' as a dispute.} they take, you
 need to write @@-commands on lines of their own, or as part of
 sentences.  As a general rule, a command requires braces if it mingles 
-among other text; but it does not need braces if it is on a line of its 
+among other texts; but it does not need braces if it is on a line of its 
 own.  For more details of Texinfo command syntax, see @ref{Command 
 Syntax}.

A similar issue here: "text" in this context is what is called a "mass noun",
and not a singular form of a countable noun.  Think of there being two words in
English that are "text", one a countable noun, the other a mass noun.  (I have
seen the same confusion from French speakers.)

***************
*** 5221,5227 ****
  
  In this example, @samp{Top} is the name of the first node, and
  @samp{Overview} is the name of the first section of the manual.  There
! is no widely-used convention for naming the first section in a printed
  manual, this is just what the Make manual happens to use.  This
  arbitrariness of the first name is a principal reason why omitting the
  third argument in whole-manual cross-references is preferable.
--- 5221,5227 ----
  
  In this example, @samp{Top} is the name of the first node, and
  @samp{Overview} is the name of the first section of the manual.  There
! is no widely used convention for naming the first section in a printed
  manual, this is just what the Make manual happens to use.  This
  arbitrariness of the first name is a principal reason why omitting the
  third argument in whole-manual cross-references is preferable.

I read that adverbs ending in "-ly" don't hyphenate, but "widely-used" looks
perfectly fine to me.


***************
*** 6782,6790 ****
  printed.  It may or may not be seriffed.

  @item @@sansserif
! @findex sansserif @r{(sans serif font)}
! @cindex Sans serif font
! selects a @sansserif{sans serif} font;

  @item @@slanted
  @findex slanted @r{(slanted font)}
--- 6782,6790 ----
  printed.  It may or may not be seriffed.

  @item @@sansserif
! @findex sansserif @r{(sans-serif font)}
! @cindex Sans-serif font
! selects a @sansserif{sans-serif} font;

  @item @@slanted
  @findex slanted @r{(slanted font)}

Is it really wrong without the hyphen?

There was the same issue with "small caps" which you changed to 
"small-caps".

***************
*** 15708,15717 ****
  value is @samp{.15\hsize}.  @code{\hsize} is the @TeX{} dimension
  containing the current line width.
  
! @cindex Black rectangle in hardcopy
! @cindex Rectangle, black in hardcopy
! @cindex Box, ugly black in hardcopy
! @cindex Ugly black rectangles in hardcopy
  For any overfull boxes you do have, @TeX{} will print a large, ugly,
  black rectangle beside the line that contains the overfull hbox unless
  told otherwise.  This is so you will notice the location of the
--- 15708,15717 ----
  value is @samp{.15\hsize}.  @code{\hsize} is the @TeX{} dimension
  containing the current line width.
  
! @cindex Black rectangle in hard copy
! @cindex Rectangle, black in hard copy
! @cindex Box, ugly black in hard copy
! @cindex Ugly black rectangles in hard copy
  For any overfull boxes you do have, @TeX{} will print a large, ugly,
  black rectangle beside the line that contains the overfull hbox unless
  told otherwise.  This is so you will notice the location of the

I don't think it's necessary to change this.

@@ -5272,7 +5272,7 @@ Sea surges are described in @@ref@{Hurricanes@}.
 @end example
 
 @noindent
-looks ok in the printed output:
+looks OK in the printed output:
 
 @quotation
 Sea surges are described in Section 6.7 [Hurricanes], page 72.

What about "okay" instead?

 the world, this wide-ranging support is not available in
 @file{texinfo.tex}, and it's not feasible to duplicate or incorporate
 all that effort.  (Our plan to support other scripts is to create a
-@LaTeX{} back-end to @command{texi2any}, where the support is already
+@LaTeX{} back end to @command{texi2any}, where the support is already
 present.)

 For maximum portability of Texinfo documents across the many different


I think "backend" would be slightly clearer than "back end" although 
there'd be nothing wrong with keeping it as "back-end".

 @table @samp
 @item chapter
 The output is split at @code{@@chapter} and other sectioning
-@@-commands at this level (@code{@@appendix}, etc.).
+@@-commands at this level (@code{@@appendix}, etc.)

 @item section
 The output is split at @code{@@section} and similar.

It's logical to have the extra full stop after the closing parenthesis.

Attachment: texinfo_typos_2.diff
Description: Text Data


reply via email to

[Prev in Thread] Current Thread [Next in Thread]