[latexrefman-commits] r474 - in /trunk: ChangeLog latex2e-fr.texi latex2e.texi
vincent.b.1 at domain.hid
vincent.b.1 at domain.hid
Mon Nov 9 07:38:19 CET 2015
Author: vincentb1
Date: Mon Nov 9 07:38:18 2015
New Revision: 474
URL: http://svn.gna.org/viewcvs/latexrefman?rev=474&view=rev
Log:
* latex2e.texi (\newcommand & \renewcommand): Introduce the
concept of positional parameter.
(\newenvironment & \renewenvironment): Remove the text that
starred & nonstarred forms have the same effect, and restore the
original text that starred forms ban the use of \par in arguments.
Tell that the only allowed characters in environment names are
letters and character `*'. Use the term positional parameter, and
tell that expansion is within begdefn, not within environment,
which was misleading. @samp{...}-ify `Shakespear' outside of
@example... at domain.hid.
* latex2e-fr.texi (Output files): Typo.
(tabular): Typoes.
(\newcommand & \renewcommand): Typo. Introduce the concept of positional parameter.
(\newenvironment & \renewenvironment): Complete the translation
and make the same text improvements as in latex2e.texi.
Modified:
trunk/ChangeLog
trunk/latex2e-fr.texi
trunk/latex2e.texi
Modified: trunk/ChangeLog
URL: http://svn.gna.org/viewcvs/latexrefman/trunk/ChangeLog?rev=474&r1=473&r2=474&view=diff
==============================================================================
--- trunk/ChangeLog (original)
+++ trunk/ChangeLog Mon Nov 9 07:38:18 2015
@@ -1,3 +1,22 @@
+2015-11-09 Vincent Belaïche <vincentb1 at domain.hid>
+
+ * latex2e.texi (\newcommand & \renewcommand): Introduce the
+ concept of positional parameter.
+ (\newenvironment & \renewenvironment): Remove the text that
+ starred & nonstarred forms have the same effect, and restore the
+ original text that starred forms ban the use of \par in arguments.
+ Tell that the only allowed characters in environment names are
+ letters and character `*'. Use the term positional parameter, and
+ tell that expansion is within begdefn, not within environment,
+ which was misleading. @samp{...}-ify `Shakespear' outside of
+ @example... at domain.hid.
+
+ * latex2e-fr.texi (Output files): Typo.
+ (tabular): Typoes.
+ (\newcommand & \renewcommand): Typo. Introduce the concept of positional parameter.
+ (\newenvironment & \renewenvironment): Complete the translation
+ and make the same text improvements as in latex2e.texi.
+
2015-11-06 Vincent Belaïche <vincentb1 at domain.hid>
* latex2e-fr.texi (\parbox): Tell that `position=m' equates the
Modified: trunk/latex2e-fr.texi
URL: http://svn.gna.org/viewcvs/latexrefman/trunk/latex2e-fr.texi?rev=474&r1=473&r2=474&view=diff
==============================================================================
--- trunk/latex2e-fr.texi (original)
+++ trunk/latex2e-fr.texi Mon Nov 9 07:38:18 2015
@@ -366,7 +366,7 @@
@cindex renvoi en aval, résolution
@cindex renvoi, résolution
De l'information auxiliaire est utilisée par @LaTeX{} pour des choses
-telles que les doubles renvois. Par exempel, la première fois que
+telles que les doubles renvois. Par exemple, la première fois que
@LaTeX{} trouve un renvoi en aval --- une double référence Ã
quelque-chose qui n'est pas encore apparu dans le code source --- il
apparâtra dans la sortie comme un double point d'interrogation
@@ -3407,7 +3407,7 @@
@item \arraystretch
Un facteur par lequel l'espacement entre les lignes au sein des
environnement @code{tabular} et @code{array} est multiplié. La valeur
-par défaut is @samp{1} pour aucune dilatation/contraction. On peut la
+par défaut est @samp{1} pour aucune dilatation/contraction. On peut la
changer comme dans @code{\renewcommand at domain.hid@}}.
@item \doublerulesep
@@ -3415,7 +3415,7 @@
le spécificateur @code{||}.
@c - vincentb1 pourquoi supprimer le texte: au sein des environnements
@c - @code{tabular} et @code{array}
-La valeur par défaut is @samp{2pt}.
+La valeur par défaut est @samp{2pt}.
@item \tabcolsep
Une longueur qui est la moitié de l'espace entre les colonnes. La valeur
@@ -4413,7 +4413,7 @@
que commande prend. Par défaut la commande n'a pas d'arguments.
@item optarg
-Si ce paramètre optionnel is present, il signifie que le premier
+Si ce paramètre optionnel est present, il signifie que le premier
argument de la commande est optionnel. La valeur par défaut de
l'argument optionnel (c.-à -d., s'il n'est pas spécifié dans l'appel) est
@var{optarg}, ou, si cet argument est present dans le @code{\newcommand}
@@ -4421,7 +4421,7 @@
@item defn
Le texte par lequel substituer chaque occurrence de @code{cmd}Â ; une
-constructio de la forme @code{#@var{n}} au sein de @var{defn} est remplacée par le
+construction de la forme @code{#@var{n}} au sein de @var{defn} est remplacée par le
texte passé comme @var{n}ième argument.
@end table
@@ -4493,48 +4493,135 @@
@cindex defining new environnements
@cindex redefining environnements
+Ces commandes définissent ou redéfinissent un environnement @var{env},
+c.-Ã -d., @code{\begin at domain.hid}@} @var{corps} \end at domain.hid}@}}.
+
Synopsis :
@example
- \newenvironment[*]@{@var{env}@}[@var{nargs}][@var{défaut}]@{@var{begdef}@}@{@var{enddef}@}
-\renewenvironment[*]@{@var{env}@}[@var{nargs}]@{@var{begdef}@}@{@var{enddef}@}
- at domain.hid example
-
-Ces commandes définissent ou redéfinissent un environnement @var{env},
-c.-Ã -d., @code{\begin at domain.hid}@} @dots{} \end at domain.hid}@}}.
+ \newenvironment at domain.hid}@}
+ \newenvironment*@{@var{env}@}[@var{nargs}][@var{argoptdéfaut}]@{@var{défdébut}@}@{@var{déffin}@}
+\renewenvironment at domain.hid}@}
+\renewenvironment*@{@var{env}@}[@var{nargs}]@{@var{défdébut}@}@{@var{déffin}@}
+ at end example
+
@table @var
@item @code{*}
@cindex forme étoilée des commandes d'environnement
@cindex forme en * des commandes d'environnement
La forme étoilée de ces commandes exige que les arguments (à ne pas
-confondre avec le contenu de l'environnement) ne contiennent pas de
+confondre avec le corps de l'environnement) ne contiennent pas de
paragraphes de texte.
@item env
- at domain.hid The name of l'environnement. For @code{\newenvironment}, @var{env}
- at domain.hid must not be an existing environnement, and la commande @code{\@var{env}}
- at domain.hid must be undefined. For @code{\renewenvironment}, @var{env} must be
- at domain.hid the name of an existing environnement.
+Obligatoire ; le nom de l'environnement. Il est constitué seulement de
+lettres ou du caractère astérisque @code{*}, et donc ne commence pas par
+une contr'oblique @code{\}. Il ne doit pas commencer par la chaîne
+ at code{end}. Pour @code{\newenvironment}, @var{env} ne doit pas être le
+nom d'un environnement déjà existant, et la commande @code{\@var{env}}
+ne doit pas être définie. Pour @code{\renewenvironment}, @var{env} doit
+être le nom d'un environnement déjà existant.
@item nargs
- at domain.hid An integer from 1 to 9 denoting the nombre of arguments of
- at domain.hid the newly-defined environnement. The défaut is no arguments.
-
- at domain.hid défaut
- at domain.hid If this is spécifié, the first argument is optionnel, and @var{défaut}
- at domain.hid gives the défaut value for that argument.
- at domain.hid
- at domain.hid begdef
- at domain.hid The texte expanded at every occurrence of @code{\begin at domain.hid}@}}; un
- at domain.hid construct of the forme @code{#@var{n}} in @var{begdef} is replaced by
- at domain.hid the texte of the @var{n}th argument.
-
- at domain.hid enddef
- at domain.hid The texte expanded at every occurrence of @code{\end at domain.hid}@}}. il
- at domain.hid may not contain any argument paramètres.
+Optionnel ; un entier de 1 à 9 indiquant le nombre d'arguments of que
+l'environnement attend. Ces argumentsz apparaissent après le
+ at code{\begin}, comme dans
+ at code{\begin at domain.hid}@}}. Si cet
+argument n'est pas présent, alors par défaut l'environment n'attend pas
+d'argument. Lorsqu'on redéfinit un environment, la nouvelle version peut
+prendre un nombre différent d'arguments que la précédente.
+
+
+
+ at item argoptdéfaut
+Optionnel ; si cet argument est présent alors le premier argument de
+l'environnement en définition est optionel, et sa valeur par défaut est
+ at var{argoptdéfaut} (éventuellement une chaîne vide). Si cet argument
+n'est pas présent alors l'environnement ne prend pas d'argument
+optionnel.
+
+c.-à -d.@: que si @code{[@var{argoptdéfaut}]} est présent dans la
+définition de l'environnement, et que @code{\begin at domain.hid}@}} est
+utilisé avec des crochets à la suite, comme dans
+ at code{\begin at domain.hid}]}, alors, au sein de
+ at var{défdébut}, le paramètre positionnel @code{#1} se développe en
+ at var{maval}. Si par contre @code{\begin at domain.hid}@}} est appéelé sans
+être suivi de crochet, alors, au sein de @var{défdébut}, le
+ at cindex paramètre positionnel
+paramètre positionnel @code{#1} se développe en la valeur par défaut,
+c.-à -d.@: @var{optargdefault}. Dans les deux cas, le premier paramètre
+positionnel faisant référence à argument oblgigatoire est @code{#2}.
+
+Omettre @code{[@var{maval}]} dans l'appel est différent d'avoir des
+crochets sans contenu, c.-Ã -d.@: @code{[]}. Dans le premier cas
+ at code{#1} se développe en @var{argoptdéfaut}, et dans le second en une
+chaîne vide.
+
+ at item défdébut
+Obligatoire ; le texte qui est développé à toute occurrence de
+ at code{\begin at domain.hid}@}} ; le @var{n}ième argument positionnel,
+c.-à -d.@: une construction de la forme @code{#@var{n}}, est remplacé au
+sein de @var{défdébut} par le texte du @var{n}ième argument.
+
+ at item déffin
+Obligatoire ; le texte développé à toute occurrence de
+ at code{\end at domain.hid}@}}. Notez qu'il ne doit contenir aucun paramètre
+positionnel, ainsi @code{#@var{n}} ne peut pas être utilisé ici.
@end table
+
+L'environnement @var{env} délimites la portée du résultat du
+développement de @var{débutdéf} et de @var{findéf}. Ansi, dans le
+premier exemple ci-dessous, l'effet de @code{\small} est limité à la
+citation et ne s'étend pas au matériel qui suit l'environnement.
+
+Cet exemple dont un environnement semblable à @code{quotation} de
+ at LaTeX{} à cece près qu'il sera composé dans une taille de police plus
+petite.
+
+ at example
+\newenvironment at domain.hid@}@{%
+ \small\begin at domain.hid@}
+@}@{%
+ \end at domain.hid@}
+@}
+ at end example
+
+Ceci montre l'utilisation des arguments ; cela done un environment de
+citation qui affiche l'auteur.
+
+ at example
+\newenvironment at domain.hid]@{%
+ \begin at domain.hid@}
+ \noindent\textit at domain.hid@}:
+@}@{%
+ \end at domain.hid@}
+@}
+ at end example
+
+ at noindent Le nom de l'auteur est optionnel, et vaut par défaut @samp{Corneille}.
+Dans le document, utilisez l'environnement comme ici :
+
+ at example
+\begin at domain.hid, roi des Francs]
+ ..
+\end at domain.hid@}
+ at end example
+
+Ce dernier exemple montre comment sauvegarder la valeur d'un argument
+pour l'utiliser dans @var{findéf}.
+
+ at example
+\newsavebox at domain.hid@}
+\newenvironment at domain.hid]@{%
+ \sbox\quoteauthor at domain.hid@}%
+ \begin at domain.hid@}
+@}@{%
+ \hspace at domain.hid plus 1fill at domain.hid@}
+ \end at domain.hid@}
+@}
+ at end example
@node \newtheorem
Modified: trunk/latex2e.texi
URL: http://svn.gna.org/viewcvs/latexrefman/trunk/latex2e.texi?rev=474&r1=473&r2=474&view=diff
==============================================================================
--- trunk/latex2e.texi (original)
+++ trunk/latex2e.texi Mon Nov 9 07:38:18 2015
@@ -4973,9 +4973,11 @@
@var{\cmd} does not take an optional argument.
That is, if @var{\cmd} is used with square brackets following, as in
- at domain.hid}]}, then within @var{defn} @code{#1} expands
- at domain.hid}. While if @var{\cmd} is called without square brackets
-following, then within @var{defn} the @code{#1} expands to the default
+ at code{\@var{cmd}[@var{myval}]}, then within @var{defn} the first
+ at cindex positional parameter
+ at dfn{positional parameter} @code{#1} expands @var{myval}. While if
+ at var{\cmd} is called without square brackets following, then within
+ at var{defn} the positional parameter @code{#1} expands to the default
@var{optargdefault}. In either case, any required arguments will be
referred to starting with @code{#2}.
@@ -4985,9 +4987,9 @@
@code{#1} expanding to the empty string.
@item defn
-The text to be substituted for every occurrence of @code{cmd}; a
-construct of the form @code{#@var{n}} in @var{defn} is replaced by the
-text of the @var{n}th argument.
+The text to be substituted for every occurrence of @code{cmd}; the
+positional parameter @code{#@var{n}} in @var{defn} is replaced by
+the text of the @var{n}th argument.
@end table
@@ -5146,7 +5148,7 @@
@cindex redefining environments
These commands define or redefine an environment @var{env}, that is,
- at domain.hid}@} @dots{} \end at domain.hid}@}}. Synopses:
+ at code{\begin at domain.hid}@} @var{body} \end at domain.hid}@}}. Synopses:
@example
\newenvironment at domain.hid}@}
@@ -5155,13 +5157,17 @@
\renewenvironment*@{@var{env}@}[@var{nargs}][@var{optargdefault}]@{@var{begdefn}@}@{@var{enddefn}@}
@end example
-Unlike @code{\newcommand} and @code{\renewcommand}, the @code{*}-forms
- at domain.hid*} and @code{\renewcommand*} have the same effect
-as the forms with no @code{*}.
@table @var
+ at item @code{*}
+ at cindex @code{*}-form of environment commands
+The @code{*}-form of these commands requires that the arguments (not
+the @var{body} of the environment) not contain multiple paragraphs of
+text.
+
@item env
-Required; the environment name. It does not begin with backslash
+Required; the environment name. It consists only of letters or the
+ at code{*} character, and thus does not begin with backslash
(@code{\}). It must not begin with the string @code{end}. For
@code{\newenvironment}, the name @var{env} must not be the name of an
already existing environment, and also the command @code{\@var{env}}
@@ -5185,12 +5191,14 @@
That is, when @code{[@var{optargdefault}]} is present in the environment
definition, if @code{\begin at domain.hid}@}} is used with square brackets
-following, as in @code{\begin at domain.hid}]}, then within
-the environment @code{#1} expands @var{myval}. If
+following, as in @code{\begin at domain.hid}]}, then, within
+ at var{begdefn}, the
+ at cindex positional parameter
+positional parameter @code{#1} expands to @var{myval}. If
@code{\begin at domain.hid}@}} is called without square brackets following,
-then within the environment the @code{#1} expands to the default
- at domain.hid}. In either case, any required arguments will be
-referred to starting with @code{#2}.
+then, within within @var{begdefn}, the positional parameter @code{#1}
+expands to the default @var{optargdefault}. In either case, any
+required arguments will be referred to starting with @code{#2}.
Omitting @code{[@var{myval}]} in the call is different from having the
@@ -5238,7 +5246,7 @@
@}
@end example
- at domain.hid The author's name is optional, and defaults to Shakespeare.
+ at noindent The author's name is optional, and defaults to @samp{Shakespeare}.
In the document, use the environment as here:
@example
More information about the latexrefman-commits
mailing list