[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 02/40: doc/me{intro,ref}.me: Use consistent terminology.
From: |
G. Branden Robinson |
Subject: |
[groff] 02/40: doc/me{intro,ref}.me: Use consistent terminology. |
Date: |
Wed, 10 Feb 2021 01:32:11 -0500 (EST) |
gbranden pushed a commit to branch master
in repository groff.
commit 84d8a288b0a685fa1447dc706e567be798ac2058
Author: Dave Kemper <saint.snit@gmail.com>
AuthorDate: Thu Jan 21 03:57:34 2021 +0000
doc/me{intro,ref}.me: Use consistent terminology.
Historical and modern *roff documentation is careful to exclusively use
the term "request" for what coders more conventionally call a "command."
doc/meref.me largely follows this practice, but slips up in a couple
places, using "command" for *roff requests. This patch fixes those.
While it's at it, it fixes a few places where "request" or "command"
erroneously refers to a macro.
The situation in doc/meintro.me is trickier. This document pervasively
calls macros defined by the -me package "requests," and reserves the
term "macro" for macros the user defines in his own -me document. While
not strictly accurate, this slight muddying is consistent and probably
fine for the intended (novice) audience of this document.
The sole exception to this consistency is text I wrote that was added in
commit 7a83f7f50, which calls .bl a macro--technically accurate but
inconsistent with the rest of the document's usage. Thus this patch
changes this word to "request."
The one use of "command" in meintro.me is also changed to "request"
following similar logic.
---
doc/meintro.me | 4 ++--
doc/meref.me | 21 ++++++++++-----------
2 files changed, 12 insertions(+), 13 deletions(-)
diff --git a/doc/meintro.me b/doc/meintro.me
index b13afc5..2b0e91b 100644
--- a/doc/meintro.me
+++ b/doc/meintro.me
@@ -454,7 +454,7 @@ This request will not leave space at the top of a page.
If you need the requested space to appear regardless of page position,
use the
.b .bl
-macro, which has the same syntax as
+request, which has the same syntax as
.b .sp
but always leaves the requested space, even at the top of a page.
.pp
@@ -628,7 +628,7 @@ of the text
without quote marks
around them.
These can be generated
-using the commands
+using the requests
.b .(q
and
.b .)q
diff --git a/doc/meref.me b/doc/meref.me
index a92217b..edc7b8f 100644
--- a/doc/meref.me
+++ b/doc/meref.me
@@ -688,7 +688,7 @@ loses the function of the
.b .ef ,
and
.b .of
-requests,
+macros,
as well as the chapter-style title feature
of
.b .+c .
@@ -1090,7 +1090,7 @@ You can test register
to see if you are in single column
or double column mode.
Actually,
-the request enters
+the macro enters
.i N
[2]
column output.
@@ -1472,8 +1472,8 @@ surround the entire table
.b .TS
and
.b .TE
-requests)
-with the requests
+macros)
+with the macros
.b .(z
and
.b .)z .
@@ -1563,9 +1563,8 @@ Titles and footnotes
are unaffected.
The
.b .sh
-request performs a
+macro performs a
.b .ba
-request
if
.NR (si
[0] is not zero,
@@ -1624,7 +1623,7 @@ for this page.
.i m
.i H
.DE
-This request defines the section of the paper
+This macro defines the section of the paper
which we are entering.
The section type is defined by
.i m .
@@ -1690,7 +1689,7 @@ Each section
(chapter, appendix, etc.)
should be preceded by the
.b .+c
-request.
+macro.
It should be mentioned
that it is easier when using
\*T to put the front material
@@ -1923,16 +1922,16 @@ This alphabetical list summarizes all macros, strings,
and number registers
available in the \-me macros.
Selected
.i troff
-commands, registers, and functions are included as well;
+requests, registers, and functions are included as well;
those listed can generally be used with impunity.
.pp
The columns are the name of the
-command, macro, register, or string;
+requests, macro, register, or string;
the type of the object,
and the description.
Types are
.b M
-for macro or builtin command
+for macro or builtin request
(invoked with
.b \&.
or
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 02/40: doc/me{intro,ref}.me: Use consistent terminology.,
G. Branden Robinson <=