[groff] 26/35: [sboxes]: Fix content, style, markup nits.

[G. Branden Robinson]

gbranden pushed a commit to branch master
in repository groff.

commit 37c048e353ea300b156a26586d2ccdba92be651c
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Sun Oct 24 16:09:25 2021 +1100

    [sboxes]: Fix content, style, markup nits.
    
    Content:
    * Add comment telling readers how to format the document.  (grog doesn't
      [yet?] detect the use of supplementary packages.)
    * Advise readers that the `BOXSTART` argument pairs can be given in any
      order.
    * Refer to `pdfbackground` as a "macro", not a "command".
    
    Style:
    * Recast introduction slightly.
    * Make the opening material in the first box more like a sentence.
    * Bump `QI` register up to 8n so that the "bottom" parameter will fit as
      a paragraph tag in the first synopsis box.
    
    Markup:
    * Drop later, redundant specifications of `IP` indentation amount.
---
 contrib/sboxes/msboxes.ms.in | 17 ++++++++++-------
 1 file changed, 10 insertions(+), 7 deletions(-)

diff --git a/contrib/sboxes/msboxes.ms.in b/contrib/sboxes/msboxes.ms.in
index 5c89925..2a3934c 100644
--- a/contrib/sboxes/msboxes.ms.in
+++ b/contrib/sboxes/msboxes.ms.in
@@ -1,3 +1,4 @@
+.\" groff -ms -msboxes -Tpdf
 .nr LL 17c
 .nr PO 2c
 .nr PS 11
@@ -43,10 +44,11 @@ document formatting system,
 allows coloured rectangles to be created beneath any output created by
 .I groff .
 The extension can be accessed via a device control escape sequence
-.Lt \[rs]X\[aq]pdf:\[aq]
-(with a convenience command
+.Lt "\[rs]X\[aq]pdf: background" \~.\|.\|.\|\c
+.Lt \[aq]
+or a convenience macro
 .Lt pdfbackground
-supporting the same parameters).
+supporting the same parameters.
 .QS
 .BOXSTART SHADED cornsilk OUTLINED brown INDENT 2n WEIGHT 1p
 \M[floralwhite]\c
@@ -61,8 +63,8 @@ cmd left top right bottom weight\[aq]
 .BI
 cmd left top right bottom weight
 .LP
-where
-.IP \f[I]cmd 7n
+each produce a background rectangle on the page, where
+.IP \f[I]cmd 8n \" indent enough to fit "bottom" tag
 can be any of
 .Qq page|fill|box
 in combination.
@@ -116,7 +118,7 @@ page.
 .IP \f[I]left
 .IP \f[I]top
 .IP \f[I]right
-.IP \f[I]bottom 7n
+.IP \f[I]bottom
 .nr PD \n[oldPD]
 are the coordinates of the box.
 The
@@ -132,7 +134,7 @@ you turn the box
 The top and bottom coordinates are only used if the box drawing extends
 onto the next page, so, ordinarily they would be set to the header and
 footer margins.
-.IP \f[I]weight 7n
+.IP \f[I]weight
 If
 .Qq box
 is included in the command, then this parameter provides the line width
@@ -189,6 +191,7 @@ and each
 a valid
 .I groff
 numeric expression.
+The keyword/value pairs can be specified in any order.
 .BOXSTOP
 .QE
 Boxes can be stacked, so you can start a box within another box; usually