bug-groff
[Top][All Lists]
Advanced

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

[bug #60929] device man pages should consistently document font repertoi


From: G. Branden Robinson
Subject: [bug #60929] device man pages should consistently document font repertoire
Date: Mon, 22 Aug 2022 08:24:21 -0400 (EDT)

Update of bug #60929 (project groff):

                  Status:                    None => In Progress            
             Assigned to:                    None => gbranden               

    _______________________________________________________

Follow-up Comment #2:

I am lazy and chewing through these in lexicographic order.

Here's some stuff pending in my working copy.


commit d68aec06c6770e2c16fc331fcee71d612d71263d
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date:   Sun Aug 21 07:20:11 2022 -0500

    grodvi(1): Organize and clarify.
    
    Impose more structure on output driver man pages (1/x).
    
    Fix content nits.
    * Discuss "interpretation" of DVI more, and "printing" less.
    * Migrate terminology: (troff) "commands" -> "escape sequences".
    * Apply terminology: (nothing) -> (troff) "escape sequences".
    * Apply terminology: "command" -> "device control" (escape sequence).
    * Migrate terminology: "drawing color" -> "stroke color".
    * Drop "Usage" section heading in favor of subsections "Typefaces",
      "Font description files", and "Drawing commands".
    * Align discussion of groff styles with grotty(1).
    * Explain "CM" abbreviation.
    * Clarify what's going on with "TR", "TI", and "CW" fonts being special
      for this output device.
    * Migrate terminology: macro files are "loaded", not "called".
    * Migrate terminology: "current position" -> "drawing position".  We
      have our own lexicon and it is not PostScript's.
    * Clarify what dvi.tmac does.
    
    Fix style nits.
    * Set "Name" section's summary-description terms in italics as needed.
    * Identify troff macro names without leading dot.
    * Recast sentence fragments to eliminate dangling colons.
    * Use active voice and imperative mood to instruct the user in the
      creation of font description files for groff.
    * Say "design size" in prose.
    * Discuss behavior of 'R' drawing command in present tense, not future.
    * Put a space between "-F' option and its argument when presenting it.
    * (Environment) Begin sentences with the paragraph tag, to economize and
      align with section "Files".
    * Use English thousands separator in large magnitude in prose.
    * Set off long restrictive adverbial phrase with commas on both sides.
    * Tighten wording.
    
    Fix markup nits.
    * Prevent hyphenation of font description file directive names.
    * Protect "troffrc" from hyphenation.
    * Migrate from macro `LP` to `P`.
    * Adjust dead-tree typography (pagination).

commit f18136cfa818381b6fcb8d336fdb8e192a9a6234
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date:   Mon Aug 22 06:44:26 2022 -0500

    grohtml(1): Organize and clarify.
    
    Impose more structure on output driver man pages (2/x).
    
    Fix content nits.
    * Explain why (most) users should only try to approach this output
      device via the groff(1) front end.
    * Document which output device is the default.
    * Parallelize introduction with that of other output drivers.
    * Correctly distinguish output "driver" from output "device" (the former
      is a program; the latter is a parameter in a programming interface).
    * Clarify what sorts of "entities" grohtml writes.
    * Add "Typefaces" subsection, replacing "Usage".  Expand discussion to
      cover the font descriptions actually shipped.
    * Add "Font description files" subsection noting parallelism of glyph
      repertoires in all fonts, an uncommon property.
    * Move discussion of runtime program dependencies into new
      "Dependencies" subsection.
    * Drop trivial and obvious example.
    * Shift discussion from HTML "tags" to "elements".  The details of
      (X)HTML markup are not relevant here.
    * Migrate terminology: "point size" -> "type size".
    * Migrate terminology: "right-justified" -> "right-aligned".
    * Flesh out "Files" section, discussing more than just temporary files.
      Align with other output driver documentation, presenting device and
      font description files, and device-specific macro files.  (The latter
      aren't _opened_ by the driver program, which is why we don't document
      GROFF_TMAC_PATH in the page, but this is most appropriate place to
      discuss them.)
    
    Fix style nits.
    * Set "Name" section's summary-description terms in italics as needed.
    * Parallelize discussion of (internal) options.  Say what they do first,
      then warn the user off.
    * Shift "only" modifiers to more appropriate syntactical locations.
    * (Environment) Begin sentences with the paragraph tag, to economize and
      align with (material being added to) section "Files".
    * Tighten wording.
    
    Fix markup nits.
    * Protect "pre-grohtml", "post-grohtml", "grohtml" from hyphenation.
    * Annotate areas where might be able to drop some text outright.  (How
      long ago did Ghostscript lack anti-aliasing support?)



    _______________________________________________________

Reply to this item at:

  <https://savannah.gnu.org/bugs/?60929>

_______________________________________________
Message sent via Savannah
https://savannah.gnu.org/




reply via email to

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