gbranden pushed a commit to branch master
in repository groff.
commit 9500d6bda77d01e3a00469572b0c88e0c1ddd074
Author: G. Branden Robinson <[email protected]>
AuthorDate: Tue Aug 13 00:21:50 2024 -0500
[docs]: Revise and sync hyphenation code stuff.
---
doc/groff.texi.in | 30 +++++++++++++++---------------
man/groff_diff.7.man | 39 +++++++++++++++++++++++++++++++++------
2 files changed, 48 insertions(+), 21 deletions(-)
diff --git a/doc/groff.texi.in b/doc/groff.texi.in
index da10f7723..bbb811900 100644
--- a/doc/groff.texi.in
+++ b/doc/groff.texi.in
@@ -8949,12 +8949,12 @@ automatically hyphenate at all.
For automatic hyphenation to work, the formatter must know which letters
are equivalent; for example, the letter @samp{E} behaves like @samp{e};
only the latter typically appears in hyphenation pattern files. GNU
-@code{troff} expects characters that participate in automatic
+@command{troff} expects characters that participate in automatic
hyphenation to be assigned @dfn{hyphenation codes} that define these
-equivalence classes. At startup, GNU @code{troff} assigns hyphenation
-codes to the letters @samp{a}--@samp{z}, applies the same codes to
-@samp{A}--@samp{Z} in one-to-one correspondence, and assigns a code of
-zero to all other characters.
+equivalence classes. At startup, GNU @command{troff} assigns
+hyphenation codes to the letters @samp{a}--@samp{z}, applies the same
+codes to @samp{A}--@samp{Z} in one-to-one correspondence, and assigns a
+code of zero to all other characters.
The @code{hcode} request extends this principle to letters outside the
Unicode basic Latin alphabet; without it, words containing such letters
@@ -8984,18 +8984,18 @@ hyphenation codes to the letters @samp{
.hcode � �
@endExample
-Without these assignments, GNU @code{troff} treats the German word
+Without these assignments, GNU @command{troff} treats the German word
@w{`Kinderg�rten'} (the plural form of `kindergarten') as two words
@w{`kinderg'} and @w{`rten'} because the hyphenation code of the
umlaut@tie{}a is zero by default, just like a space. There is a German
-hyphenation pattern that covers @w{`kinder'}, so GNU @code{troff} finds
-the hyphenation `kin-der'. The other two hyphenation points
+hyphenation pattern that covers @w{`kinder'}, so GNU @command{troff}
+finds the hyphenation `kin-der'. The other two hyphenation points
(`kin-der-g�r-ten') are missed.
-If for some reason you desire to remove a character's hyphenation code,
-use @code{hcode} to copy the code of a punctuation character to it; for
-example, @samp{.hcode � $} assigns a hyphenation code of zero to
-@samp{�} (unless @samp{$} has already been assigned a different one).
+To remove a character's hyphenation code, copy the code of a character
+with a hyphenation code value of zero to it. For example, @samp{.hcode
+� $} removes the hyphenation code from @samp{�} (unless @samp{$} has
+already been assigned a different one).
The @code{phcode} request may be helpful to troubleshoot hyphenation
code assignments. @xref{Debugging}.
@@ -17042,9 +17042,9 @@ or for instrumentation while troubleshooting. The
@code{ex} and
exit codes respectively, to halt further processing when continuing
would be fruitless. Examine the state of the formatter with requests
that write lists of defined names (macros, strings, and diversions),
-colors, composite characters, environments, hyphenation exceptions,
-registers, page location traps, and a list of output nodes corresponding
-to the pending input line to the standard error stream.
+colors, composite characters, environments, hyphenation codes and
+exceptions, registers, page location traps, and a list of output nodes
+corresponding to the pending input line to the standard error stream.
@c END Keep parallel with section "Debugging" of groff(7).
@Defreq {lf, line [@Var{file}]}
diff --git a/man/groff_diff.7.man b/man/groff_diff.7.man
index 3e3dbf81b..e4eed9709 100644
--- a/man/groff_diff.7.man
+++ b/man/groff_diff.7.man
@@ -285,12 +285,39 @@ GNU
.I troff \" GNU
will not perform automatic hyphenation.
.
+.
+.P
+For automatic hyphenation to work,
+the formatter must know which letters are equivalent;
+for example,
+the letter \[lq]E\[rq] behaves like \[lq]e\[rq];
+only the latter typically appears in hyphenation pattern files.
+.
+GNU
+.I troff \" GNU
+expects characters that participate in automatic hyphenation to be
+assigned
+.I "hyphenation codes"
+that define these equivalence classes.
+.
+At startup,
+GNU
+.I troff \" GNU
+assigns hyphenation codes to the letters \[lq]a\[rq]\[en]\[lq]z\[rq],
+applies the same codes to \[lq]A\[rq]\[en]\[lq]Z\[rq]
+in one-to-one correspondence,
+and assigns a code of zero to all other characters.
+.
+.
+.P
The
.B hcode
-request assigns values to character codes such that they can be handled
-consistently by the hyphenation patterns,
-for instance by treating accented letters the same as their unaccented
-counterparts.
+request extends this principle to letters
+outside the Unicode basic Latin alphabet;
+without it,
+words containing such letters
+won't be hyphenated properly
+even if the corresponding hyphenation patterns contain them.
.
.
.P
@@ -2923,8 +2950,8 @@ to
.RI code\~ d ,
and so on.
.
-Character codes that would otherwise be invalid in
-.I groff
+Character codes that would otherwise be invalid in GNU
+.I troff \" GNU
can be used.
.
By default,
_______________________________________________
Groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
