gbranden pushed a commit to branch master
in repository groff.
commit 47ddd1ee831e480c1351e887d19132bbc36e8469
Author: G. Branden Robinson <[email protected]>
AuthorDate: Sat May 9 08:48:38 2026 -0500
doc/groff.texi.in: Fix ti request desc style nits.
* Recast.
* Apply Texinfo `@Var` macro (defined by this document) to the request
argument in first synopsis.
* Favor footnotes over inlining for forward references.
* Break input lines in places convenient for roffing and diffing.
---
doc/groff.texi.in | 52 ++++++++++++++++++++++++++++++++++++++--------------
1 file changed, 38 insertions(+), 14 deletions(-)
diff --git a/doc/groff.texi.in b/doc/groff.texi.in
index cf0310761..503172777 100644
--- a/doc/groff.texi.in
+++ b/doc/groff.texi.in
@@ -12008,22 +12008,46 @@ The indentation amount is associated with the
environment
(@pxref{Environments}).
@endDefreq
-@DefreqList {ti, offset}
-@DefreqItem {ti, @t{+}@Var{offset}}
-@DefreqItem {ti, @t{-}@Var{offset}}
+@cindex temporary indentation
+@cindex indentation, temporary
+@DefreqList {ti, [@Var{amount}]}
+@DefreqItem {ti, [@t{+}@Var{amount}]}
+@DefreqItem {ti, [@t{-}@Var{amount}]}
@DefregListEndx {.in}
-Temporarily indent the next output line by @var{offset}; if @var{offset}
-is signed, adjust the temporary indentation relative to the value set by
-the @code{in} request. The default scaling unit is @samp{m}. This
-request causes a break.
-
-The effect of @code{ti} is delayed until a partially collected line (if
-it exists) is output. In other words, it does not change a pending
-output line's indentation.
+Temporarily indent the next output line by
+@var{amount};
+if
+@var{amount}
+is signed,
+apply it as an offset to the indentation configured by the
+@code{in}
+request.
+The default scaling unit is
+@samp{m}.
+This request causes a break.
+The effect of
+@code{ti}
+is delayed until a partially collected line
+(if it exists)
+is output.
+In other words,
+it does not change a pending output line's indentation.
+The read-only register
+@code{.in}
+reports the indentation that applies to the pending output line.
+The temporary indentation is associated
+with the environment.@footnote{@xref{Environments}.}
-The read-only register @code{.in} reports the indentation that applies
-to the pending output line. The temporary indentation is associated
-with the environment (@pxref{Environments}).
+@cindex first-line indentation, of paragraph
+@cindex indentation, first line, of paragraph
+@cindex hanging paragraph
+@cindex paragraph, hanging
+The idiomatic application of the
+@code{ti}
+request is invocation by a paragraphing macro
+to set up a first-line indentation,
+of positive sign in the conventional case,
+and negative for a ``hanging'' paragraph.
@endDefreq
@DefreqList {ll, [@Var{length}]}
_______________________________________________
groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
