gbranden pushed a commit to branch master
in repository groff.
commit fbd56caab7f420d8a8e159e87557a5d798b38ca1
Author: G. Branden Robinson <[email protected]>
AuthorDate: Fri Mar 22 21:11:30 2024 -0500
[mdoc]: Rename `doc-page-topic`* strings.
* tmac/mdoc/doc-common ([initialization], Dt, Os, doc-header,
doc-footer, doc-reset-titles, Rd):
* tmac/mdoc/doc-ditroff:
* tmac/mdoc/doc-nroff: Rename string `doc-page-topic` to
`doc-page-identifier` and `doc-page-topic-font` to
`doc-topic-identifier-font`, following terminological reform in
groff_mdoc(7) (and groff_man(7)).
---
ChangeLog | 10 ++++++++++
tmac/doc.tmac | 4 ++--
tmac/mdoc/doc-common | 28 ++++++++++++++--------------
tmac/mdoc/doc-ditroff | 2 +-
tmac/mdoc/doc-nroff | 2 +-
5 files changed, 28 insertions(+), 18 deletions(-)
diff --git a/ChangeLog b/ChangeLog
index 295c63adb..7f2d3348d 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,13 @@
+2024-03-22 G. Branden Robinson <[email protected]>
+
+ * tmac/mdoc/doc-common ([initialization], Dt, Os, doc-header,
+ doc-footer, doc-reset-titles, Rd):
+ * tmac/mdoc/doc-ditroff:
+ * tmac/mdoc/doc-nroff: Rename string `doc-page-topic` to
+ `doc-page-identifier` and `doc-page-topic-font` to
+ `doc-topic-identifier-font`, following terminological reform in
+ groff_mdoc(7) (and groff_man(7)).
+
2024-03-22 G. Branden Robinson <[email protected]>
* src/preproc/eqn/main.cpp (main): Fix missing space in
diff --git a/tmac/doc.tmac b/tmac/doc.tmac
index ef9d5a048..62aff7eaa 100644
--- a/tmac/doc.tmac
+++ b/tmac/doc.tmac
@@ -3785,7 +3785,7 @@ macro
. ds doc-volume-name-saved "\*[doc-volume-name]
. nr doc-have-author-saved \n[doc-have-author]
.
-. ds doc-page-topic-saved "\*[doc-page-topic]
+. ds doc-page-identifier-saved "\*[doc-page-identifier]
. ds doc-volume-saved "\*[doc-volume]
. ds doc-section-saved "\*[doc-section]
. ds doc-operating-system-saved "\*[doc-operating-system]
@@ -3926,7 +3926,7 @@ macro
. ds doc-volume-name "\*[doc-volume-name-saved]
. nr doc-have-author \n[doc-have-author-saved]
.
-. ds doc-page-topic "\*[doc-page-topic-saved]
+. ds doc-page-identifier "\*[doc-page-identifier-saved]
. ds doc-volume "\*[doc-volume-saved]
. ds doc-section "\*[doc-section-saved]
. ds doc-operating-system "\*[doc-operating-system-saved]
diff --git a/tmac/mdoc/doc-common b/tmac/mdoc/doc-common
index ffa37c9de..cb6af42e5 100644
--- a/tmac/mdoc/doc-common
+++ b/tmac/mdoc/doc-common
@@ -252,10 +252,10 @@
.
.\" header assembly macros
.
-.\" NS doc-page-topic global string
+.\" NS doc-page-identifier global string
.\" NS the title of the manual page
.
-.ds doc-page-topic UNTITLED\"
+.ds doc-page-identifier UNTITLED\"
.
.
.\" NS doc-volume global string
@@ -341,7 +341,7 @@
.\" NS document title
.\" NS
.\" NS modifies:
-.\" NS doc-page-topic
+.\" NS doc-page-identifier
.\" NS doc-section
.\" NS doc-volume
.\" NS
@@ -466,10 +466,10 @@
. if !\n[.$] \
. doc-warn .Dt directive expects one or more arguments
. if !"\$1"" \
-. ds doc-page-topic "\$1
+. ds doc-page-identifier "\$1
.
. if \n[CT] \
-. stringup doc-page-topic
+. stringup doc-page-identifier
.
. if !"\$2"" \{\
. ds doc-section \$2
@@ -995,7 +995,7 @@
. doc-set-up-titles
.
. if '\*[.T]'pdf' \{\
-. ds doc-page-tag "\*[doc-page-topic](\*[doc-section])\"
+. ds doc-page-tag "\*[doc-page-identifier](\*[doc-section])\"
. pdfbookmark -T "\*[doc-page-tag]" 1 "\*[doc-page-tag]"
. rm doc-page-tag
. \}
@@ -1028,23 +1028,23 @@
.
.eo
.de doc-header
-. ds doc-xref \*[doc-page-topic-font]\*[doc-page-topic]\f[]\"
+. ds doc-xref \*[doc-page-identifier-font]\*[doc-page-identifier]\f[]\"
. as doc-xref \*[doc-page-section-font](\*[doc-section])\f[]\"
-. ds doc-abbv \*[doc-page-topic]\"
+. ds doc-abbv \*[doc-page-identifier]\"
. ev doc-env-dh
. doc-setup-page-layout
. ie \n[cR] .pl +1v
. el .sp |(.5i - .5m)
-. nr doc-reg-dh \w'\*[doc-page-topic-font]\*[doc-xref]\f[]'
+. nr doc-reg-dh \w'\*[doc-page-identifier-font]\*[doc-xref]\f[]'
. nr doc-reg-dh1 \w'\*[doc-volume]'
. if (\n[doc-reg-dh] + \n[doc-reg-dh1] + \n[doc-reg-dh] >= \n[.lt]) \{\
. while (\n[doc-reg-dh] + \n[doc-reg-dh1] + \n[doc-reg-dh] >= \n[.lt]) \{\
-. ds doc-xref \*[doc-page-topic-font]\*[doc-abbv]\f[]\"
+. ds doc-xref \*[doc-page-identifier-font]\*[doc-abbv]\f[]\"
. as doc-xref \*[doc-page-section-font](\*[doc-section])\f[]\"
. length doc-abbv-len-prev \*[doc-abbv]
. substring doc-abbv 0 -2
. length doc-abbv-len \*[doc-abbv]
-. nr doc-reg-dh \w'\*[doc-page-topic-font]\*[doc-abbv]\|.\|.\|.\f[]'
+. nr doc-reg-dh \w'\*[doc-page-identifier-font]\*[doc-abbv]\|.\|.\|.\f[]'
. \" If header string didn't actually get shorter, stop trying.
. if (\n[doc-abbv-len-prev] <= \n[doc-abbv-len]) \
. break
@@ -1084,7 +1084,7 @@
.
.eo
.de doc-footer
-. ds doc-xref \*[doc-page-topic-font]\*[doc-page-topic]\f[]\"
+. ds doc-xref \*[doc-page-identifier-font]\*[doc-page-identifier]\f[]\"
. as doc-xref \*[doc-page-section-font](\*[doc-section])\f[]\"
. ds doc-page-id \n[%]
. if r X \{\
@@ -1143,7 +1143,7 @@
.de doc-reset-titles
. \" Reset strings to reduce info leaks from one man page to the next.
. ds doc-date-string UNDATED\"
-. ds doc-page-topic UNTITLED\"
+. ds doc-page-identifier UNTITLED\"
. ds doc-volume LOCAL\"
. ds doc-section \" empty
. ds doc-operating-system \" empty
@@ -1737,7 +1737,7 @@
. tm doc-volume-name == '\*[doc-volume-name]'
. tm doc-have-author == \n[doc-have-author]
.
-. tm doc-page-topic == '\*[doc-page-topic]'
+. tm doc-page-identifier == '\*[doc-page-identifier]'
. tm doc-volume == '\*[doc-volume]'
. tm doc-section == '\*[doc-section]'
. tm doc-operating-system == '\*[doc-operating-system]'
diff --git a/tmac/mdoc/doc-ditroff b/tmac/mdoc/doc-ditroff
index 56c6e60c7..8b8f5421d 100644
--- a/tmac/mdoc/doc-ditroff
+++ b/tmac/mdoc/doc-ditroff
@@ -51,7 +51,7 @@
.
.\" the 'doc-xx-font' strings must not be empty!
.
-.ds doc-page-topic-font \f[I]
+.ds doc-page-identifier-font \f[I]
.ds doc-page-section-font \f[R]
.ds doc-Ad-font \f[I]
.ds doc-Ar-font \f[CI]
diff --git a/tmac/mdoc/doc-nroff b/tmac/mdoc/doc-nroff
index 47d0d9946..bbb4d42d1 100644
--- a/tmac/mdoc/doc-nroff
+++ b/tmac/mdoc/doc-nroff
@@ -43,7 +43,7 @@
.
.\" the 'doc-xx-font' strings must not be empty!
.
-.ds doc-page-topic-font \f[I]
+.ds doc-page-identifier-font \f[I]
.ds doc-page-section-font \f[R]
.ds doc-Ad-font \f[I]
.ds doc-Ar-font \f[I]
_______________________________________________
Groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit