[latexrefman-commits] [SCM] latexrefman updated: r576 - trunk
vincentb1 at gnu.org.ua
vincentb1 at gnu.org.ua
Tue Aug 1 12:31:44 CEST 2017
Author: vincentb1
Date: 2017-08-01 13:31:44 +0300 (Tue, 01 Aug 2017)
New Revision: 576
Modified:
trunk/ChangeLog
trunk/latex2e-fr.texi
trunk/latex2e.texi
Log:
Translate Jim's r562 & Karl's r574 + some fixes in latex2e.texi.
* latex2e-fr.texi (document header): update copyright for
translation.
(About this document, Class and package commands): Translate
Karl's r574 edits of 2017-07-31.
(Environment, Declaration, \makeatletter and \makeatother)
(\@@startsection,\@@ifstar): put a sectionning title to node.
(\@@startsection): Complete translation of Jim's r562 of
2017-07-26 for this node, w/o moving the node under node
Sectionning.
(Sectioning): Add anchor to secnumdepth counter for reference from
\@@startsection node.
* latex2e.texi (Environment, Declaration, \makeatletter and \makeatother)
(\@@ifstar, \@@startsection): put a sectionning title to node.
(\@@ifstar): @cindex star-variants with key star-variants.
(Sectioning): Add anchor to secnumdepth counter for reference from
\@@startsection node.
(\@@startsection): Reword the explanation of redefining \section
as \@@startsection and how \section keeps is standard calling form
when redefined. heading -> title for consistency. @code{}-ify
class names, book, report & article. Use anchor to
secnumdepth. Typoes. rubber -> typically rubber. Solve overfully
hbox in example by not repeating explanations in examplified LaTeX
comments, rather make a simple link. style [...] file -> package
[...] file. redefined [...] sectional units -> redefined [...]
sectional unit title commands.
(Class and package commands): Amend Karl's r574 edit of
2017-07-31, `When a document is processed using that class' ->
`When a document using that class is processed', as one usually
specify the class in the document itself, not on the command line,
although the latter is possible.
Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog 2017-07-31 21:53:02 UTC (rev 575)
+++ trunk/ChangeLog 2017-08-01 10:31:44 UTC (rev 576)
@@ -1,3 +1,38 @@
+2017-08-01 Vincent Belaïche <vincentb1 at users.sourceforge.net>
+
+ * latex2e.texi (Environment, Declaration, \makeatletter and \makeatother)
+ (\@@ifstar, \@@startsection): put a sectionning title to node.
+ (\@@ifstar): @cindex star-variants with key star-variants.
+ (Sectioning): Add anchor to secnumdepth counter for reference from
+ \@@startsection node.
+ (\@@startsection): Reword the explanation of redefining \section
+ as \@@startsection and how \section keeps is standard calling form
+ when redefined. heading -> title for consistency. @code{}-ify
+ class names, book, report & article. Use anchor to
+ secnumdepth. Typoes. rubber -> typically rubber. Solve overfully
+ hbox in example by not repeating explanations in examplified LaTeX
+ comments, rather make a simple link. style [...] file -> package
+ [...] file. redefined [...] sectional units -> redefined [...]
+ sectional unit title commands.
+ (Class and package commands): Amend Karl's r574 edit of
+ 2017-07-31, `When a document is processed using that class' ->
+ `When a document using that class is processed', as one usually
+ specify the class in the document itself, not on the command line,
+ although the latter is possible.
+
+
+ * latex2e-fr.texi (document header): update copyright for
+ translation.
+ (About this document, Class and package commands): Translate
+ Karl's r574 edits of 2017-07-31.
+ (Environment, Declaration, \makeatletter and \makeatother)
+ (\@@startsection,\@@ifstar): put a sectionning title to node.
+ (\@@startsection): Complete translation of Jim's r562 of
+ 2017-07-26 for this node, w/o moving the node under node
+ Sectionning.
+ (Sectioning): Add anchor to secnumdepth counter for reference from
+ \@@startsection node.
+
2017-07-31 Vincent Belaïche <vincentb1 at users.sourceforge.net>
* latex2e-fr.texi (Class and package commands): Add \CheckCommand
Modified: trunk/latex2e-fr.texi
===================================================================
--- trunk/latex2e-fr.texi 2017-07-31 21:53:02 UTC (rev 575)
+++ trunk/latex2e-fr.texi 2017-08-01 10:31:44 UTC (rev 576)
@@ -59,7 +59,7 @@
@cite{@TeX{}niques} numéro 10), il l'a utilisé en tant que matériel de
référence (aucun texte n'était directement copié).
-Tous droits réservés @copyright{} 2015, 2016 Vincent Belaïche --- traduction.@*
+Tous droits réservés @copyright{} 2015-2017 Vincent Belaïche --- traduction.@*
Tous droits réservés @copyright{} 2007, 2008, 2009, 2010, 2011, 2012, 2013,
2014, 2015, 2016 Karl Berry. @*
Tous droits réservés @copyright{} 1988, 1994, 2007 Stephen Gilmore. @*
@@ -207,7 +207,7 @@
@cindex @LaTeX{} ou @LaTeX{}2e, que choisir ?
Dans ce document, on utilise principalement juste le terme « @LaTeX{} »
plutôt que « @LaTeX{}2e », étant donné que la version précédente de
- at LaTeX{} (2.09) a été congédiée il y a bien des années.
+ at LaTeX{} (2.09) est gelée depuis des dizaines d'années.
@cindex officieuse, nature de ce document
@cindex L'équipe de projet @LaTeX{}
@@ -240,8 +240,10 @@
@item http://ctan.org/pkg/usrguide
@findex usrguide @r{documentation officielle}
-Le guide pour les auteurs de documents maintenu par le projet @LaTeX{}Â ; lÃ
-plusieurs autres.
+Le guide pour les auteurs de documents maintenu par le projet
+ at LaTeX{}. Bien d'autres guides écrits par bien d'autres gens sont aussi
+disponibles, indépendamment du projet @LaTeX{} ; l'article suivant en
+est un.
@item http://ctan.org/pkg/lshort
@findex lshort @r{document}
@@ -579,6 +581,7 @@
@node Environment
+ at subsection Les environnements
Synopsis :
@@ -620,6 +623,7 @@
@node Declaration
+ at subsection Les déclarations de commandes
Une commande qui change la valeur, ou change la signification, d'une
autre commande ou paramètre. Par exemple, la commande @code{\mainmatter}
@@ -627,6 +631,7 @@
romains à des numéros arabes.
@node \makeatletter and \makeatother
+ at subsection @code{\makeatletter} et @code{\makeatother}
Synopsis :
@@ -695,6 +700,7 @@
@node \@@startsection
+ at subsubsection @code{\@@startsection}
Synopsis :
@@ -714,76 +720,201 @@
d'utiliser la commande @code{\secdef}.
@c xx define, and make a cross reference to, secdef.
- at c ##################################################
- at c xxx TODO continuer à prendre en compte r562.
-
-Par ex.@: le code source ci-dessous, si placé dans le préambule,
-redéfinit la commande de rubricage @code{\section} pour qu'elle centre
-le titre, le mette en gras, et ajuste l'espacement :
-
+Techniquement, cette commande a la forme :
@example
-\makeatletter
-\renewcommand\section@{%
- \@@startsection@{section@}% @ref{\@@startsection/name,Nom}
- @{1@}% @ref{\@@startsection/level,Niveau} : 0=part, 1=chapter, etc.
- @{0pt@}% @ref{\@@startsection/retrait,Renfoncement du titre}
- @{-3.5ex plus -1ex minus -.2ex@}% @ref{\@@startsection/beforeskip,Saut vertical avant (pas de renfoncement si négatif)}
- @{2.3ex plus.2ex@}% @ref{\@@startsection/afterskip,Saut vertical après (si négatifif at comma{} fait corps avec la suite)}
- @{\centering\normalfont\Large
- \bfseries@}@}% @ref{\@@startsection/style,Style du titre}
-\makeatother
+\@@startsection@{@var{nom}@}@{@var{niveau}@}@{@var{retrait}@}@{@var{avant}@}@{@var{après}@}@{@var{style}@}
+ *[@var{titretdm}]@{@var{titre}@}
@end example
+ at noindent de sorte que faire :
+ at example
+\renewcommand@{\section@}@{\@@startsection@{@var{nom}@}@{@var{niveau}@}@{@var{retrait}@}%
+ @{@var{avant}@}@{@var{après}@}@{@var{style}@}@}
+ at end example
+ at noindent redéfinit @code{\section} en gardant sa forme standarde d'appel
+ at code{\section*[@var{titretdm}]@{@var{titre}@}}. @xref{Sectioning} et
+les exemples plus bas.
-La commande @code{\@@startsection} prend six arguments.
@table @var
@item nom
- at anchor{\@@startsection/name}
-Nom de la commande de rubricage, par ex.@: @code{paragraph}
+ at anchor{\@@startsection/name} Nom du compteur (qui doit être défini
+séparément) utilisé pour numéroter le titre de rubrique. Ceux le plus
+communément utilisés sont @code{section}, @code{subsection}, ou
+ at code{paragraph}. Bien que dans ces trois cas le nom du compteur soit le
+même que celui de la commande elle-même, utiliser le même nom n'est pas
+exigé.
+Alors @code{\the}@var{name} affiche le numéro de titre, et
+ at code{\}@var{name}@code{mark} sert aux en-têtes de page.
+
@item niveau
- at anchor{\@@startsection/level} Profondeur de la commande de
-rubricage, par ex.@: 0 pour @code{part}, 1 pour @code{chapter}, 2
-pour @code{section}. Cette valeur est comparée aux compteurs
- at code{secnumdepth} et @code{tocdepth} pour contrôler la numéroation des
-rubriques et la profondeur de la table des matières.
+ at anchor{\@@startsection/level} Un entier donnant la profondeur de la
+commande de rubricage, par ex.@: 0 pour @code{chapter} (ceci ne
+s'applique qu'aux classes standardes @code{book} et @code{report}), 1
+pour @code{section}, 2 pour @code{subsection}, 3 pour
+ at code{subsubsection}, 4 pour @code{paragraph} et 5 pour
+ at code{subparagraph}. Dans les classes @code{book} et @code{report},
+ at code{part} a pour niveau -1, alors que dans la classe @code{article},
+ at code{part} a pour niveau 0.
+Si @var{niveau} est inférieur ou égal à la valeur de @code{secnumdepth}
+alors les titres pour cette commande de rubricage sont numérotés. Par
+ex.@: dans un @code{article}, si @code{secnumdepth} vaut 1 alors une
+commande @code{\section@{Introduction@}} produira en sortie quelque
+chose du genre de @code{1 Introduction} alors que
+ at code{\subsection@{Historique@}} produit en sortie quelque chose du
+genre de @code{Historique}, sans numéro en
+préfixe. @xref{Sectioning/secnumdepth}.
+
+Si @var{niveau} est inférieur ou égal à la valeur de @code{secnumdepth}
+alors la table des matières aura un article pour cette rubrique. Par
+exemple, dans un @code{article}, si @code{tocdepth} vaut 1 alors la
+table des matières listera les @code{section}s, mais pas les
+ at code{subsection}s.
+
+
@item retrait
- at anchor{\@@startsection/retrait}Renfoncement du titre. Pour un
-renfoncement nul, vous pouvez utiliser la macro @code{\z@@} définie Ã
- at code{0pt} pour que le code soit plus efficace.
+ at anchor{\@@startsection/indent}Une longueur donnant le renfoncement de
+toutes les lignes du titre relativement à la marge. Pour un
+renfoncement nul, utilisez @code{0pt}.
+ at c vous pouvez utiliser la macro @code{\z@@} définie à @code{0pt} pour
+ at c que le code soit plus efficace
+Une valeur négative telle que @code{-1em} cause un débord du titre dans
+la marge.
@item avant
- at anchor{\@@startsection/beforeskip}
-Longueur dont la valeur absolue est la longueur de l'espace vertical Ã
-insérer avant le titre. Pour une bonne composition, utilisez une
-longueur élastique.
+ at anchor{\@@startsection/beforeskip} Longueur dont la valeur absolue est
+la longueur de l'espace vertical à insérer avant le titre de la
+rubrique. Cet espacement est ignoré si la rubrique commence au début
+d'une page. Si en plus @var{avant} est négatif, alors le premier
+paragraphe suivant immédiatement le titre n'est pas renfoncé, s'il est
+positif ou nul il l'est. (Notez que l'opposé de @code{1pt plus 2pt
+minus 3pt} est @code{-1pt plus -2pt minus -3pt}).
-Si en plus @var{avant} est négatif, alors le premier paragraphe suivant
-immédiatement le titre n'est pas renfoncé.
+Par exemple si @var{avant} vaut @code{-3.5ex plus -1ex minus -0.2ex}
+alors pour commencer la nouvelle rubrique, @LaTeX{} ajoute environ 3,5
+fois la hauteur d'une lettre x en espace veritical, et le premier
+paragraphe de la rubrique n'est pas renfoncé. Utiliser une longueur
+élastique, c.-à -d.@: comprenant @code{plus} et @code{minus}, est une
+bonne pratique ici car cela donne à @LaTeX{} plus de latitude lors de la
+fabrication de la page.
+La quantité totale d'espace vertical entre la ligne de base de la ligne
+précédant le titre de cette rubrique est la ligne de base du titre est
+la somme du @code{\parskip} dans la police du corps de texte, du
+ at code{\baselineskip} de la police du titre, et de la valeur absolue de
+l'argument @var{avant}. Cet espace est typiquement élastique et peut se
+dilater ou se contracter. (Si la rubrique commence en début d'une page
+de sorte que cet espace soit ignoré, alors la ligne de base du titre
+correspond à la ligne de base qu'aurait la première ligne de texte sur
+cette page si celle-ci commençait par du texte).
+
@item après
- at anchor{\@@startsection/afterskip} Longueur. Lorsque elle est positive,
-il s'agit de l'espace verticale à insérer après le titre. Pour une
-bonne composition, utilisez dans ce cas une longueur élastique.
+ at anchor{\@@startsection/afterskip} Longueur. Lorsque elle est positive
+ou nulle, il s'agit de l'espace vertical à insérer après le titre de la
+rubrique. Lorsque elle est négative, alors le titre fait corps avec le
+paragraphe le suivant immédiatement. Dans ce cas la valeur absolue de
+la longueur donne l'espace horizontal entre la fin du titre et le début
+du paragraphe suivant. (Notez que l'opposé de @code{1pt plus 2pt minus
+3pt} est @code{-1pt plus -2pt minus -3pt}).
+Comme c'est le cas avec @var{avant}, utiliser une longueur élastique
+avec des composantes @code{plus} et @code{minus} est une bonne pratique
+ici puisque elle donne à @LaTeX{} plus de latitude pour assembler la
+page.
-Lorsque elle est négative, alors le titre fait corps avec le paragraphe
-le suivant immédiatement, comme c'est le cas pour les rubriques
- at code{\paragraph} dans la classe de document @code{article}, et la
-valeur absolue d'@var{après} donne l'espace horizontale entre la fin du
-dernier mot du titre et le début du premier mot du paragraphe avec
-lequel il fait corps.
+Si @var{après} est positif ou nul alors la quantité totale d'espace
+vertical entre la ligne de base du titre de la rubrique et la ligne de
+base de la première ligne du paragraphe suivant est la somme du
+ at code{\parskip} de la police du titre, de @code{\baselineskip} de la
+police du corps de texte, et de la valeur de @var{après}. Cet espace est
+typiquement élastique de sorte qu'il puisse se dilater ou se
+contracter. (Notez que du fait que le signe d'@var{après} contrôle que
+le titre soit indépendant du texte le suivant, ou fasse corps avec lui,
+vous ne pouvez pas utiliser un @var{après} négatif pour annuler une
+partie du @code{\parskip}).
-
@item style
- at anchor{\@@startsection/style} Les commandes qui règlent le style du
-titre, par ex.@: @code{\bfseries} pour des caractères gras.
+ at anchor{\@@startsection/style} Contrôle le style du titre, voir les
+exemples plus bas. Les commandes typiquement utilisées ici sont
+ at code{\centering}, @code{\raggedright}, @code{\normalfont},
+ at code{\hrule}, ou @code{\newpage}. La dernière commande au sein de
+ at var{style} peut être une commande prenant un argument, telle que
+ at code{\MakeUppercase} ou @code{\fbox}. Le titre de la rubrique est passé
+en argument à cette commande. Par exemple régler @var{style} Ã
+ at code{\bfseries\MakeUppercase} a pour effet de produire des titres gras
+et en capitales.
@end table
+Voici des exemples. Pour les utiliser mettez les soit au sein d'un
+fichier de paquetage ou de classe, ou placez les dans le préambule d'un
+document @LaTeX{} entre des commandes @code{\makeatletter} et
+ at code{\makeatother}. (Le message d'erreur @code{You can't use
+`\spacefactor' in vertical mode.} est le plus probable lorsque on
+oublie de faire cela). @xref{\makeatletter and \makeatother}.
+
+L'exemple suivant redéfinit la commande de rubricage @code{\section}
+pour qu'elle centre le titre et le mette en gras :
+
+ at example
+\renewcommand\section@{%
+ \@@startsection@{section@}% @ref{\@@startsection/name, at var{nom}, at var{nom}}.
+ @{1@}% @ref{\@@startsection/level, at var{niveau}, at var{niveau}}.
+ @{0pt@}% @ref{\@@startsection/indent, at var{retrait}, at var{retrait}}.
+ @{-3.5ex plus -1ex minus -.2ex@}% @ref{\@@startsection/beforeskip, at var{avant}, at var{avant}}.
+ @{2.3ex plus.2ex@}% @ref{\@@startsection/afterskip, at var{après}, at var{après}}.
+ @{\centering\normalfont\Large\bfseries@}@}% @ref{\@@startsection/style, at var{style}, at var{style}}.
+ at end example
+
+Cet exemple met les titres de @code{subsection} en petites capitales, et
+leur fait faire corps avec le paragraphe suivant.
+
+ at example
+\renewcommand\subsection@{%
+ \@@startsection@{subsection@}% @ref{\@@startsection/name, at var{nom}, at var{nom}}.
+ @{2@}% @ref{\@@startsection/level, at var{niveau}, at var{niveau}}.
+ @{0em@}% @ref{\@@startsection/indent, at var{retrait}, at var{retrait}}.
+ @{-1ex plus 0.1ex minus -0.05ex@}% @ref{\@@startsection/beforeskip, at var{avant}, at var{avant}}.
+ @{-1em plus 0.2em@}% @ref{\@@startsection/afterskip, at var{après}, at var{après}}.
+ @{\scshape@}% @ref{\@@startsection/style, at var{style}, at var{style}}.
+ @}
+ at end example
+
+Les exemples précédents redéfinissait les commandes de titre de
+rubriques existantes. celui-ci en définit une nouvelle, illustrant la
+nécessité d'un compteur et de macros pour son affichage.
+
+ at c From https://groups.google.com/forum/#!searchin/comp.text.tex/startsection%7Csort:relevance/comp.text.tex/sB-nTS-oL08/ZZeKYdG0llMJ
+ at example
+\setcounter@{secnumdepth@}@{6@}% affiche les compteur justqu'Ã ce niveau
+\newcounter@{subsubparagraph@}[subparagraph]% compteur pour la
+ % numérotation
+\renewcommand@{\thesubsubparagraph@}%
+ @{\thesubparagraph.\@@arabic\c@@subsubparagraph@}% comment afficher
+ % la numérotation
+\newcommand@{\subsubparagraph@}@{\@@startsection
+ @{subsubparagraph@}%
+ @{6@}%
+ @{0em@}%
+ @{\baselineskip@}%
+ @{0.5\baselineskip@}%
+ @{\normalfont\normalsize@}@}
+\newcommand*\l@@subsubparagraph%
+ @{\@@dottedtocline@{6@}@{10em@}@{5em@}@}% pour la table des matières
+\newcommand@{\subsubparagraphmark@}[1]@{@}% pour les en-têtes de page
+ at end example
+
+
+
@node \@@ifstar
+ at subsubsection @code{\@@ifstar}
+ at findex \@@ifstar
+ at cindex commandes, variantes étoilées
+ at cindex étoilées, variantes de commandes
+
+
@c Inpirée des trucs & astuces de Manuel Pégourié-Gonnard
@c (https://elzevir.fr/imj/latex/tips.html#stared)
@@ -1409,14 +1540,15 @@
@item \NeedsTeXFormat@{@var{format}@}[@var{date du format}]
@findex \NeedsTeXFormat
-Spécifie le format sous lequelle cette classe devrait être utilisée.
-Cette directive est souvent donnée à la première ligne du fichier de
-classe, et le plus souvent elle est utilisée de cette façon :
- at code{\NeedsTeXFormat@{LaTeX2e@}}. Le format que vous spécifiez doit
-s'accorder exactement à celui installé et invoqué sur votre système, y
-compris le fait que la chaîne @var{format} est sensible à la casse. Si
-il ne s'y accorde pas alors l'exécution est interrompue par une erruer
-du genre de @samp{This file needs format `xxx' but this is `LaTeX2e'.}
+Spécifie le format sous lequelle cette classe doit être utilisée. Cette
+directive est souvent donnée à la première ligne du fichier de classe,
+et le plus souvent elle est utilisée de cette façon :
+ at code{\NeedsTeXFormat@{LaTeX2e@}}. Lorsque un document utilisant cette
+classe est traité, le nom du format donné ici doit s'accorder avec le
+format qui est en cours d'exécution (y compris le fait que la chaîne
+ at var{format} est sensible à la casse). Si il ne s'y accorde pas alors
+l'exécution est interrompue par une erruer du genre de @samp{This file
+needs format `LaTeX2e' but this is `xxx'.}
Pour spécifier une version du format dont vous savez qu'elle prend en
charge certaines fonctions, incluez l'argument optionnel @var{date du
@@ -1425,9 +1557,7 @@
Si la version de format installée sur votre système est antérieur à la
@var{date du format} alors vous obtiendrez un avertissement du genre de
@samp{You have requested release `2038/01/20' of LaTeX, but only release
-`2016/02/01' is available.} (Le noyeau @LaTeX{} est gelé depuis de
-noùbreuses années alors vous n'avez probablement pas besoin de spécifier
-la date du format.)
+`2016/02/01' is available.}
@item \OptionNotUsed
@findex \OptionNotUsed
@@ -2445,6 +2575,7 @@
@findex secnumdepth @r{counter}
@cindex numéros de rubrique, composition
+ at anchor{Sectioning/secnumdepth}
Le compteur @code{secnumdepth} contrôle la composition des numéros de
rubrique. le paramètre
Modified: trunk/latex2e.texi
===================================================================
--- trunk/latex2e.texi 2017-07-31 21:53:02 UTC (rev 575)
+++ trunk/latex2e.texi 2017-08-01 10:31:44 UTC (rev 576)
@@ -513,6 +513,7 @@
@node Environment
+ at subsection Environments
Synopsis:
@@ -553,6 +554,7 @@
@node Declaration
+ at subsection Command declarations
A command that changes the value, or changes the meaning, of some other
command or parameter. For instance, the @code{\mainmatter} command
@@ -560,6 +562,7 @@
@node \makeatletter and \makeatother
+ at subsection @code{\makeatletter} and @code{\makeatother}
Synopsis:
@@ -621,8 +624,11 @@
@node \@@ifstar
+ at subsubsection @code{\@@ifstar}
+
@findex \@@ifstar
@cindex commands, star-variants
+ at cindex star-variants, commands
Synopsis:
@@ -1247,8 +1253,8 @@
@findex \NeedsTeXFormat
Specifies the format that this class must be run under. Often issued
as the first line of a class file, and most often used as:
- at code{\NeedsTeXFormat@{LaTeX2e@}}. When a document is processed using
-that class, the format name given here must match the format that is
+ at code{\NeedsTeXFormat@{LaTeX2e@}}. When a document using that class is
+processed, the format name given here must match the format that is
actually being run (including that the @var{format} string is case
sensitive). If it does not match then execution stops with an error
like @samp{This file needs format `LaTeX2e' but this is `xxx'.}
@@ -2504,6 +2510,7 @@
@findex secnumdepth @r{counter}
@cindex section numbers, printing
+ at anchor{Sectioning/secnumdepth}
The @code{secnumdepth} counter controls printing of section numbers.
The setting
@@ -2521,6 +2528,8 @@
@node \@@startsection
+ at section @code{\@@startsection}
+
@findex \@@startsection
@cindex section, redefining
@@ -2541,12 +2550,19 @@
make such a command you may want to use the @code{\secdef} command.
@c xx define, and make a cross reference to, secdef.
-Technically, this command has the form
- at code{\@@startsection@{@var{name}@}@{@var{level}@}@{@var{indent}@}@{@var{beforeskip}@}@{@var{afterskip}@}@{@var{style}@}*[@var{altheading}]@{@var{heading}@}},
-so that issuing @code{\renewcommand@{\section@{\@@startsection ...@}@}}
-will make @code{\section} have the form
- at code{\section*[@var{altheading}]@{@var{heading}@}}. @xref{Sectioning}
-and the examples below.
+Technically, this command has the form:
+ at example
+\@@startsection@{@var{name}@}@{@var{level}@}@{@var{indent}@}@{@var{beforeskip}@}@{@var{afterskip}@}@{@var{style}@}
+ *[@var{toctitle}]@{@var{title}@}
+ at end example
+ at noindent so that issuing:
+ at example
+\renewcommand@{\section@}@{\@@startsection@{@var{name}@}@{@var{level}@}@{@var{indent}@}%
+ @{@var{beforeskip}@}@{@var{afterskip}@}@{@var{style}@}@}
+ at end example
+ at noindent redefine @code{\section} while keeping its standard calling form
+ at code{\section*[@var{toctitle}]@{@var{title}@}}. @xref{Sectioning} and
+the examples below.
@table @var
@@ -2557,39 +2573,40 @@
in those three cases the name of the counter is also the name of the
sectioning command itself, using the same name is not required.
-Then @code{\the}@var{name} displays the heading number and
+Then @code{\the}@var{name} displays the title number and
@code{\}@var{name}@code{mark} is for the page headers.
@item level
@anchor{\@@startsection/level} An integer giving the depth of the
sectioning command: 0 for @code{chapter} (only applies to the standard
-book and report classes), 1 for @code{section}, 2 for @code{subsection},
-3 for @code{subsubsection}, 4 for @code{paragraph}, and 5 for
- at code{subparagraph}. In the book and report classes @code{part} has
-level -1, while in the @code{article} class @code{part} has level 0.
+ at code{book} and @code{report} classes), 1 for @code{section}, 2 for
+ at code{subsection}, 3 for @code{subsubsection}, 4 for @code{paragraph},
+and 5 for @code{subparagraph}. In the @code{book} and @code{report}
+classes @code{part} has level -1, while in the @code{article} class
+ at code{part} has level 0.
If @var{level} is less than or equal to the value of @code{secnumdepth}
-then the headings for this sectioning command will be numbered. For
-instance, in an article, if @var{secnumdepth} is 1 then a
+then the titles for this sectioning command will be numbered. For
+instance, in an @code{article}, if @code{secnumdepth} is 1 then a
@code{\section@{Introduction@}} command will produce output like @code{1
Introduction} while @code{\subsection@{History@}} will produce output
-like @code{History}, without the number prefix.
- at c xx add, and cross reference to, secnumdepth
+like @code{History}, without the number
+prefix. @xref{Sectioning/secnumdepth}.
If @var{level} is less than or equal to the value of @var{tocdepth} then
-the table of contents will have an entries for this sectioning unit.
-For instance, in an article, if @var{tocdepth} is 1 then the table of
+the table of contents will have an entrie for this sectioning unit.
+For instance, in an @code{article}, if @var{tocdepth} is 1 then the table of
contents will list sections but not subsections.
@c xx add, and cross reference to, tocdepth
@item indent
@anchor{\@@startsection/indent} A length giving the indentation of all
-of the heading lines with respect to the left margin. To have the
-heading flush with the margin use @code{0pt}. A negative indentation
-such as @code{-1em} will move the heading into the left margin.
+of the title lines with respect to the left margin. To have the
+title flush with the margin use @code{0pt}. A negative indentation
+such as @code{-1em} will move the title into the left margin.
@item beforeskip
- at anchor{\@@startsection/beforeskip} The absolute value this length is
+ at anchor{\@@startsection/beforeskip} The absolute value of this length is
the amount of vertical space that is inserted before this sectioning
unit's title. This space will be discarded if the sectioning unit
happens to start at the top of a fresh page. If this number is negative
@@ -2608,11 +2625,12 @@
The full accounting of the vertical space between the baseline of the
line prior to this sectioning unit's header and the baseline of the
header is that it is the sum of the @code{\parskip} of the text font,
-the @code{\baselineskip} of the heading font, and the absolute value of
-the @var{beforeskip}. This space is rubber so it may stretch or shrink.
-(If the sectioning unit starts on a fresh page so that the vertical
-space is discarded then the baseline of the header text will be where
- at LaTeX{} would put the baseline of the first text line on that page.)
+the @code{\baselineskip} of the title font, and the absolute value of
+the @var{beforeskip}. This space is typically rubber so it may stretch
+or shrink. (If the sectioning unit starts on a fresh page so that the
+vertical space is discarded then the baseline of the header text will be
+where @LaTeX{} would put the baseline of the first text line on that
+page.)
@item afterskip
@anchor{\@@startsection/afterskip} This is a length. If @var{afterskip}
@@ -2631,63 +2649,64 @@
If @code{afterskip} is non-negative then the full accounting of the
vertical space between the baseline of the sectioning unit's header and
the baseline of the first line of the following paragraph is that it is
-the sum of the @code{\parskip} of the heading font, the
+the sum of the @code{\parskip} of the title font, the
@code{\baselineskip} of the text font, and the value of @var{after}.
-That space is rubber so it may stretch or shrink. (Note that because
-the sign of @code{afterskip} changes the sectioning unit header's from
-standalone to run-in, you cannot use a negative @code{afterskip} to
-cancel part of the @code{\parskip}.)
+That space is typically rubber so it may stretch or shrink. (Note that
+because the sign of @code{afterskip} changes the sectioning unit
+header's from standalone to run-in, you cannot use a negative
+ at code{afterskip} to cancel part of the @code{\parskip}.)
@item style
@anchor{\@@startsection/style} Controls the styling of the title. See
the examples below. Typical commands to use here are @code{\centering},
@code{\raggedright}, @code{\normalfont}, @code{\hrule}, or
- at code{\newpage}. The last command in this argument may be one such as
+ at code{\newpage}. The last command in @var{style} may be one such as
@code{\MakeUppercase} or @code{\fbox} that takes one argument. The
-section heading will be supplied as the argument to this command. For
+section title will be supplied as the argument to this command. For
instance, setting @var{style} to @code{\bfseries\MakeUppercase} would
-produce headings that are bold and upper case.
+produce titles that are bold and upper case.
@end table
-Here are examples. To use them, either put them in a style or class
+Here are examples. To use them, either put them in a package or class
file, or put them in the preamble of a @LaTeX{} document between a
- at code{\makeatletter} command and a @code{\makeatother}!. (Probably the
+ at code{\makeatletter} command and a @code{\makeatother}. (Probably the
error message @code{You can't use `\spacefactor' in vertical mode.}
-means that you forgot this. @xref{\makeatletter and \makeatother}.
+means that you forgot this.) @xref{\makeatletter and \makeatother}.
This will put section titles in large boldface type, centered.
@example
\renewcommand\section@{%
- \@@startsection@{section@}% @ref{\@@startsection/name,name of counter}
- @{1@}% @ref{\@@startsection/level,sectioning level}: 1=chapter, 2=section, 3=subsection
- @{0pt@}% @ref{\@@startsection/indent,indent from left margin}
- @{-3.5ex plus -1ex minus -.2ex@}% @ref{\@@startsection/beforeskip,vert space (no par indent if negative)}
- @{2.3ex plus.2ex@}% @ref{\@@startsection/afterskip,vert space after (run-in if negative)}
- @{\centering\normalfont\Large\bfseries@}% @ref{\@@startsection/style,style of header}
+ \@@startsection@{section@}% @ref{\@@startsection/name, at var{name}, at var{name}}.
+ @{1@}% @ref{\@@startsection/level, at var{level}, at var{level}}.
+ @{0pt@}% @ref{\@@startsection/indent, at var{indent}, at var{indent}}.
+ @{-3.5ex plus -1ex minus -.2ex@}% @ref{\@@startsection/beforeskip, at var{beforeskip}, at var{beforeskip}}.
+ @{2.3ex plus.2ex@}% @ref{\@@startsection/afterskip, at var{afterskip}, at var{afterskip}}.
+ @{\centering\normalfont\Large\bfseries@}% @ref{\@@startsection/style, at var{style}, at var{style}}.
@}
@end example
-This will put subsection titles in small caps type, inline with the paragraph.
+This will put @code{subsection} titles in small caps type, inline with the paragraph.
@example
\renewcommand\subsection@{%
- \@@startsection@{subsection@}% @ref{\@@startsection/name,name of counter}
- @{2@}% @ref{\@@startsection/level,sectioning level}: 1=chapter, 2=section, 3=subsection
- @{0em@}% @ref{\@@startsection/indent,indent from left margin}
- @{-1ex plus 0.1ex minus -0.05ex@}% @ref{\@@startsection/beforeskip,vert space (no par indent if negative)}
- @{-1em plus 0.2em@}% @ref{\@@startsection/afterskip,vert space after (run-in if negative)}
- @{\scshape@}% @ref{\@@startsection/style,style of header}
+ \@@startsection@{subsection@}% @ref{\@@startsection/name, at var{name}, at var{name}}.
+ @{2@}% @ref{\@@startsection/level, at var{level}, at var{level}}.
+ @{0em@}% @ref{\@@startsection/indent, at var{indent}, at var{indent}}.
+ @{-1ex plus 0.1ex minus -0.05ex@}% @ref{\@@startsection/beforeskip, at var{beforeskip}, at var{beforeskip}}.
+ @{-1em plus 0.2em@}% @ref{\@@startsection/afterskip, at var{afterskip}, at var{afterskip}}.
+ @{\scshape@}% @ref{\@@startsection/style, at var{style}, at var{style}}.
@}
@end example
-The prior examples redefined existing sectional units. This defines a new one, illustrating the needed counter and macros to display that counter.
+The prior examples redefined existing sectional unit title commands. This defines a new one, illustrating the needed counter and macros to display that counter.
@c From https://groups.google.com/forum/#!searchin/comp.text.tex/startsection%7Csort:relevance/comp.text.tex/sB-nTS-oL08/ZZeKYdG0llMJ
@example
-\setcounter@{secnumdepth@}@{6@} % show counters this far down
-\newcounter@{subsubparagraph@}[subparagraph] % counter for numbering
-\renewcommand@{\thesubsubparagraph@}@{\thesubparagraph.\@@arabic\c@@subsubparagraph@} % how to display numbering
+\setcounter@{secnumdepth@}@{6@}% show counters this far down
+\newcounter@{subsubparagraph@}[subparagraph]% counter for numbering
+\renewcommand@{\thesubsubparagraph@}% how to display
+ @{\thesubparagraph.\@@arabic\c@@subsubparagraph@}% numbering
\newcommand@{\subsubparagraph@}@{\@@startsection
@{subsubparagraph@}%
@{6@}%
@@ -2695,8 +2714,8 @@
@{\baselineskip@}%
@{0.5\baselineskip@}%
@{\normalfont\normalsize@}@}
-\newcommand*\l@@subsubparagraph@{\@@dottedtocline@{6@}@{10em@}@{5em@}@} % for toc
-\newcommand@{\subsubparagraphmark@}[1]@{@} % for page headers
+\newcommand*\l@@subsubparagraph@{\@@dottedtocline@{6@}@{10em@}@{5em@}@}% for toc
+\newcommand@{\subsubparagraphmark@}[1]@{@}% for page headers
@end example
More information about the latexrefman-commits
mailing list