bugGNU troff - Bugs: bug #63150, [man pages] set...

 
 

bug #63150: [man pages] set summary-description terms in italics as needed

Submitter:  G. Branden Robinson <gbranden>
Submitted:  Tue 04 Oct 2022 04:19:19 AM UTC
 
Category:  General Severity:  1 - Wish
Item Group:  Documentation Status:  Fixed
Privacy:  Public Assigned to:  gbranden
Open/Closed:  Closed Planned Release:  1.23.0
* Mandatory Fields

Add a New Comment (Rich Markup)
   

Comment Type & Canned Response:
       No canned response available

 

Sat 26 Nov 2022 07:28:40 PM UTC, comment #3: 

commit 0513b50e82ccf348dfee8131b60da8865e059d4e
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date:   Thu Oct 13 04:55:52 2022 -0500

    eqn(1): Fix content and style nits.

    * Set terms in italics in summary-description (Savannah #63150).
[...]

commit 54c8efab20e4bc5b239d145c7fa9ffe70c2a15ea
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date:   Tue Oct 18 09:27:03 2022 -0500

    afmtodit(1): Fix ordering error.

    Fixes <https://savannah.gnu.org/bugs/?63228>.  Thanks to Bjarni Ingi
    Gislason for the report.

    Also set terms in italics in summary-description (Savannah #63150), and
    recast a little.

commit fa57adaf0b437315805d6cc326414c9abfb654b2
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date:   Thu Nov 3 09:59:07 2022 -0500

    groff_mdoc(7): Revise introductory subsections.

    Content:
    * Say something good about mdoc; its semantic emphasis has prevented the
      effloresence of inconsistent style markup exhibited by man(7) pages.
    * Say 'section "headings"', not "headers".  The header is formatted at
      the top of the page and is the counterpart of the footer.  A "heading"
      organizes paragraphs.
    * Introduce right-arrow notation convention so we can present examples
      more compactly.
    * Stop referring to a dot in a laborious manner.
    * Convert inline examples to use new arrow convention.
    * Refer to "words", not "strings".  "Strings" are a roff language
      element that we should not introduce in inappropriate contexts.
    * Break input lines after commas.
    * Wrap long input lines.

    Style:
    * In summary-description, mark up "roff" with `Xr`.
    * Cross reference groff(1) man page in introduction.
    * Set subsection headings in sentence case and update `Sx` cross refs.
    * Tighten wording.

commit d72b4b7b945a54093811f498739f09c647be6812
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date:   Sun Oct 30 19:44:51 2022 -0500

    [man pages]: Update summary descriptions.

    * Set names of groff programs (or "roff") and macro packages in italics.
    * Spell "grap" and "pic" in lowercase.
    * Capitalize "Gremlin" when referring to the file format.
    * Drop unnecessary input line continuation.
    * Name output driver command name instead of groff option with argument.
    * Stop implying that groff's me(7) is restricted to use with groff; it's
      supposed to work in compatibility mode, too, and therefore with other
      *roffs.

G. Branden Robinson <gbranden>
Project Administrator
Mon 10 Oct 2022 03:56:08 AM UTC, comment #2: 

commit a36281fb5d4067656c0f81701ab85ae73629d0c2
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date:   Sun Oct 9 00:11:34 2022 -0500

    pdfmom(1): Fix style nits.

    * Set terms in italics in summary-description (Savannah #63150).
    * Perform Kemper notectomy.
    * Tighten layout: if we quote a multi-word literal, there's no need to
      set it on its own line to distinguish it from its context.

commit cfb0139669405c211cf22a9a199fbf6c4be83120
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date:   Sun Oct 9 10:11:21 2022 -0500

    groff_diff(7): Fix style nits.

    * Set terms in italics in summary-description (Savannah #63150).
    * Tighten wording.

G. Branden Robinson <gbranden>
Project Administrator
Thu 06 Oct 2022 01:20:10 PM UTC, comment #1: 

commit 14e1085bcfb24789a95de6e5dbe5162e5bc46a2c
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date:   Thu Oct 6 01:10:03 2022 -0500

    grolbp(1): Fix more content and style nits.

    * Set "groff" in italics in summary-description (Savannah #63150).
    * Speak of "drawing position", not "current position".  This is groff,
      not PostScript.
    * Say "produce" or "format" instead of "print", since this program does
      not of itself cause printing to happen.
    * Clarify provenance of this man page in comment.
    * Annotate apparent limitation of supported hardware in comment.
    * Suppress hyphenation of literals.
    * Break input lines after commas.
    * Document a default in terms of the units it uses, not different ones.
    * Tighten wording.

commit c6f514e0c4372573d7a81820a3e0b52852755e47
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date:   Thu Oct 6 02:19:18 2022 -0500

    grolj4(1): Fix content, style, and markup nits.

    * Set "groff" in italics in summary-description (Savannah #63150).
    * Add subsection "Paper format and device description file"; relocate
      list of supported paper formats here from the "Options" section.
    * Add subsection "Font description files"; relocate the discussion of
      bespoke directives supported by this driver here from an unmotivated
      appendix to the "Options" section.  Try to improve the description of
      the directives' meanings.
    * Move discussion of bespoke drawing command supported by this driver
      into a new subsection, "Drawing commands".
    * Speak of "drawing position", not "current position".  This is groff,
      not PostScript.
    * Sort options into English lexicographic order.
    * Add cross reference to online copy of HP PCL 5 reference document,
      necessary if one is to make any sense of the custom directives above.
    * Tighten wording.
    * Adjust dead-tree pagination.

G. Branden Robinson <gbranden>
Project Administrator
Tue 04 Oct 2022 04:19:19 AM UTC, original submission:  

This is already underway to an extent.

Pages that still need it:

chem
eqn2graph
gdiffmk
glilypond
gperl
gpinyin
grap2graph (also why is "grap" in screaming capitals?)
groff_hdtbl
groff_mm
groff_mmse
mmroff
pdfroff
pic2graph (more screaming)
groff_char
groff_diff
groff_font
groff_tmac
grolbp
grolj4
lj4_font
gropdf
pdfmom
grops
grotty
gxditview
eqn
grn
preconv
refer
tbl
groff(1)
nroff
troff
addftinfo
afmtodit
grog
hpftodit
xtotroff
groff_man*
groff_me
groff_ms
groff_trace
groff_www

groff_mdoc is already updated in an incomplete series of major revisions to the page that I have in my Git stash.

G. Branden Robinson <gbranden>
Project Administrator

 

(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 gbranden (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 3 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2022-11-26 gbranden StatusIn Progress Fixed
        Open/ClosedOpen Closed
        Planned ReleaseNone 1.23.0

    Back to the top

    Powered by Savane 3.9