bugGNU roff - Bugs: bug #59839, Macro file providing glyph names...

 
 

bug #59839: Macro file providing glyph names based on RFC 1345

Submitter:  Dorai Sitaram <ds26gte>
Submitted:  Thu 07 Jan 2021 09:39:41 PM UTC
   
 
Category:  Macro package - others/general Severity:  3 - Normal
Item Group:  Feature change Status:  Fixed
Privacy:  Public Assigned to:  gbranden
Open/Closed:  Closed Planned Release:  1.23.0
* Mandatory Fields

Add a New Comment Rich Markup
   

Wed 03 Feb 2021 08:00:56 AM UTC, comment #1: 

Fixed.


commit 488fd61e2cfde5a12dc427f65dd5758d51b23429
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date:   Wed Feb 3 03:47:53 2021 +1100

    NEWS: Add item for rfc1345.tmac.

commit 255e628bd6afb98d74eb1d377ed4d429e24c814a
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date:   Wed Feb 3 03:32:35 2021 +1100

    [man pages]: Add references to groff_rfc1345(7).

commit 2d636e901af0f75977f7ad3bf22bcc8c879acc0d
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date:   Wed Feb 3 02:57:51 2021 +1100

    groff_rfc1345(7): Update.

    Borganically assimilate with existing groff man page style practices.

    Also supply a bit of additional content.

    * Add paragraph noting clash between some RFC 1345 mnemonics and groff
      built-in special character escapes.  Supply example and encourage user
      to research individual cases as needed.
    * Add "Files" section showing users the full path to the macro file.
    * Save and restore compatibility mode since a groff language extension
      (the \[] special character escape form) is used.
    * .TH: Use configured man page section 7 suffix instead of literal "7".
    * .TH: Add man page modification date and groff version.
    * Set section titles in sentence case.
    * Use .PP instead of blank lines for paragraphing.
    * Set file names in italics.
    * In apropos line, drop duplicate mention of groff and add reference to
      Vim digraphs.
    * Set inline examples in quotation marks as well as bold so that they
      will be obviously set off even on output devices that don't render
      bold.
    * Use .EX/.EE for displayed example instead of leading spaces.
    * Use \[rs] instead of \e.
    * Break lines at commas.
    * Use one empty request between sentences and expected breaks.
    * Use two empty requests between paragraphs and expected vertical space.
    * Demote nonstandard section "Usage" to a subsection.
    * Prevent hyphenation of Vim inline command example.
    * Add legal terms in *roff comments.
    * Add editor aid comments.

commit 36f6075496b1a574e6d3bc4cfe3f57534f106389
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date:   Wed Feb 3 02:57:02 2021 +1100

    [rfc1345]: Add smoke test.

    * contrib/rfc1345/tests/rfc1345-smoke-test.sh: Add test.
    * contrib/rfc1345/rfc1345.am (rfc1345_TESTS, TESTS, EXTRA_DIST): Run
      test.

commit f2fc5b49ddba41286384dae8016390b43a17559e
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date:   Wed Feb 3 01:54:52 2021 +1100

    [rfc1345]: Add "(Vim)" annotations to comments.

commit 5923b78c3956b4fff48163614f54640bf8a7bc05
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date:   Wed Feb 3 01:51:37 2021 +1100

    test-groff.in: Add support for rfc1345.tmac.

commit 8cbbc2d2116f002c56a8c0c5ff4cc0542a55b2e5
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date:   Wed Feb 3 01:40:07 2021 +1100

    [rfc1345]: Integrate into build system.

    Integrate rfc1345.tmac into build system.

    * contrib/rfc1345/rfc1345.am: Do it.
    * Makefile.am: Include contrib/rfc1345/rfc1345.am.

commit 574868b9242cea344f736c73cae769d458b60c9b
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date:   Tue Feb 2 19:16:54 2021 +1100

    ChangeLog: Log Dorai Sitaram's rfc1345.tmac.

commit bd634291d87bbcd2ff99fe78a534503eedf1983e
Author: Dorai Sitaram <ds26gte@yahoo.com>
Date:   Tue Feb 2 17:55:55 2021 +1100

    contrib/rfc1345: Add new macro file.

    Add new macro file that defines special characters implementing RFC 1345
    mnemonics (plus some additions from Vim, which itself uses RFC 1345 for
    its digraphs).

    Fxies <https://savannah.gnu.org/bugs/?59839>.

    [Contribution taken from https://gitlab.com/ds26gte/groff1345 at Dorai's
    invitation.  I renamed "groff_rfc1345.7" to add a ".man" suffix for
    consistency with other groff man pages in the source tree.  -- GBR]


G. Branden Robinson <gbranden>
Group administrator
Thu 07 Jan 2021 09:39:41 PM UTC, original submission:  

I've created a repo https://gitlab.com/ds26gte/groff1345 containing a macro file (plus man page) to address the issue mentioned in the groff mailing-list thread:

https://lists.gnu.org/archive/html/groff/2021-01/msg00000.html

RFC 1345 is a long list of short mnemonics describing a raft of Unicode glyphs. The file rfc1345.tmac contains escape-sequence definitions based on these mnemonics, giving a standard, intuitive way to refer to these glyphs in addition to the hex-number approach that's built into modern groff.

The two-character mnemonics of RFC 1345 are already fairly familiar to the software community because of their use as digraphs in the popular text editor Vim. RFC 1345 was last modified in 1992, and Vim has since added (just) four additional glyphs missing in the RFC. These tackle the horizonal ellipsis, and the currency symbols for euro and rouble. I've included these too, giving a total of 1696 groff glyph names.

The repo includes a draft man page groff_rfc1345.tmac. It probably requires considerable modification to suit groff style and terminology.

Thanks to Doug McIlroy for suggesting how to arrange the contribution for possible inclusion in a future groff release.

Dorai Sitaram <ds26gte>

 

(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 (Updated the item)
  • -email is unavailable- added by ds26gte (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 5 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2021-02-03 gbranden StatusIn Progress Fixed
        Open/ClosedOpen Closed
        Planned ReleaseNone 1.23.0
    2021-02-03 gbranden StatusNone In Progress
        Assigned toNone gbranden

    Back to the top

    Powered by Savane 3.14-f13d.
    Corresponding source code