bugGNU roff - Bugs: bug #64238, [docs] Simplify the explanations...

 
 

bug #64238: [docs] Simplify the explanations of "italic corrections"

Submitter:  Bjarni Ingi Gislason <bjarniig>
Submitted:  Tue 23 May 2023 12:28:35 AM UTC
   
 
Category:  General Severity:  1 - Wish
Item Group:  Documentation Status:  Invalid
Privacy:  Public Assigned to:  gbranden
Open/Closed:  Closed Planned Release:  None
* Mandatory Fields

Add a New Comment Rich Markup
   

Fri 23 Jun 2023 12:40:49 PM UTC, comment #4: 


> groff(7) diff is terser, and that's deliberate.


Sorry, that should say:

> groff(7) is terser, and that's deliberate.

G. Branden Robinson <gbranden>
Group administrator
Fri 23 Jun 2023 12:40:04 PM UTC, comment #3: 

comment #2:

>  I read "doc/groff.texi".
>
>   The descriptions in "doc/groff_diff.7.man" and "man/groff.7.man"
> should also be simplified.
> The purpose should be added where it is missing.


The purpose is explained complete with examples in groff_diff(7), and has been for quite some time.


    \/     Apply an italic correction: modify the spacing of the
           preceding glyph so that the distance between it and the
           following glyph is correct if the latter is of upright shape.
           For example, if an italic "f" is followed immediately by a
           roman right parenthesis, then in many fonts the top right
           portion of the "f" overlaps the top left of the right
           parenthesis, which is ugly.  Inserting \/ between them avoids
           this problem.  Use this escape sequence whenever an oblique
           glyph is immediately followed by an upright glyph without any
           intervening space.

    \,     Apply a left italic correction: modify the spacing of the
           following glyph so that the distance between it and the
           preceding glyph is correct if the latter is of upright shape.
           For example, if a roman left parenthesis is immediately
           followed by an italic "f", then in many fonts the bottom left
           portion of the "f" overlaps the bottom of the left
           parenthesis, which is ugly.  Inserting \, between them avoids
           this problem.  Use this escape sequence whenever an upright
           glyph is followed immediately by an oblique glyph without any
           intervening space.


groff(7) diff is terser, and that's deliberate.


    This document is intended as a reference.  The primary groff manual,
    Groff: The GNU Implementation of troff, by Trent A. Fisher and
    Werner Lemberg, is a better resource for learners, containing many
    examples and much discussion.  It is written in Texinfo; you can
    browse it interactively with "info groff".  Additional formats,
    including plain text, HTML, DVI, and PDF, may be available in /usr/
    local/share/doc/groff-1.23.0.


I don't expect to change it to parallel the foregoing lengthy motivation.


    \/  Apply italic correction.  Use between an immediately adjacent
        oblique glyph on the left and an upright glyph on the right.
    \,  Apply left italic correction.  Use between an immediately
        adjacent upright glyph on the left and an oblique glyph on the
        right.


G. Branden Robinson <gbranden>
Group administrator
Mon 29 May 2023 05:37:08 PM UTC, comment #2: 

 I read "doc/groff.texi".

  The descriptions in "doc/groff_diff.7.man" and "man/groff.7.man"
should also be simplified.
The purpose should be added where it is missing.

Bjarni Ingi Gislason <bjarniig>
Tue 23 May 2023 08:10:09 AM UTC, comment #1: 

Which documentation file are you referring to?

G. Branden Robinson <gbranden>
Group administrator
Tue 23 May 2023 12:28:35 AM UTC, original submission:  

Subject: [docs] Simplify the explanations of "italic corrections"

  I find the explanations of the "italic corrections" (escape sequences
'\/' and '\,') too complicated and not easy to remember.

  Suggestion:

  \/

  Used to adjust space between a slanting (italic, oblique, (symbol
</>)) glyph and an upright one (symbol <|>), or pictorially: </>\/<|>.
  Or to remember: the slanting line segments are alternating and
a slanting line segment is next to <|>.

  \,

  Used to adjust space between an upright glyph (symbol <|>) an a
slanting one (symbol </>, or pictorially: <|>\,</>.
  Or to remember: the slanting line segments are alternating and
a slanting line segment is next to <|>.

Bjarni Ingi Gislason <bjarniig>

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach Files:
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by barx
  • -email is unavailable- added by gbranden (Updated the item)
  • -email is unavailable- added by bjarniig (Submitted the item)
  •  

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

    Only logged-in users can vote.

     

    Follow 6 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2023-06-23 gbranden StatusNeed Info Invalid
        Assigned toNone gbranden
        Open/ClosedOpen Closed
    2023-05-23 barx Carbon-Copy- Added barx
    2023-05-23 gbranden StatusNone Need Info
    2023-05-23 gbranden Severity3 - Normal 1 - Wish

    Back to the top

    Powered by Savane 3.13-3cd0.
    Corresponding source code