gbranden pushed a commit to branch master
in repository groff.
commit feca051ab958f1ae4f3fa7640bc9ba754b7d1b4d
Author: G. Branden Robinson <[email protected]>
AuthorDate: Sat Feb 3 20:32:18 2024 -0600
[docs]: Update discussion of composite characters.
Parallelize discussion among documents. Migrate away from term "glyph"
for this usage; I am attempting to reform groff terminology such that a
"glyph" is only drawn by an output device font.
---
doc/groff.texi | 20 +++++++++++---------
man/groff.7.man | 14 ++++++++------
man/groff_char.7.man | 49 ++++++++++++++++++++++++++++---------------------
man/groff_diff.7.man | 4 ++--
4 files changed, 49 insertions(+), 38 deletions(-)
diff --git a/doc/groff.texi b/doc/groff.texi
index 04aa89d52..8d2e7c1c5 100644
--- a/doc/groff.texi
+++ b/doc/groff.texi
@@ -11071,16 +11071,18 @@ characters with @samp{]} in their names. The
delimiter need not be
a neutral apostrophe; see @ref{Delimiters}.
@endDefesc
-@Defreq {composite, id1 id2}
+@Defreq {composite, c1 c2}
@pindex composite.tmac
-Map special character name @var{id1} to @var{id2} if @var{id1} is used
-in @code{\[...]} with more than one component. See above for examples.
-This is a strict rewriting of the special character name; no check is
-performed for the existence of a glyph for either. A set of default
-mappings for many accents can be found in the file
-@file{composite.tmac}, loaded by the default @file{troffrc} at startup.
-
-You can obtain a report of colors defined by @code{composite} on the
+Map ordinary or special character name @var{c1} to @var{c2} when
+@var{c1} is a combining component in a composite character. See above
+for examples. This is a strict rewriting of the special character name;
+no check is performed for the existence of a glyph for either.
+Typically, @code{composite} is used to map a spacing character to a
+combining one. A set of default mappings for many accents can be found
+in the file @file{composite.tmac}, loaded by the default @file{troffrc}
+at startup.
+
+You can obtain a report of mappings defined by @code{composite} on the
standard error stream with the @code{pcomposite} request.
@xref{Debugging}.
@endDefreq
diff --git a/man/groff.7.man b/man/groff.7.man
index a43ff60a6..48d77631c 100644
--- a/man/groff.7.man
+++ b/man/groff.7.man
@@ -2820,12 +2820,14 @@ enable them.
.\" XXX: Should probably interpret negative values as false.
.
.TPx
-.REQ .composite "from to"
-Map glyph name
-.I from
-to glyph name
-.I to
-while constructing a composite glyph name.
+.REQ .composite "c1 c2"
+Map ordinary or special character
+.I c1
+to
+.I c2
+when
+.I c1
+is a combining component in a composite character.
.
.TPx
.REQ .continue
diff --git a/man/groff_char.7.man b/man/groff_char.7.man
index 8f89cea50..b70e1a88a 100644
--- a/man/groff_char.7.man
+++ b/man/groff_char.7.man
@@ -10,7 +10,7 @@ special character and glyph repertoire
.\" Legal Terms
.\" ====================================================================
.\"
-.\" Copyright (C) 1989-2023 Free Software Foundation, Inc.
+.\" Copyright (C) 1989-2024 Free Software Foundation, Inc.
.\"
.\" This file is part of groff (GNU roff), which is a free software
.\" project.
@@ -760,8 +760,33 @@ as in the word \[lq]caf\[e aa]\[rq],
can be expressed as
.BR "\[rs][e aa]" .
.
-See subsection \[lq]Accents\[rq] below for a table of combining glyph
-names.
+.
+.P
+Normally,
+the formatter advances the drawing position after setting a special
+character,
+as it does for ordinary ones.
+.
+.IR groff 's
+.B \%composite
+request designates a special character as combining,
+suppressing advancement.
+.
+.
+.P
+You can obtain a report of mappings defined by the
+.B \%composite
+request on the standard error stream with the
+.B \%pcomposite
+request.
+.
+The
+.I \%composite.tmac
+macro file,
+loaded automatically by the default
+.IR \%troffrc ,
+maps certain special characters to combining characters as shown
+in subsection \[lq]Accents\[rq] below.
.
.
.P
@@ -1095,24 +1120,6 @@ L Lf(CR) L Lx.
.SS Accents
.\" ====================================================================
.
-Normally,
-the formatter advances the drawing position after setting a special
-character,
-as it does for ordinary ones.
-.
-.IR groff 's
-.B composite
-request designates a special character as combining,
-suppressing advancement.
-.
-The
-.I \%composite.tmac
-macro file,
-loaded automatically by the default
-.IR \%troffrc ,
-maps the following special characters to the combining characters shown
-below.
-.
The non-combining code point in parentheses is used when the special
character occurs in isolation
(compare
diff --git a/man/groff_diff.7.man b/man/groff_diff.7.man
index e7fec69b5..1bc8cb788 100644
--- a/man/groff_diff.7.man
+++ b/man/groff_diff.7.man
@@ -2093,9 +2093,9 @@ See
.
.TP
.BI .composite\~ c1\~c2
-Map character name
+Map ordinary or special character
.I c1
-to character name
+to
.I c2
when
.I c1
_______________________________________________
Groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
