[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 07/12: doc/meintro*.me.in: Fix content and style nits.
From: |
G. Branden Robinson |
Subject: |
[groff] 07/12: doc/meintro*.me.in: Fix content and style nits. |
Date: |
Thu, 16 Dec 2021 07:11:23 -0500 (EST) |
gbranden pushed a commit to branch master
in repository groff.
commit bb36d9132dcdba269179e8a871ddf2771c50cf70
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Thu Dec 16 10:29:43 2021 +1100
doc/meintro*.me.in: Fix content and style nits.
Content:
* Move groff version annotation at end of document to page 1 footnote.
* Update French version to use version string generated at build time,
instead of a 20-year old groff version literal.
* Drop trademark ownership notice regarding "Unix". We don't care or
necessarily know who currently owns the mark (maybe the Open Group?),
and in any case the GNU project is not a commercial institution whose
use of trademarks in documentation constitutes a challenge to their
ownership, yadda yadda yadda.
* Drop justification for advice to not put trailing spaces on lines.
GNU nroff (and troff) are not "confused" by them, but the user might
be.
* Say "vi" instead of "ex". The former is much better known and retains
the CSRG connection.
Style:
* Add pseudo-shebang comment with formatting advice to English version.
* Set headers in mixed case, with command and package in bold italics.
* Stop setting "Unix", "groff", "nroff", and "troff" in small caps; use
italics instead.
* Set "groff" in an upright style when the context is slanted.
* Set man page title in italics, not bold, in cross references.
* In French translation, fix space before closing parenthesis. (I wade
into matters of French orthography with some trepidation, but relied
upon <https://unicode.org/udhr/n/notes_fra.html>.)
Markup:
* Set "Acknowledgements" header more straightforwardly. (I hesitate to
say "more idiomatically" because didn't Allman invent these idioms?)
* In French translation, get rid of excess inter-word spaces.
---
doc/meintro.me.in | 46 ++++++++++++++++----------------
doc/meintro_fr.me.in | 74 +++++++++++++++++++++++++---------------------------
2 files changed, 58 insertions(+), 62 deletions(-)
diff --git a/doc/meintro.me.in b/doc/meintro.me.in
index b020f5a..8dc267c 100644
--- a/doc/meintro.me.in
+++ b/doc/meintro.me.in
@@ -1,3 +1,5 @@
+.\" groff -me
+.\"
.\" Copyright (c) 1986, 1993
.\" The Regents of the University of California. All rights reserved.
.\"
@@ -37,17 +39,18 @@
.lt 6.5i
.ds MO @VERSION@
.nr si 3n
-.he 'USING GROFF AND \-ME''%'
+.he 'Using \f(BIgroff\fP and \f(BI\-me\fP''%'
.\"eh 'USD:19-%''Writing Papers with NROFF using \-me'
.\"oh 'Writing Papers with NROFF using \-me''USD:19-%'
-.ds U \s-1UNIX\s0
-.ds N \s-1NROFF\s0
-.ds T \s-1TROFF\s0
-.ds G \s-1GROFF\s0
+.ds U Unix
+.ds N \fInroff\fP
+.ds T \fItroff\fP
+.ds G \fIgroff\fP
+.ds UG groff\" upright "groff" for use in slanted contexts
.+c
.(l C
.sz 14
-.b "Writing Papers with GROFF using \-me"
+.b "Writing Papers with \f(BIgroff\fP using \f(BI\-me\fP"
.sz
.sp 2
.ul
@@ -58,18 +61,19 @@ Electronics Research Laboratory
University of California, Berkeley
Berkeley, California 94720
.sp 2
-.i "Modified for \*G by James Clark"
+.i "Modified for \fR\*(UG\fP by James Clark*"
+.(f
+* This document applies to the version of the \-me macros
+included with \*G version \*(MO.
+.)f
.)l
.sp 4
.pp
This document describes
the text processing facilities
-available on the \*U*
-.(f
-*\*U is a trademark
-of AT&T Bell Laboratories
-.)f
-operating system
+available on \*U
+and other
+operating systems
via \*G and the
\-me
macro package.
@@ -79,7 +83,7 @@ already is generally familiar
with the \*U operating system
and a text editor
such as
-.b ex .
+.i vi .
This is intended to be a casual introduction,
and
as such not all material is covered.
@@ -146,7 +150,7 @@ describes the type of
output device you are using.
A complete description of options
to the \*G command can be found in
-.b groff (1).
+.i groff (1).
.pp
The word
.i argument
@@ -268,9 +272,7 @@ since common corrections
are to add or delete sentences
or phrases.
Second,
-do not put spaces at the end of lines,
-since this can sometimes confuse the \*N
-processor.
+do not put spaces at the end of lines.
Third,
do not hyphenate words at the end of lines
(except words that should have hyphens in them,
@@ -2235,9 +2237,8 @@ Notice that you must surround
the material to be quoted
with double quote marks
if it is more than one word.
-.sh 0
-.sp 1i
-.b Acknowledgments
+.sx 0
+.uh Acknowledgments
.pp
I would like to thank
Bob Epstein,
@@ -2259,9 +2260,6 @@ most accompanied by fixes
(hence forcing me to fix several small bugs);
and the plethora of people who have contributed ideas
and have given support for the project.
-.sp 1i
-This document applies to the version of the \-me macros
-included with \*G version \*(MO.
.\" Local Variables:
.\" mode: nroff
.\" End:
diff --git a/doc/meintro_fr.me.in b/doc/meintro_fr.me.in
index a86aeb8..8327a1c 100644
--- a/doc/meintro_fr.me.in
+++ b/doc/meintro_fr.me.in
@@ -41,17 +41,18 @@
.lt 6.5i
.ds MO @VERSION@
.nr si 3n
-.he 'GROFF EN OPTION \-ME''%'
+.he '\f(BIgroff\fP en option \f(BI\-me\fP''%'
.\"eh 'USD:19-%''Writing Papers with NROFF using \-me'
.\"oh 'Writing Papers with NROFF using \-me''USD:19-%'
-.ds U \s-1UNIX\s0
-.ds N \s-1NROFF\s0
-.ds T \s-1TROFF\s0
-.ds G \s-1GROFF\s0
+.ds U Unix
+.ds N \fInroff\fP
+.ds T \fItroff\fP
+.ds G \fIgroff\fP
+.ds UG groff\" upright "groff" for use in slanted contexts
.+c
.(l C
.sz 14
-.b "Rédiger des documents avec GROFF \-me"
+.b "Rédiger des documents avec \f(BIgroff \-me\fP"
.sz
.sp 2
.ul
@@ -62,17 +63,27 @@ Electronics Research Laboratory
University of California, Berkeley
Berkeley, California 94720
.sp 2
-.i "Modifié pour \*G by James Clark"
+.i "Modifié pour \fR\*(UG\fP par James Clark*"
+.(f
+* Ce document a été
+.i \*(UG\fRé \" defeat italic correction
+le 27 octobre 2001 et s'applique à la version des macros \-me
+inclus dans la version \*(MO de \*G.
+.)f
.sp 2
-.i "Adapté au français par Grégoire Babey"
+.i "Adapté au français par Grégoire Babey\(dg"
+.(f
+\(dg La traduction française a été
+.i \*(UG\fRée \" defeat italic correction
+le 20 octobre 2013,
+toutes les commandes ont été testées sur la version 1.21 de \*G.
+.)f
.)l
.sp 2
.pp
Ce document décrit les outils de traitement de texte
-sur un système \*U\(lz
-.(f
-\(lz\*U est une marque déposée de AT&T Bell Laboratories
-.)f
+sur un système \*U
+et autres systèmes d'exploitation
fournis par \*G
et le
paquet de macros
@@ -81,8 +92,7 @@ Il présuppose que le lecteur
est déjà familiarisé avec les systèmes \*U
et un éditeur de texte
(tel que par exemple
-.b ex
-).
+.i vi ).
Son intention est d'être une introduction
simple et concrète, et par conséquent,
il ne traitera pas toute la matière disponible.
@@ -245,7 +255,7 @@ le placement des notes en bas de page au bon endroit,
et ainsi de suite.
.pp
Je peux vous donner quelques conseils
-comment préparer votre texte d'entrée pour \*G.
+comment préparer votre texte d'entrée pour \*G.
Premièrement,
écrivez des lignes d'entrée courtes.
Des lignes d'entrée courtes seront plus faciles à modifier,
@@ -257,8 +267,7 @@ chaque virgule ou point,
puisque habituellement les corrections consistent à
modifier ou supprimer des propositions ou des phrases.
Deuxièmement,
-n'ajoutez pas d'espacements à la fin des lignes,
-ceci pourrait en certains cas induire en erreur le processeur \*N.
+n'ajoutez pas d'espacements à la fin des lignes.
Troisièmement,
ne séparez pas vous-même les mots en fin de ligne
avec des traits d'union
@@ -597,7 +606,7 @@ sont précédés et suivis en sortie d'un seul espacement
vertical.
.sh 2 "Citations longues"
.pp
Les citations longues
-sont des citations qui s'étalent sur plusieurs lignes,
+sont des citations qui s'étalent sur plusieurs lignes,
elles sont donc sorties du corps de texte
et ne sont pas entourées de guillemets.
Cela peut être réalisé
@@ -609,7 +618,7 @@ entourant la citation.
Par exemple,
l'entrée:
.(b
-Comme l'indique Weizenbaum:
+Comme l'indique Weizenbaum:
\&.(q
On dit qu'expliquer, c'est expliquer en s'éloignant.
Cette maxime ne s'accomplit nulle part aussi bien
@@ -618,7 +627,7 @@ que dans le domaine de la programmation informatique,...
.)b
génère comme sortie:
.lp
-Comme l'indique Weizenbaum:
+Comme l'indique Weizenbaum:
.(q
On dit qu'expliquer, c'est expliquer en s'éloignant.
Cette maxime ne s'accomplit nulle part aussi bien
@@ -1058,7 +1067,7 @@ Cependant,
chaque élément de l'index
a un numéro de page
(ou un autre signe distinctif)
-à la fin de la dernière ligne le décrivant,
+à la fin de la dernière ligne le décrivant,
à la suite d'une rangée de points (voir ci-dessous).
.pp
Les entrées pour l'index
@@ -1215,7 +1224,7 @@ ligne s'aligne
sur les autres lignes du paragraphe.
\&.ip deux
Et ici nous sommes déjà au second paragraphe.
-Vous noterez que l'argument de \c
+Vous noterez que l'argument de \c
.b .ip
apparaît dans la marge.
\&.lp
@@ -1530,7 +1539,7 @@ en ayant recours à la requête
\&.nr si 3n
.)b
au début du fichier d'entrée,
-ce qui donne trois espacements d'indentation
+ce qui donne trois espacements d'indentation
par niveau de profondeur du chapitre.
.pp
Des numéros de chapitre
@@ -2085,7 +2094,7 @@ la requête de police:
.)b
génère
.q hardi
-en caractères gras,
+en caractères gras,
mais mettra
.q petit
dans la police du texte environnant,
@@ -2232,7 +2241,7 @@ En typographie,
pour créer des guillemets,
il est habituel
d'utiliser deux accents graves et deux accents aigus,
-plutôt que les guillemets
+plutôt que les guillemets
(`\|"\|').
C'est parce que
deux accents graves et deux accents aigus
@@ -2267,9 +2276,8 @@ générera
Notez que vous devez entourer
le texte concerné de guillemets
s'il est formé de plusieurs mots.
-.sh 0
-.sp 1i
-.b Remerciements
+.sx 0
+.uh Remerciements
.pp
J'aimerais remercier
Bob Epstein,
@@ -2291,16 +2299,6 @@ le plus souvent accompagnés de propositions de solutions
(qui m'ont donc forcé à réparer plusieurs petits bogues);
et la foule de gens qui ont contribué à ce projet
par leurs idées ou leur soutien.
-.sp 1i
-Ce document a été
-.sm GROFF é
-le 27 octobre 2001 et s'applique à la version des macros \-me
-inclus dans la version 1.17.2 de \*G.
-.sp 1i
-La traduction française a été
-.sm GROFF ée
-le 20 octobre 2013,
-toutes les commandes ont été testées sur la version 1.21 de \*G.
.(b
.uh "Annexe: petit lexique des noms de requêtes"
Par ordre d'apparition dans le texte
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 07/12: doc/meintro*.me.in: Fix content and style nits.,
G. Branden Robinson <=