diff options
Diffstat (limited to 'Master/texmf-dist/source')
| -rw-r--r-- | Master/texmf-dist/source/latex/fancyhdr/fancyhdr.dtx | 2457 | ||||
| -rw-r--r-- | Master/texmf-dist/source/latex/fancyhdr/fancyhdr.ins | 2 |
2 files changed, 1798 insertions, 661 deletions
diff --git a/Master/texmf-dist/source/latex/fancyhdr/fancyhdr.dtx b/Master/texmf-dist/source/latex/fancyhdr/fancyhdr.dtx index 7c4da85a050..3315b199ead 100644 --- a/Master/texmf-dist/source/latex/fancyhdr/fancyhdr.dtx +++ b/Master/texmf-dist/source/latex/fancyhdr/fancyhdr.dtx @@ -1,8 +1,8 @@ % \iffalse meta-comment % -% Copyright (C) 2016 by Piet van Oostrum <piet@vanoostrum.org> +% Copyright (C) 1994-2021 by Pieter van Oostrum <pieter@vanoostrum.org> % ------------------------------------------------------- -% +% % This file may be distributed and/or modified under the % conditions of the LaTeX Project Public License, either version 1.3 % of this license or (at your option) any later version. @@ -10,7 +10,7 @@ % % http://www.latex-project.org/lppl.txt % -% and version 1.3 or later is part of all distributions of LaTeX +% and version 1.3 or later is part of all distributions of LaTeX % version 2005/12/01 or later. % % \fi @@ -26,11 +26,11 @@ %<fancyhdr>\ProvidesPackage{fancyhdr}% %<fancyheadings>\ProvidesPackage{fancyheadings} %<extramarks>\ProvidesPackage{extramarks} -%<fancyhdr|fancyheadings|extramarks> [2019/01/31 v3.10 +%<fancyhdr|fancyheadings|extramarks> [2021/01/04 v4.0 %<fancyhdr> Extensive control of page headers and footers]% %<fancyheadings> Legacy package to call fancyhdr] %<extramarks> Extra marks for LaTeX] -%<fancyhdr|extramarks>% Copyright (C) 1994-2019 by Piet van Oostrum <piet@vanoostrum.org> +%<fancyhdr|extramarks>% Copyright (C) 1994-2021 by Pieter van Oostrum <pieter@vanoostrum.org> %<fancyheadings>% Public domain %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % \end{macrocode} @@ -48,6 +48,7 @@ \usepackage[T1]{fontenc} \usepackage{url} \usepackage[fit]{truncate} +\usepackage{ifthen} \usepackage{fancyhdr} \GetFileInfo{fancyhdr.sty} \def\latex/{\protect\LaTeX{}} @@ -70,6 +71,7 @@ \newcommand{\CmdIndex}[1]{\index{#1=\string\texttt{\bs#1}}} \newcommand{\TTindex}[1]{\index{#1=\string\texttt{#1}}} \newcommand{\PSindex}[1]{\index{page style>#1=\string\texttt{#1}}} +\newcommand{\OPTindex}[1]{\index{option>#1=\string\texttt{#1}}} \renewcommand{\topfraction}{0.9} \renewcommand{\bottomfraction}{0.9} \renewcommand{\textfraction}{0.05} @@ -84,6 +86,89 @@ \newenvironment{xvspace}{\vspace{1ex}}{{\vspace{1ex}}} \setcounter{tocdepth}{1} +% Compare section numbers in references +\usepackage{refcount} +\newcounter{secnum} +% #1=current section label #2=ref section label +\newcommand{\smartref}[2]{% + \setcounterref{secnum}{#1}% + \addtocounter{secnum}{-1}% + \ifnum\value{secnum}=\getrefnumber{#2} + the previous section% + \else + \addtocounter{secnum}{2}% + \ifnum\value{secnum}=\getrefnumber{#2} + the next section% + \else + section~\ref{#2}% + \fi + \fi +} + +% Our own page style: +\pagestyle{fancy} +\addtolength{\headwidth}{\marginparsep} +\addtolength{\headwidth}{0.5\marginparwidth} +\fancyhf{} +\fancyhead[L]{\rightmark} +\fancyhead[R]{\textbf{\thepage}} +\renewcommand{\sectionmark}[1]{\markright{\thesection\quad#1}} + +% Page style for demonstrating struts, \headruleskip and \footruleskip. + +\newcommand{\strutheader}{% + \texttt{\textbackslash strut}: + \rule[-0.3\normalbaselineskip]{10pt}{0.3\normalbaselineskip}% + \rule{10pt}{0.7\normalbaselineskip} + \texttt{\textbackslash headruleskip}$\searrow$ + \raisebox{-0.3\normalbaselineskip}[0pt][0pt]% + {\ifdim \headruleskip>0pt + \rule[-\headruleskip]{10pt}{\headruleskip} + \else + \rule{10pt}{-\headruleskip} + \fi} +} +\newcommand{\strutfooter}{% + \raisebox{0pt}[0pt][0pt]{% + \texttt{\textbackslash strut}: + \rule[-0.3\normalbaselineskip]{10pt}{0.3\normalbaselineskip}% + \rule{10pt}{0.7\normalbaselineskip} + \texttt{\textbackslash footruleskip} $\nearrow$ + \rule[0.7\normalbaselineskip]{10pt}{\footruleskip}}% +} +\fancypagestyle{showstruts}{% + \fancyhead[L]{% + \ifthenelse{\value{page}=\pageref{showstruts}}% + {\strutheader}% + {\rightmark}% + } + \fancyfoot[L]{% + \ifthenelse{\value{page}=\pageref{showstruts}}% + {\strutfooter}% + {}% + } + \fancyheadinit{% + \ifthenelse{\value{page}=\pageref{showstruts}}% + {\renewcommand{\headruleskip}{4pt}}% + {\renewcommand{\headruleskip}{0pt}}% + } + \fancyfootinit{% + \ifthenelse{\value{page}=\pageref{showstruts}}% + {\renewcommand{\footrulewidth}{0.4pt}}% + {\renewcommand{\footrulewidth}{0pt}}% + } +} + +\newcounter{example} +\newcommand{\Example}{% + \refstepcounter{example}% + \marginpar{\vspace{\baselineskip}\hfill Example \theexample\quad\quad}% +} +\newcommand{\FExample}{% + \refstepcounter{example}% + \makebox[0pt][r]{{Example \theexample}\quad\quad}% +} + \begin{document} \DeleteShortVerb{\|} \DocInput{\jobname.dtx} @@ -91,7 +176,7 @@ %</driver> % \fi % -% \CheckSum{1045} +% \CheckSum{0} % % \CharacterTable % {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z @@ -116,7 +201,7 @@ % % \title{The \Package{fancyhdr} and \Package{extramarks} % packages\\{\normalsize version \fileversion.}} -% \author{Piet van Oostrum\thanks{A considerable part of this documentation was +% \author{Pieter van Oostrum\thanks{A considerable part of this documentation was % written by George % Gr\"atzer (University of Manitoba) in \emph{Notices Amer. Math. Soc.} % Thanks, George!}\\ @@ -127,22 +212,25 @@ % \maketitle % \begin{abstract} % This document describes how to customize the page layout of your LaTeX -% documents, i.e how to change page margings and sizes, +% documents, i.e how to change page margings and sizes, % headers and footers, and the % proper placement of figures and tables (collectively called floats) on -% the page. -% -% This documentation describes version 3.10 or later of the +% the page. +% +% This documentation describes version 4.0 or later of the % \Package{fancyhdr} and \Package{extramarks} packages. The user % documentation is valid for the versions 3.8 or later of the -% \Package{fancyhdr} package and version 2.1 or later of the +% \Package{fancyhdr} package (except for the changes mentioned in +% section~\ref{sec:version-4}), and version 2.1 or later of the % \Package{extramarks} package. -% +% % \end{abstract} +% % \tableofcontents +% \markright{Contents} % %\part{Introduction} -% +% % This document contains four parts: % % Part I is a short documentation on @@ -156,21 +244,54 @@ % % Part IV contains the annotated implementation. % +% This document describes version 4 of \Package{fancyhdr}. This version +% is also described in the forthcoming edition 3 of \textit{The \latex/ Companion}, +% whereas the previous editions describe version 3 of \Package{fancyhdr}. +% There are some significant differences between these versions. These +% are summarized in section~\ref{sec:version-4} on page~\pageref{sec:version-4}. +% Throughout this documentation it is mentioned when a specific feature +% is only available in version 4, or when there are differences between +% version 3 and 4. +% % \section{Installation} % \label{sec:installation} -% +% % The preferred way to install this package is with a package installer. % If you want to install it by hand, then first run the command % \verb+tex fancyhdr.ins+ and then move the files \texttt{fancyhdr.sty}, % \texttt{extramarks.sty} and \texttt{fancyheadings.sty} to a place % where \latex/ can find it, preferably in a directory similar to % \texttt{.../texmf/tex/latex/fancyhdr/} in your \tex/ directory tree. -% +% % \section{Using \Package{fancyhdr}} % % The package \Package{fancyhdr} gives you several commands to define % headers and footers of the pages in a \latex/ document. -% +% You load the package with the following command in the preamble: +% \begin{quote} +% \verb|\usepackage|\oarg{options}|{fancyhdr}| +% \end{quote} +% (Options are available since version~4.0) +% The following options are supported: +% \begin{center} +% \begin{tabular}{ l l } +% \toprule +% Option & Meaning \\ +% \midrule +% \texttt{nocheck} & do not check the heights of the header and footer \\ +% & (see section~\ref{sec:warning} on page~\pageref{page:warning})\\ +% \texttt{compatV3} & keep some behaviour (now considered undesirable) as in version~3 \\ +% & (see section~\ref{sec:options} and section~\ref{sec:warning} on +% page~\pageref{page:warning}) \\ +% \texttt{headings} & redefine the \texttt{headings} page style to be fancy-based \\ +% \texttt{myheadings} & redefine the \texttt{myheadings} page style to be fancy-based \\ +% \bottomrule +% \end{tabular} +% \end{center} +% \OPTindex{nocheck} +% \OPTindex{compatV3} +% \OPTindex{headings} +% \OPTindex{myheadings} % \DescribeMacro{\fancyhead} % \DescribeMacro{\fancyfoot} % \DescribeMacro{\fancyhf} @@ -199,60 +320,67 @@ % These define offsets to let the headers stick into the margin (or to % the inside if negative). Places cannot contain the \texttt{C} % specifier. See section~\ref{sec:book-examples} for more details. -% -% \DescribeMacro{\headrulewidth} +% % \DescribeMacro{\headrulewidth} +% \DescribeMacro{\footrulewidth} +% \DescribeMacro{\headruleskip} +% \DescribeMacro{\footruleskip} % \DescribeMacro{\headrule} % \DescribeMacro{\footrule} % \DescribeMacro{\headwidth} -% \begin{verbatim} -% \headrulewidth -% \footrulewidth -% \headrule -% \footrule -% \headwidth -% \end{verbatim} % -% \cs{headrulewidth} and \cs{headrulewidth} are macros to define the +% \cs{headrulewidth} and \cs{footrulewidth} are macros to define the % thickness of a line under the header and above the footer. -% \cs{headrule} and \cs{footrule} are macros to completely redefines +% \cs{headruleskip} and \cs{footruleskip} are macros that define the +% distance between the lines and the header and footer text, +% respectively. (But \cs{headruleskip} is only available since version~4.0.) +% \cs{headrule} and \cs{footrule} are macros to completely redefine % these lines. And \cs{headwidth} is a length parameter that defines the % total width of the headers and footers. See sections~\ref{sec:simple}, % \ref{sec:fancy} and \ref{sec:book-examples} for more details. % +% \DescribeMacro{\fancyheadinit} +% \DescribeMacro{\fancyfootinit} +% \DescribeMacro{\fancyhfinit} +% +% \cs{fancyheadinit} and \cs{fancyfootinit} can be used to define +% initialisation code for the header and footer, respectively, and +% \cs{fancyhfinit} defines both of these. These commands are only +% available in fancyhdr version~4.0 and later. See section~\ref{sec:change}. +% +% \DescribeMacro{\fancycenter} +% (Only in version~4.0 and later.) The command \cs{fancycenter} packs 3 +% header fields into a full-width header. See section~\ref{sec:fancycenter}. +% % \DescribeMacro{\iftopfloat} % \DescribeMacro{\ifbotfloat} % \DescribeMacro{\iffloatpage} % \DescribeMacro{\iffootnote} -% \begin{verbatim} -% \iftopfloat -% \ifbotfloat -% \iffloatpage -% \iffootnote -% \end{verbatim} % -% These are macros to detect if there is a float on the top or the bottom +% The macros \cs{iftopfloat}, \cs{ifbotfloat}, \cs{iffloatpage}, +% \cs{iffloatpage}, \cs{iffootnote} +% are used to detect if there is a float on the top or the bottom % of the page, or the page is a float page, or if there is a footnote at % the bottom of the page. These can be used to choose different headers % and/or footers if these conditions are met. See % section~\ref{sec:float} for more details. -% +% +% \begin{quote} % \DescribeMacro{\fancypagestyle} -% \begin{verbatim} -% \fancypagestyle{pagestyle}{commands} -% \end{verbatim} +% \verb|\fancypagestyle|\marg{style-name}\oarg{base-style}\marg{definitions} +% \end{quote} % This command lets you (re)define page styles for use in special -% situations. See section~\ref{sec:pagestyle-plain} for more details. +% situations. See section~\ref{sec:fancypagestyle} for more details. % % \section{Using extramarks} % \label{sec:using-extramarks} -% +% % The \Package{extramarks} gives you some extra marks in \latex/, % besides the normal \cs{leftmark} and \cs{rightmark}, that are defined % by the \cs{markboth} and \cs{markright} commands. % % \DescribeMacro{\firstleftmark} -% \DescribeMacro{\firstleftmark} +% \DescribeMacro{\lastrightmark} % \DescribeMacro{\firstrightmark} % \DescribeMacro{\lastleftmark} % \begin{verbatim} @@ -292,9 +420,9 @@ % % \section{Introduction} % \label{sec:intro} -% +% % A page in a \LaTeX{} document is built from various elements as shown in -% figure \ref{fig:layout}. +% figure \ref{fig:layout}. % \begin{figure}[htbp] % \begin{center} % \leavevmode @@ -306,53 +434,53 @@ % \end{figure} % \thispagestyle{plain} % The body contains the main text of the document -% together with the so called floats (tables and figures). -% +% together with the so called floats (tables and figures). +% % The pages are constructed by \LaTeX's output routine, which is quite % complicated and should therefore not be modified. Some of the packages % described in this paper contains small modifications to the output routine % to accomplish things that cannot be done in another way. You should use % these packages to get the desired result rather than fiddling with the % output routine yourself. -% +% % There are a number of things that you must be aware of: % \begin{enumerate} % \item The margins on the left are not called \cs{leftmargin}, but % \cs{evensidemargin} (on even-numbered pages) and \cs{oddsidemargin} -% (on odd-numbered pages). In one-sided documents +% (on odd-numbered pages). In one-sided documents % \cs{oddsidemargin} is used for either. \cs{leftmargin} is also a valid % \latex/ parameter but it has a different use (namely the indentation of -% lists). +% lists). % \item Most of the parameters should not be changed in the middle of a % document. Some changes might work at a pagebreak. If you want to change % the height of a single page, you can use the \cs{enlargethispage} -% command. +% command. % \end{enumerate} -% +% % The margin notes % area contains small pieces of information created by the \cs{marginpar} % command. On twosided documents the margin notes appear on the left and right % alternatively. The margin notes are not on fixed places with respect to the % paper but at approximately the same height as the paragraph in which they % appear. Due to the algorithm used to decide the placement of margin notes, -% in a twosided document unfortunately +% in a twosided document unfortunately % they may appear on the wrong side if they are close % to a page break. % If you want to put information on fixed places in the margins you may use % the technique described in sections \ref{sec:movie} and \ref{sec:thumb}. -% +% % The first part of this paper describes how to change the header and footer % areas. The last part describes how to get your floats at the desired place. -% +% % \section{Page headers and footers} -% +% % The page headers and footers in \LaTeX{} are defined by the % \cs{pagestyle} and \cs{pagenumbering} commands. \cs{pagestyle} % defines the general contents of the headers and footers (e.g. where the % page number will be printed), while % \cs{pagenumbering} defines the format of the page number. % \LaTeX{} has four standard page styles: -% +% % \begin{center} % \noindent % \begin{tabular}{>{\tt}lp{9cm}} @@ -366,13 +494,13 @@ % \bottomrule % \end{tabular} % \end{center} -% +% % Although these are useful styles, they are quite limited. Additional page % styles can be defined by defining commands of the form \cs{ps@xxx}. This % command is executed when a \Cmd{pagestyle\{xxx\}} is given in the document. -% The \cs{ps@xxx} command should define the following +% The \cs{ps@xxx} command should define the following % commands for the contents of the headers and footers: -% +% % \begin{center} % \noindent % \begin{tabular}{lp{9cm}} @@ -386,16 +514,16 @@ % \bottomrule % \end{tabular} % \end{center} -% +% % These are not user commands, but rather ``variables'' that are used by % \latex/'s output routine. % As the command names contain the character '\texttt{@}', they should % be defined in a package file, or otherwise be sandwiched between the commands % \cs{makeatletter} and \cs{makeatother}. -% +% % The \cs{pagenumbering} command defines the layout of the page number. It % has a parameter from the following list: -% +% % \begin{center} % \begin{tabular}{>{\tt}ll} % \toprule @@ -407,19 +535,19 @@ % \bottomrule % \end{tabular} % \end{center} -% +% % The \Cmd{pagenumbering\{xxx\}} defines the command \cs{thepage} to be the -% expansion of the page number in the given notation \texttt{xxx}. +% expansion of the page number in the given notation \texttt{xxx}. % The pagestyle command % then would include \cs{thepage} in the appropriate place. Additionally % the \cs{pagenumbering} command resets the page number to~1. % The \cs{pagestyle} and \cs{pagenumbering} apply to the page that is % being constructed, so they should be used at a location where it is clear % to what page they apply (see section \ref{sec:change}). -% -% +% +% % \section{What is \Package{fancyhdr}} -% +% % The \Package{fancyhdr} macro package allows you to customize % in \latex/ your page headers and footers in an easy way. You can % define: @@ -432,25 +560,25 @@ % \item different headers and footers for chapter pages % \item different headers and footer on pages with floats % \end{itemize} -% +% % Of course, you also have complete control over fonts, uppercase % and lowercase displays, etc. -% +% % \section{Simple use of \Package{fancyhdr}} To use this package % install it is a place where \latex/ can find it (see % section~\ref{sec:installation})\footnote{In most modern \tex/ % installation the package is already included.}, and include in the preamble of your document -% the commands: -% +% the commands: +% % \PSindex{fancy} % \begin{verbatim} % \usepackage{fancyhdr} % \pagestyle{fancy} % \end{verbatim} -% +% % We can visualize the page layout we can create with \Package{fancyhdr} % as follows: -% +% % \begin{fblock} % \noindent\makebox[\textwidth]{LeftHeader\hfill % CenteredHeader\hfill RightHeader}\showrule @@ -459,33 +587,34 @@ % \noindent\makebox[\textwidth]{LeftFooter\hfill % CenteredFooter\hfill RightFooter} % \end{fblock} -% +% % The LeftHeader and LeftFooter are left justified; the % CenteredHeader and CenteredFooter are centered; the % RightHeader and RightFooter are right justified. -% +% % We define each of the six ``fields'' and the two decorative lines % separately. -% +% % \section{A simple example} % \label{sec:simple} -% +% % K. Grant is writing a report to Dean % A. Smith, on ``The performance of new graduates'' with the % following page layout: -% +% % \begin{fblock} % \noindent\makebox[\textwidth]{\hfill\textbf{The performance of new % graduates}}\showrule % \noindent\makebox[\textwidth]{\hfill page body\hfill}\\[\baselineskip] -% \noindent\makebox[\textwidth]{\hrulefill} +% \noindent\makebox[\textwidth]{\rule{\textwidth}{2pt}} % \noindent\makebox[\textwidth]{From: K. Grant\phantom{3}\hfill % To: Dean A. Smith\hfill \phantom{From: K. Grant}3} % \end{fblock} -% +% % \noindent where ``3'' is the page number. The title: ``The -% performance of new graduates'' is bold. -% +% performance of new graduates'' is bold. The rule above the footer is a +% bit thicker (2pt). +% % This is accomplished by these commands following % \Cmd{pagestyle\{fancy\}}\footnote{Note that version 1 of fancyheadings % used the \cs{setlength} command to change the \texttt{\bs...rulewidth} parameters.}: @@ -500,15 +629,15 @@ % \fancyfoot[C]{To: Dean A. Smith} % \fancyfoot[R]{\thepage} % \renewcommand{\headrulewidth}{0.4pt} -% \renewcommand{\footrulewidth}{0.4pt} +% \renewcommand{\footrulewidth}{2pt} % \end{verbatim} % (The \cs{thepage} macro displays the current page number. % \cs{textbf} puts it in bold face.) -% +% % This is now fine, except that the first page does not need % all these headers and footers. To eliminate all but the % centered page number, issue the command -% +% % \CmdIndex{thispagestyle} % \begin{verbatim} % \thispagestyle{plain} @@ -519,44 +648,102 @@ % \CmdIndex{maketitle} % \cs{maketitle} % commands. -% +% % Alternatively, issue % \begin{verbatim} % \thispagestyle{empty} % \end{verbatim} % if you do not want any headers or footers. -% +% % In fact the standard \latex/ classes have the command \cs{maketitle} % defined in such a way that a \Cmd{thispagestyle\{plain\}} is automatically % issued. So if you \emph{do} want the fancy layout on a page containing % \cs{maketitle} you must issue a \Cmd{thispagestyle\{fancy\}} after the % \cs{maketitle}. -% +% +% \section{Fancy Centering} +% \label{sec:fancycenter} +% +% \textbf{Note:} This section only applies to \Package{fancyhdr} version~4.0 +% and later\footnote{This comes from the \Package{nccfancyhdr} +% package by Alexander I. Rozhenko.}. +% +% The marks in a fancy header and footer are prepared using \cs{parbox} +% command. So, you can use multiline marks. In the header, they are +% aligned to the bottom line, but, in the footer, they are aligned to +% the top line. The maximum width of every mark is equal to the +% \cs{headwidth}. This can lead to overlapping of neighbouring marks. +% +% \DescribeMacro{\fancycenter} +% If you want to prepare marks in more traditional way in a line +% not exceeding the \cs{headwidth}, you can use +% the following command in any mark command: +% \begin{quote} +% \cs{fancycenter}\oarg{distance}\oarg{stretch}\\ +% \verb| |\marg{left-mark}\marg{center-mark}\marg{right-mark} +% \end{quote} +% This command works like +% \begin{center} +% \verb|\hbox to\linewidth{|\marg{left-mark}\cs{hfil}\marg{center-mark}\cs{hfil}\marg{right-mark}\verb|}| +% \end{center} +% but does this more carefully trying to exactly center the central part of +% the text if possible. The solution for exact centering +% is applied if the width of \meta{center-mark} is less than +% \begin{quote} +% \verb|\linewidth - 2*(|\meta{stretch}\verb|*|\meta{distance}\verb| +|\\ +% \verb| max(width(|\meta{left-mark}\verb|), width(|\meta{right-mark}\verb|)))|. +% \end{quote} +% Otherwise the \meta{center-mark} will slightly migrate to a shorter item +% (\meta{left-mark} or \meta{right-mark}), but at least \meta{distance} +% space between all parts of line is provided. +% The default values of \meta{distance} and \meta{stretch} +% are 1em and 3. +% +% If the \meta{center-mark} is empty, the \cs{fancycenter} is equivalent to +% the following command: +% \begin{center} +% \verb|\hbox to\linewidth {|\marg{left-mark}\verb|\hfil |\marg{right-mark}\verb|}| +% \end{center} +% +% You would use this in a header for example with +% \begin{quote} +% \verb|\fancyhead[C]{|\cs{fancycenter}\oarg{distance}\oarg{stretch}\\ +% \verb| |\marg{left-mark}\marg{center-mark}\marg{right-mark}\verb|}| +% \end{quote} +% and leave the \texttt{[L,R]} parts empty. +% +% \textbf{Note 1}: If the whole of the \cs{fancycenter} is wider than +% \cs{headheight} it will stick out on the right. See +% section~\ref{sec:longtitles} for possible solutions. +% +% \textbf{Note 2}: The usage of \cs{fancycenter} command is not limited to the +% argument of header/footer marks. You can use it anywhere in your document. +% % \section{An example of two-sided printing}\label{two-sided} -% +% % \TTindex{twoside} % Some document classes, such as \verb|book.cls|, print two-sided by default: the even % pages and the odd pages have different layouts; other document classes % use the \verb|twoside| option to print two-sided. -% +% % Now let us print the report two-sided. Let the above page % layout be used for the odd (right-side) pages, and the % following for the even (left-side) pages: -% +% % \begin{fblock} -% +% % \noindent\makebox[\textwidth]{\textbf{The performance of new % graduates}\hfill}\showrule % \noindent\makebox[\textwidth]{\hfill page body\hfill}\\[\baselineskip] % \noindent\makebox[\textwidth]{\hrulefill} % \noindent\makebox[\textwidth]{4\phantom{To: Dean A. Smith}\hfill % From: K. Grant\hfill \phantom{4}To: Dean A. Smith} -% +% % \end{fblock} % \noindent where ``4'' is the page number. -% +% % Here are the commands: -% +% % \begin{verbatim} % \fancyhead{} % clear all header fields % \fancyhead[RO,LE]{\textbf{The performance of new graduates}} @@ -567,13 +754,13 @@ % \renewcommand{\headrulewidth}{0.4pt} % \renewcommand{\footrulewidth}{0.4pt} % \end{verbatim} -% +% % \CmdIndex{fancyhead} % \CmdIndex{fancyfoot} % The commands \cs{fancyhead} and \cs{fancyfoot} % have an additional parameter between square brackets that specifies % for which pages and/or parts of the header/footer they apply. The first -% \cs{fancyhead} command omits this parameter, and thus applies to all +% \cs{fancyhead} command above omits this parameter, and thus applies to all % header fields. In general this is only useful to get rid of the defaults or % a previous definition, as is done here. Similar the \cs{fancyfoot} command % without square brackets clears all footer fields. In this particular @@ -583,7 +770,7 @@ % \Cmd{fancyhead[LE,RO]\{text\}} % will define the field for both the left header on even pages and the right % header on odd pages. If you don't give an \texttt{E} or \texttt{O} the definition applies to -% both. Similar for \texttt{LRC}. +% both. Similar for \texttt{LRC}. % The selectors may be given as uppercase or lowercase letters. % \begin{figure}[htb] % \begin{center} @@ -605,20 +792,20 @@ % \caption{Selectors} % \label{fig:sel} % \end{figure} -% +% % \CmdIndex{fancyhf} % There is also a more general command \cs{fancyhf} that you can use to % combine the specifications for headers and footers. This allows additional % selectors \texttt{H} (header) and \texttt{F} (footer). In fact \cs{fancyhead} and % \cs{fancyfoot} are just \cs{fancyhf} with \texttt{H} and \texttt{F} pre-specified, respectively. -% +% % Again, you may % use \Cmd{thispagestyle\{plain\}} for a simple page layout for % page~1. -% +% % \section{Redefining page style \texttt{plain}} % \label{sec:pagestyle-plain} -% +% % Some \latex/ commands, like \cs{chapter}, use the \cs{thispagestyle} % command to automatically switch to the \texttt{plain} page style, thus % ignoring the page style currently in effect. @@ -637,8 +824,8 @@ % \cs{ps@plain} command, but \Package{fancyhdr} gives you an easier way % with the \cs{fancypagestyle} command. This command can be used to % redefine existing page styles (like \texttt{plain}) or to define new ones, -% e.g. if part of your document is to use a different page style. This command -% has two parameters: the first one is the name of the page style to be defined, the +% e.g. if part of your document needs a different page style. This command +% has two mandatory parameters: the first one is the name of the page style to be defined, the % second consists of commands that change the headers and/or footers, i.e. % \verb|fancyhead| etc. Also allowed are changes to \cs{headrulewidth} and % \cs{footrulewidth} or even \cs{headrule} and \cs{footrule}. @@ -657,55 +844,206 @@ % \end{verbatim} % Now when these special pages use the \texttt{plain} page style, they use your redefined version. % -% As another example, let us +% As another example, let us % redefine the \texttt{plain} style for the report in Section~\ref{two-sided} by -% making the page number bold. +% making the page number bold and enclosing it in en-dashes without any rules. % \PSindex{plain} -% +% % \begin{verbatim} % \fancypagestyle{plain}{% -% \fancyhf{} % clear all header and footer fields -% \fancyfoot[C]{\textbf{\thepage}} % except the center -% \renewcommand{\headrulewidth}{0pt} -% \renewcommand{\footrulewidth}{0pt}} +% \fancyhf{}% clear all header and footer fields +% \fancyfoot[C]{\textbf{--~\thepage~--}} % except the center +% \renewcommand{\headrulewidth}{0pt}% +% \renewcommand{\footrulewidth}{0pt}% +% } % \end{verbatim} -% -% -% \section{The default layout}\label{default} +% +% +% \section{Defining other page styles} +% \label{sec:fancypagestyle} +% +% Just like redefining the \texttt{plain} page style in the previous +% section, you can define or redefine other page styles based on page +% style \texttt{fancy}. This is also done with the \cs{fancypagestyle} +% command. The general form of this command is: +% \begin{quote} +% \CmdIndex{fancypagestyle} +% \verb|\fancypagestyle|\marg{style-name}\oarg{base-style}\marg{definitions} +% \end{quote} +% As you see, there is an optional argument between the two mandatory arguments. +% +% For example: +% \begin{verbatim} +% \fancypagestyle{toc}{% +% \fancyhf{}% +% \fancyhead[RO]{\thepage}% +% \fancyhead[RO]{\textsl{TABLE OF CONTENTS}}% +% \fancyfoot[C]{\thepage} +% } +% \end{verbatim} +% This defines a special page style \texttt{toc} for use in the table +% of contents with \Cmd{pagestyle\{toc\}}. +% Inside the definition you can define the headers and/or footers, +% change the header and footer rules, and redefine commands like +% \cs{chaptermark} (see section~\ref{sec:options} for an example). The +% headers and footers and marks that are not redefined inside the +% \cs{fancypagestyle} definition, are taken from the global page style +% \texttt{fancy} values. +% +% You can also give an optional base page style to the +% \cs{fancypagestyle} command. Then the new page style will be based on +% the base style. This base style must be a \texttt{fancyhdr}-defined +% style. Also you should take care not to +% create circular dependencies. In this case the order of picking up the +% definitions (headers, footers, marks) is: +% \begin{enumerate} +% \item The definitions from the base style are taken. +% \item The definitions given in the \cs{fancypagestyle} command +% override and/or augment these. +% \item Any definitions that are not given by the two above, are taken +% from the environment at the time the new page style is used. +% \end{enumerate} +% Only the first two parts are embedded in the page style. +% When no base style is given, part 1 is null. +% +% The optional base style argument is only available since version~4.0. In +% this version it is also possible to redefine page style \texttt{fancy} +% in this way. In version~3.x and earlier this was not possible. +% +% If you want to restore the original default definitions +% from page style \texttt{fancy} as described in section~\ref{sec:default}, you can use +% \begin{verbatim} +% \fancypagestyle{myfancy}[fancydefault]{ +% . . . override some here +% } +% \end{verbatim} +% \PSindex{fancydefault} +% Page style \texttt{fancydefault} is the version of page style +% \texttt{fancy} that has all the initialisation embedded. Contrary to +% this, page style \texttt{fancy} as defined in the package uses the +% same defaults, but doesn't have them embedded. It picks them up from +% the environment. So if the environment changes, because you redefine +% headers, footers, mark commands, etc, the functioning of page style +% \texttt{fancy} changes with it. The page style \texttt{fancydefault} +% does not change, however. However, \texttt{fancydefault} is only available +% since fancyhdr version~4.0. +% +% \section{Package options} +% \label{sec:options} +% +% \textbf{NOTE:} This section applies to fancyhdr version~4.0 and later. +% +% You can supply options to the \cs{usepackage} command: +% \begin{quote} +% \verb|\usepackage|\oarg{options}|{fancyhdr}| +% \end{quote} +% % The following options are supported: +% \begin{center} +% \OPTindex{nocheck}\OPTindex{compatV3}\OPTindex{headings}\OPTindex{myheadings} +% \begin{tabular}{ l l } +% \toprule +% Option & Meaning \\ +% \midrule +% \texttt{nocheck} & do not check the heights of the header and footer \\ +% \texttt{compatV3} & keep some behaviour (now considered undesirable) as in version~3 \\ +% \texttt{headings} & redefine the \texttt{headings} page style to be fancy-based \\ +% \texttt{myheadings} & redefine the \texttt{myheadings} page style to be fancy-based \\ +% \bottomrule +% \end{tabular} +% \end{center} +% +% \begin{itemize} +% \item \OPTindex{nocheck}Option \texttt{nocheck} is described in section~\ref{sec:warning} on +% page~\pageref{page:warning}. +% +% \item \OPTindex{compatV3}Option \texttt{compatV3} keeps two fancyhdr +% version~3.x (or earlier) features that are now considered undesirable. +% \begin{enumerate} +% \item The automatic adjustment of \cs{headheight} or \cs{footskip} +% when these are too small. This causes the page layout to become +% inconsistent. See section~\ref{sec:warning} on +% page~\pageref{page:warning}. +% \item In these previous versions the changes to the +% \Package{fancyhdr} headers and footers (including those by +% \cs{fancyhead}, \cs{fancyheadoffset} and similar commands) are +% made globally, except within a page style defined by +% \cs{fancypagestyle}. That is, when these commands are given inside +% a \LaTeX{} group, they affect the whole document, not only the +% group. If your document depends on this behaviour, you can give +% the \texttt{compatV3} package option. However, this is only +% considered a short-time solution. You should change your document +% as soon as possible to work around this problem. In version~4.0 and +% later, without this option, the changes are always local. +% \end{enumerate} +% The option is scheduled to disappear in version~5 of +% \Package{fancyhdr}. +% +% \item \PSindex{headings}\PSindex{myheadings}\OPTindex{headings}\OPTindex{myheadings} +% The options \texttt{headings} and \texttt{myheadings} redefine the +% corresponding page style with fancyhdr commands (including a +% decorative line under the header), so that you can later select this +% page style as the page style for (part of) the +% document\footnote{These options were copied from the +% \texttt{nccfancyhdr} package, but contrary to that package, they are +% not automatically selected.}. +% \end{itemize} +% +% \PSindex{headings} +% The page style \texttt{headings} is in some aspects similar to the default page +% style \texttt{fancy} settings. In the \texttt{fancy} page style, the +% page number is in the footer, but in the \texttt{headings} +% page style it is in the header. The header fields look similar, however. +% +% Please note that these page styles redefine the \cs{chaptermark} and/or +% \cs{[sub]sectionmark} commands (see section~\ref{sec:scoop}), as do the +% standard \latex/ page styles. The consequence is, that if you select +% e.g.\ \Cmd{pagestyle\{headings\}}, the definitions of +% \Cmd{pagestyle\{fancy\}} are overridden. +% Also when you change the headers and/or footers +% while such a page style is in effect, and you then switch back to this +% page style, for +% example with \verb|\pagestyle{headings}|, they revert to the built-in +% settings. Therefore it is not advisable to change the headers or +% footers in this way, but instead define your +% own page style, as explained in section~\ref{sec:fancypagestyle}. +% +% \section{The default layout} +% \label{sec:default} % Let us use the \verb|book.cls| documentclass and the default settings for -% \Package{fancyhdr}; so we only issue the commands -% +% \Package{fancyhdr}; so we don't use any of the page style options in +% the \Cmd{usepackage\{fancyhdr\}} command, and we don't redefine any +% headers or footers. So just: % \begin{verbatim} % \usepackage{fancyhdr} % \pagestyle{fancy} % \end{verbatim} -% and let \Package{fancyhdr} take care of everything. On the -% pages where new chapters start, we get a centered page number in -% the footer; there is no header, and there are no decorative lines. -% +% and let \Package{fancyhdr} take care of everything. As mentioned +% before, we get a layout that is very similar to the page style \texttt{headings}. +% +% On the pages where new chapters start, we get a centered page number +% in the footer; there is no header, and there are no decorative lines. +% % On an even page, we get the layout: -% +% % \begin{fblock} % \noindent\makebox[\textwidth]{\textsl{1.2 EVALUATION}\hfill % \textsl{CHAPTER 1. INTRODUCTION}}\showrule -% \noindent\makebox[\textwidth]{\hfill page body\hfill}\\[\baselineskip] -% \noindent\makebox[\textwidth]{\hrulefill} -% \noindent\makebox[\textwidth]{\hfill4\hfill} +% \noindent\makebox[\textwidth]{\hfill page body\hfill}\\[2\baselineskip] +% \noindent\makebox[\textwidth]{\hfill2\hfill} % \end{fblock} -% +% % On an odd page, we get the layout: -% +% % \begin{fblock} % \noindent\makebox[\textwidth]{\textsl{CHAPTER 1. INTRODUCTION}\hfill % \textsl{1.2 EVALUATION}}\showrule -% \noindent\makebox[\textwidth]{\hfill page body\hfill}\\[\baselineskip] -% \noindent\makebox[\textwidth]{\hrulefill} +% \noindent\makebox[\textwidth]{\hfill page body\hfill}\\[2\baselineskip] % \noindent\makebox[\textwidth]{\hfill % 3\hfill } % \end{fblock} -% +% % \noindent where the header text is slanted uppercase. -% +% % This default layout is produced by the following commands: % \CmdIndex{rightmark} % \CmdIndex{leftmark} @@ -714,45 +1052,52 @@ % \fancyhead[LO,RE]{\textsl{\leftmark}} % \fancyfoot[C]{\thepage} % \end{verbatim} -% +% % The following settings are used for the decorative lines: -% +% % \begin{tabbing} % \CmdIndex{headrulewidth} % \noindent \cs{headrulewidth}\qquad \qquad \qquad \=0.4\=pt\\ % \CmdIndex{footrulewidth} % \Cmd{footrulewidth}\>0\>pt % \end{tabbing} -% -% The header text is turned into all uppercase in \verb|book.cls|. -% -% \section{The scoop on \latex/'s marks}\label{sec:custom} +% +% The header text is turned into all uppercase by the standard \LaTeX{} +% code in \verb|book.cls|. +% +% \section{The scoop on \latex/'s marks} % \label{sec:scoop} -% +% % Usually, for documents of class \verb|book| and \verb|report|, you may % want to use chapter and section information in the headings (chapter only % for one-sided printing), and for documents of class \verb|article|, % section and subsection information (section only for one-sided % printing). \latex/ uses a marker mechanism to remember the chapter and % section (section and subsection) information for a page; this is -% discussed in detail in \textit{The \latex/ Companion}, Section 4.3.1, or +% discussed in detail in \textit{The \latex/ Companion}, Section 4.3.1, or % \textit{The \latex/ Companion, Second Edition}, Section 4.3.4. -% +% % There are two ways you can use and change the higher- and lower-level % sectioning information available to you. The macros: % \CmdIndex{rightmark} % \CmdIndex{leftmark} % \cs{leftmark} % (higher-level) and \cs{rightmark} (lower-level) contain the information -% processed by \latex/, and you can use them directly as shown in -% Section~\ref{default}. -% +% processed by \latex/, and you can use them directly as shown in +% section~\ref{sec:default}. +% +% These marks are set by the commands +% \Cmd{markboth\{leftmark\}\{rightmark\}} and \Cmd{markright\{rightmark\}}. +% These commands are usually used inside commands like \cs{chaptermark} +% and \cs{sectionmark} but they can be also be given directly in your +% document, although this not very usual. +% % The \cs{leftmark} contains the \textbf{L}eft argument of the \emph{\textbf{L}ast} % \cs{markboth} on the page, the \cs{rightmark} contains the \textbf{R}ight % argument of the \emph{fi\textbf{R}st} \cs{markboth} or the only argument of the % \emph{fi\textbf{R}st} \cs{markright} on the page. If no marks are present on a % page they are ``inherited'' from the previous page. -% +% % You can influence how chapter, section, and subsection % information (only two of them!) is displayed by redefining the % \CmdIndex{chaptermark} @@ -764,7 +1109,7 @@ % they are seldom used.}. You must put the redefinition % after the first call of \Cmd{pagestyle\{fancy\}} as this % sets up the defaults. -% +% % Let us illustrate this with chapter info. It is made up of three parts: % \begin{itemize} % \CmdIndex{thechapter} @@ -773,19 +1118,53 @@ % \CmdIndex{chaptername} % \cs{chaptername} % \item the title, contained in the argument of -% \cs{chaptermark}. +% \cs{chapter}. % \end{itemize} -% -% Figure~\ref{fig:markers} shows some variants for ``Chapter 2.\ Do it now'' -% (the last example is appropriate in some non-English languages). The \% +% We combine these below with \cs{markboth} in \cs{chaptermark}. +% +% For the lower-level sectioning information, we do the same with +% \cs{markright} in \cs{sectionmark}. +% +% So if ``2. Implementation'' is the current chapter +% and ``2.1.\ First steps'' is the current section, then +% +% ^^A \Example +% \begin{verbatim} +% \renewcommand{\chaptermark}[1]{% +% \markboth{\chaptername\ \thechapter.\ #1}{}} +% \renewcommand{\sectionmark}[1]{\markright{\thesection.\ #1}} +% \end{verbatim} +% will give +% ``Chapter 2. Implementation'' and ``2.1.\ First steps'' +% +% Redefining the \cs{chaptermark} and \cs{sectionmark} commands may +% not eliminate all uppercaseness. E.g.\ the bibliography will have a title +% \CmdIndex{uppercase} +% \index{BIBLIOGRAPHY} +% of \textsc{bibliography} in the header, as the \cs{MakeUppercase} is +% explicitly given in the definition of \cs{thebibliography}. Similar for +% \index{INDEX} +% \textsc{index} etc.\ If you don't want to redefine these commands, you can +% use the \cs{nouppercase} command that \Package{fancyhdr} makes available in the header +% and footer fields. Note that this may screw other things, like uppercase +% roman numerals in your headers, so it should be used with care. Essentially +% this command typesets its argument in an environment where +% \cs{MakeUppercase} and \cs{uppercase} are changed into do-nothing operations. +% +% ^^A \Example +% \begin{verbatim} +% \fancyhead[L]{\nouppercase{\rightmark}} +% \fancyhead[R]{\nouppercase{\leftmark}} +% \end{verbatim} +% +% Figure~\ref{fig:markers} shows some variants for ``Chapter 2.\ Implementation'' +% (the last example is appropriate in some non-English languages). The \texttt{\%} % signs at the end of the lines are to prevent unwanted space. Normally you -% would continue the lines and remove these \% signs\footnote{the \texttt{\bs +% would continue the lines and remove these \texttt{\%} signs\footnote{The \texttt{\bs % MakeUppercase} command is used in \latex/ to generate uppercase text, -% while in \LaTeX{} 2.09 \cs{uppercase} is used. The difference is -% that \cs{MakeUppercase} also deals with non-ASCII letters. -% Fancyhdr defines \cs{MakeUppercase} to be an alias for -% \cs{uppercase} if it isn't defined.}. -% +% while \cs{uppercase} is the plain \TeX{} command for this. The difference is +% that \cs{MakeUppercase} also deals with non-ASCII letters.}. +% % \begin{figure}[tb] % \CmdIndex{chaptermark} % \CmdIndex{uppercase} @@ -819,93 +1198,70 @@ % \verb| \ \chaptername.\ #1}{}}|\\ % Prints:\\ % \mbox{}\\ -% Chapter 2.\ Do it now\\ +% Chapter 2.\ Implementation\\ % \mbox{}\\ % \mbox{}\\ % \mbox{}\\ -% CHAPTER 2.\ Do it now\\ +% CHAPTER 2.\ Implementation\\ % \mbox{}\\ % \mbox{}\\ % \mbox{}\\ % \mbox{}\\ -% CHAPTER 2.\ DO IT NOW\\ +% CHAPTER 2.\ IMPLEMENTATION\\ % \mbox{}\\ % \mbox{}\\ % \mbox{}\\ % \mbox{}\\ -% Do it now\\ +% Implementation\\ % \mbox{}\\ % \mbox{}\\ -% 2.\ Do it now\\ +% 2.\ Implementation\\ % \mbox{}\\ % \mbox{}\\ -% 2.\ Chapter.\ Do it now\\ +% 2.\ Chapter.\ Implementation\\ % \mbox{}\\ % \end{multicols} % \caption{Marker variants}\label{fig:markers} % \end{figure} -% -% -% For the lower-level sectioning information, do the same with -% \cs{markright}. -% -% So if ``Section 2.2.\ First steps'' is the current section, -% then -% -% \begin{verbatim} -% \renewcommand{\sectionmark}[1]{\markright{\thesection.\ #1}} -% \end{verbatim} -% will give -% ``2.2.\ First steps'' -% -% Redefining the \cs{chaptermark} and \cs{sectionmark} commands may -% not eliminate all uppercaseness. E.g.\ the bibliography will have a title -% \CmdIndex{uppercase} -% \index{BIBLIOGRAPHY} -% of \textsc{bibliography} in the header, as the \cs{MakeUppercase} is -% explicitly given in the definition of \cs{thebibliography}. Similar for -% \index{INDEX} -% \textsc{index} etc.\ If you don't want to redefine these commands, you can -% use the \cs{nouppercase} command that \Package{fancyhdr} makes available in the header -% and footer fields. Note that this may screw other things, like uppercase -% roman numerals in your headers, so it should be used with care. Essentially -% this command typesets its argument in an environment where -% \cs{MakeUppercase} and \cs{uppercase} are changed into do-nothing operations. -% -% -% \begin{verbatim} -% \fancyhead[L]{\nouppercase{\rightmark}} -% \fancyhead[R]{\nouppercase{\leftmark}} -% \end{verbatim} -% -% +% % It should be noted that the \latex/ marking mechanism works fine with % chapters (which always start on a new page) and sections (which are % reasonably long). It does not work quite as well with short sections and % subsections. This is a problem with \latex/, not with % \Package{fancyhdr}. -% +% % As an example let's take a page layout where the leftmarks are generated by % the sections and the rightmarks by the subsections (as is default in the -% \texttt{article} class). Take a page with some short sections, e.g. -% +% \texttt{article} class). Take a page with some short sections, e.g. +% % \begin{samepage} % \noindent Section 1.\\ % subsection 1.1\\ % subsection 1.2\\ -% Section 2. +% Section 2. % \end{samepage} -% +% % As the leftmark contains the \emph{last} mark of the page it will be % ``Section 2.'', and the rightmark will be ``subsection 1.1'' as it will be -% the \emph{first} mark of the page. So the page header info will combine +% the \emph{first} mark of the page. So the page header info will combine % section 2 with subsection 1.1 which isn't very nice. -% The best you can do in these cases is use only the \cs{rightmark}s and -% redefine \cs{sectionmark} accordingly. A \latex/ command +% One thing you can do in these cases is use only the \cs{rightmark}s and +% redefine \cs{sectionmark} accordingly. +% +% However, the \Package{extramarks} package described in section~\ref{sec:xmarks} +% contains a command % \CmdIndex{firstleftmark} -% \cs{firstleftmark} would also be a nice addition (see the -% \Package{extramarks} package in section~\ref{sec:xmarks}). -% +% \cs{firstleftmark} that can be used to get the first of the leftmarks +% on the page in the header. This might be the best solution in this +% situation. Now the header will contain ``Section 1.'' in the situation +% described above. +% ^^A \Example +% \begin{verbatim} +% \usepackage{extramarks} +% . . . +% \fancyhead[R]{\firstleftmark} +% \end{verbatim} +% % Another problem with the marks in the standard \latex/ classes is that the % higher level sectioning commands (e.g. \cs{chapter}) call % \cs{markboth} with an empty right argument. This means that on the first @@ -918,49 +1274,26 @@ % \cs{markright} commands or redefine the \cs{chaptermark} % (\cs{sectionmark}) commands to issue a \cs{markboth} command with % two decent parameters. -% +% % As a final remark you should also note that the \verb|*| forms of the % \cs{chapter} etc.\ commands do \emph{not} call the mark commands. So if % you want your preface to set the header info but not be numbered nor be put in % the table of contents, you must issue the \cs{markboth} command % yourself, e.g. -% +% % \begin{verbatim} -% \chapter*{Preface\markboth{Preface}{}} +% \chapter*{Preface} +% \markboth{Preface}{} % \end{verbatim} -% -% Entering the \cs{markboth} command inside the \cs{chapter*} insures -% that the mark will not be separated from the title by a page break. Of -% course with \cs{chapter*} this wouldn't be a problem if you put the mark -% command after the chapter title, as the \cs{chapter*} command starts at a -% new page. However with a \cs{section*} it could be dangerous to say: -% +% +% Or in a documentclass without chapters: % \begin{verbatim} % \section*{Preface} % \markboth{Preface}{} % \end{verbatim} -% as a page break may occur between the two commands. Therefore to be -% safe, put the \cs{mark...} command inside the \cs{section} command. -% -% You have to be careful, however, if you do this with a non-starred -% sectioning command. These will be put in the Table of Contents (if you -% have one), and this means the entries are ``moving'' (they move to the -% Table of Contents). The \cs{mark...} commands are ``fragile'', -% which means they will break when moved. Therefore they must be -% \DescribeMacro{\protect} -% \CmdIndex{protect} -% protected with the \cs{protect} command, for example -% -% \begin{verbatim} -% \chapter{Preface\protect\markboth{Preface}{Preface}} -% \end{verbatim} -% In this example we give \cs{markboth} two non-empty arguments -% otherwise it would make no sense to use the \cs{markboth} command -% inside the \cs{chapter} command. It is harmless to use the -% \cs{protect} command when it is not really necessary. -% +% % \section{Dictionary style headers} -% +% % \index{dictionary} % \index{concordance} % Dictionaries and concordances usually have a header containing the first @@ -970,16 +1303,16 @@ % style headers, you cannot use them for chapter and section information, so % if there are also chapters and sections present, you must redefine the % \cs{chaptermark} and \cs{sectionmark} to make them harmless: -% +% % \begin{verbatim} % \renewcommand{\chaptermark}[1]{} % \renewcommand{\sectionmark}[1]{} % \end{verbatim} -% +% % Now you do a \Cmd{markboth\{\#1\}\{\#1\}} for each dictionary or concordance % entry \verb|#1| and use \cs{rightmark} for the first entry defined on % the page and \cs{leftmark} for the last one. -% +% % If you want to use a header entry of the form \textsf{firstword--lastword} % it would be nice if this would be reduced to just the form % \textsf{firstword} if both are the same. This could happen if there is just @@ -988,7 +1321,7 @@ % cannot be compared out of the box with the plain \tex/ \cs{if} commands. % \TTindex{ifthen} % Fortunately the \Package{ifthen} package works well: -% +% % \begin{verbatim} % \newcommand{\mymarks}{ % \ifthenelse{\equal{\leftmark}{\rightmark}} @@ -997,10 +1330,10 @@ % \fancyhead[LE,RO]{\mymarks} % \fancyhead[LO,RE]{\thepage} % \end{verbatim} -% +% % \section{Fancy layouts} -% \label{sec:fancy} -% +% \label{sec:fancy}\label{sec:warning} +% % \index{multi-line} % You can make a multi-line field with the \bsbs{} command. It is also % possible to put extra space in a field with the \cs{vspace} command. @@ -1012,13 +1345,14 @@ % otherwise you may get error messages ``Overfull \cs{vbox} \ldots has % occurred while \cs{output} is active''^^A % \footnote{If you use \texttt{11pt} or \texttt{12pt} you will probably also -% have to do this, because \LaTeX's defaults are quite small}. -% See Section 4.1 of the \latex/ \emph{Companion} for detail. -% +% have to do this, because \LaTeX's defaults are quite small}. See the +% warning below. +% See also Section 4.1 of the \latex/ \emph{Companion} for detail. +% % For instance, the following code will place the section title and the % subsection title of an article in two lines in the upper right hand % corner: -% +% % \begin{verbatim} % \documentclass{article} % \usepackage{fancyhdr} @@ -1028,10 +1362,10 @@ % \renewcommand{\subsectionmark}[1]{\markright{#1}} % \fancyhead[R]{\leftmark\\\rightmark} % \end{verbatim} -% +% % You can also customize the decorative lines. You can make the decorative % line in the header quite thick with -% +% % \CmdIndex{headrulewidth} % \begin{verbatim} % \renewcommand{\headrulewidth}{0.6pt} @@ -1041,12 +1375,12 @@ % \begin{verbatim} % \renewcommand{\footrulewidth}{0pt} % \end{verbatim} -% +% % The decorative lines, themselves, are defined in the two macros % \cs{headrule} and \cs{footrule}. For instance, % if you want a dotted line rather than a solid line in the header, % redefine the command \cs{headrule}: -% +% % \begin{verbatim} % \renewcommand{\headrule}{\vbox to 0pt{\hbox % to\headwidth{\dotfill}\vss}} @@ -1054,21 +1388,42 @@ % % The redefined \cs{headrule} should preferably take up no vertical space, as in the example above, and as in the standard definition. If it does take vertical space, the header may come too close to the text, or even intrude in the text. In that case \Package{fancyhdr} will give you a warning that \cs{headheight} is too small. Like % \begin{verbatim} -% Package Fancyhdr Warning: \headheight is too small (12.0pt): -% Make it at least 14.0pt. -% We now make it that large for the rest of the document. -% This may cause the page layout to be inconsistent, however. +% Package fancyhdr Warning: \headheight is too small (12.0pt): +% (fancyhdr) Make it at least 14.0pt, for example: +% (fancyhdr) \setlength{\headheight}{14.0pt}. +% (fancyhdr) You might also make \topmargin smaller to compensate: +% (fancyhdr) \addtolength{\topmargin}{-2.0pt}. % \end{verbatim} -% As the warning says, \Package{fancyhdr} will change the -% \cs{headheight} itself, but this is too late for the current page. For -% subsequent pages it will have effect, but now the text on these pages -% will come out lower than on this page. So you are strongly advised to +% \label{page:warning}\index{Warning} +% You will probably get this warning on every page. +% \textbf{Note:} Before version 4.0, \Package{fancyhdr} would change the +% \cs{headheight} itself, causing the text on the following pages +% to come out lower than on this page. This appeared to be confusing, so +% since version~4.0 this is no longer done (except when you give the +% \OPTindex{compatV3}% +% \texttt{compatV3} package option. You should not give this as a +% permanent solution, however, but solve the problem). Therefore you are strongly advised to % redefine \cs{headheight} in the preamble, like this: % \begin{verbatim} -% \setlength\headheight{14pt} +% \setlength{\headheight}{14pt} +% \end{verbatim} +% This would cause the main text to be put 2pt lower on the page, which +% might be undesirable. You can compensate this by making \cs{topmargin} +% correspondingly smaller, for example +% \begin{verbatim} +% \addtolength{\topmargin}{-2pt} % \end{verbatim} % A similar change would be necessary for \cs{footskip} if the footer comes out too tall. % +% You can also eliminate this check completely by using the +% \OPTindex{nocheck} +% \texttt{nocheck} option of the package. But this may risk unwanted +% run-ins of the header or footer with other text. So this is generally +% discouraged. It is better to change \cs{headheight}, \cs{footskip}, +% and/or \cs{topmargin}. But in cases where you generate the \latex/ +% code automatically, and the software does not know how tall the header +% or footer will be, this may be handy. +% % As an alternative to changing \cs{headrulewidth} to 0 to have the rule % disappear, you can also make it empty with % \begin{verbatim} @@ -1076,7 +1431,7 @@ % \end{verbatim} % Visually this makes no difference, but it is more difficult to restore % it later to its default value. -% +% % Finally, let us make a real `decorative' line\footnote{Based upon an idea by Wayne Chan.}. % \begin{verbatim} % \usepackage{fourier-orns} @@ -1088,7 +1443,7 @@ % \hrulefill} % \end{verbatim} % This gives us the following headrule: -% +% % \noindent\makebox[\textwidth]{\hrulefill % \raisebox{-2.1pt}[10pt][10pt]{\quad\decofourleft\decotwo\decofourright\quad}\hrulefill} % @@ -1117,15 +1472,41 @@ % of the footer text line. By default it is set to 30\% of the normal line % distance. You may want to adjust it if you use unusally large or small % fonts in the footer. Change it with \cs{renewcommand}. -% +% +% You can also change the distance between the baseline of the header text and the +% decorative line in the header. Normally this distance is determined by +% the maximum depth of possible descenders in the text, which is 30\% of +% the normal line distance. You can increase or decrease this distance +% \CmdIndex{headruleskip} +% \DescribeMacro{\headruleskip} +% by defining the macro \cs{headruleskip}, similar to \cs{footruleskip} +% \footnote{(But \cs{headruleskip} is only available since version~4.0.)}. +% This defines the extra distance. The default value is 0pt, and +% positive values make the distance larger, and negative values make the +% distance shorter. +% Please note that this does not change the position +% of the decorative line with respect to the page, but it shifts the +% header text. If you want to keep the header text fixed, but move the +% decorative line, then you must also change the parameter \cs{headsep} +% (see figure~\ref{fig:layout}). \strut +% +% \pagestyle{showstruts} +% \noindent\begin{minipage}{\textwidth} +% \label{showstruts} +% \indent The header and footer in this page +% show the \emph{strut} (the amount of space in the text area above and +% below the baseline), and the \cs{headruleskip} and \cs{footruleskip}. +% For this page \cs{headruleskip} is 4pt. +% \end{minipage} +% % \section{Two book examples} % \label{sec:book-examples} -% +% % The following definitions give an approximation of the style % used in L. Lamport's \latex/ book. -% +% % Lamport's header overhangs the outside margin. This is done as follows. -% +% % The width of headers and footers is \cs{headwidth}, which by default % equals the width of the text: \cs{textwidth}. You can make the width % \CmdIndex{headwidth} @@ -1136,22 +1517,27 @@ % \CmdIndex{marginparwidth} % printed, add both \cs{marginparsep} and \cs{marginparwidth} to % \cs{headwidth} with the commands: -% +% % \begin{verbatim} % \addtolength{\headwidth}{\marginparsep} % \addtolength{\headwidth}{\marginparwidth} % \end{verbatim} -% +% % \begin{flushleft} -% You must issue these commands \emph{after} the first -% \Cmd{pagestyle\{fancy\}} command as this -% will establish the default for \cs{headwidth}\footnote{In version 2 or -% later of \Package{fancyhdr} it is usually safe to do it before, but it is still -% advised to do after.}. +% It is safest to issue these commands \emph{after} the first +% \Cmd{pagestyle\{fancy\}} command. % \end{flushleft} -% -% And now a complete definition of Lamport's book style: -% +% +% And now a complete definition of Lamport's book style. The header has +% the width of the text plus the marginpar area. The header on even +% pages has the page number on the left, and the chapter title on the +% right. On odd pages it has the section title preceded by the section +% number on the left and the page number on the right. All in boldface. +% There is no footer. The \texttt{plain} style is redefined to have no +% header and no footer. (In the \LaTeX{} book this makes sense because +% each chapter begins with a page that contains only a drawing. In most +% other cases you probably would want a page number on the page.) +% % \begin{verbatim} % \documentclass{book} % \usepackage{fancyhdr} @@ -1170,15 +1556,15 @@ % } % \end{verbatim} % \PSindex{plain} -% +% % Notice that the \cs{chaptermark} and \cs{sectionmark} commands have % been redefined to eliminate the chapter numbers and the uppercaseness. -% +% % For more control about the horizontal position of the headers and/or % footers, \Package{fancyhdr} has additional commands to specify the % offset of the header and/or footer elements. Use -% \Cmd{fancyhfoffset[place]\{length\}} -% \CmdIndex{fancyhfoffset} +% \Cmd{fancyhfoffset[place]\{length\}} +% \CmdIndex{fancyhfoffset} % to offset one or more elements. The \texttt{place} parameter is like % the optional parameter of \cs{fancyhf}, like \texttt{L R E O}, except % that \texttt{C} cannot be used. It specifies for which elements the @@ -1186,70 +1572,71 @@ % actual offset. Positive values move the element outward (into the % margin), negative values inward. There are also specialised commands % \cs{fancyheadoffset} and \cs{fancyfootoffset}, which have the -% \texttt{H} and \texttt{F} parameter pre-applied, respectively. -% \CmdIndex{fancyheadoffset} -% \CmdIndex{fancyfootoffset} -% +% \texttt{H} and \texttt{F} parameter pre-applied, respectively. +% \CmdIndex{fancyheadoffset} +% \CmdIndex{fancyfootoffset} +% % When you use these commands, \latex/ will recalculate \cs{headwidth}, -% based on the given parameters. -% +% based on the given parameters. +% % So the above example could also have been done with (N.B. You can only % use such an expression as a length parameter if the \Package{calc} -% package is used): -% +% package is used): +% % \begin{verbatim} % \fancyheadoffset[LE,RO]{\marginparsep+\marginparwidth} % \end{verbatim} -% +% % For the second example, we take the \amslatex/ book\footnote{George Gratzer, % \textit{Math into LaTeX, An Introduction to \LaTeX{} and \amslatex/}, Birkhauser, Boston.}. -% +% % Chapter pages have no headers or footers. So we declare -% +% % \begin{verbatim} % \thispagestyle{empty} % \end{verbatim} % for every chapter page, and we do not need to redefine plain. -% -% Chapter and section titles appear in the form: 2.\ DO IT NOW, so we have +% +% Chapter and section titles appear in the form: 2.\ IMPLEMENTATION, so we have % to redefine \cs{chaptermark} and \cs{sectionmark} as follows (see -% Section~\ref{sec:custom}): -% +% Section~\ref{sec:scoop}): +% % \begin{verbatim} % \renewcommand{\chaptermark}[1]% % {\markboth{\MakeUppercase{\thechapter.\ #1}}{}} % \renewcommand{\sectionmark}[1]% % {\markright{\MakeUppercase{\thesection.\ #1}}} % \end{verbatim} -% -% In an even-header, the page number is printed as the LeftHeader and -% the chapter info as the RightHeader; in an odd-header, the section info -% is printed as the LeftHeader and the page number as the RightHeader. The -% CenteredHeaders are empty. There are no footers. -% +% +% On an even page, the page number is printed as the left header and +% the chapter info as the right header; on an odd page, the section info +% is printed as the left header and the page number as the right header. The +% center headers are empty. There are no footers. +% % There is a decorative line in the header. It is 0.5pt wide, so we need % the commands: -% +% % \begin{verbatim} % \renewcommand{\headrulewidth}{0.5pt} % \renewcommand{\footrulewidth}{0pt} % \end{verbatim} -% +% % The font used in the headers is 9 pt bold Helvetica. The \PSNFSS\ system % by Sebastian Rahtz uses the short (Karl Berry) name \verb|phv| for % Helvetica, so this font is selected with the commands: % \begin{verbatim} % \fontfamily{phv}\fontseries{b}\fontsize{9}{11}\selectfont % \end{verbatim} -% (See Sections 7.6.1 and 11.9.1 of the \latex/ \emph{Companion}.) +% (See Sections 7.6.1 and 11.9.1 of the \latex/ \emph{Companion} or +% Sections 7.6 and 7.9.1 of \emph{The \latex/ Companion, Second Edition}.) % Let us define a shorthand for this: % \begin{verbatim} % \newcommand{\helv}{% % \fontfamily{phv}\fontseries{b}\fontsize{9}{11}\selectfont} % \end{verbatim} -% +% % Now we are ready for the page layout: -% +% % \begin{verbatim} % \documentclass{book} % \usepackage{fancyhdr} @@ -1267,11 +1654,11 @@ % \fancyhead[LO]{\helv \rightmark} % \fancyhead[RE]{\helv \leftmark} % \end{verbatim} -% -% +% +% % \section{Special page layout for float pages} % \label{sec:float} -% +% % \index{float page} % Some people want to have a special layout for float pages (pages only % containing floats). As these pages @@ -1280,44 +1667,50 @@ % of the page style will at least also affect the page before the float page. % With \Package{fancyhdr}, however, you can specify in each of % the header- or footer fields -% -% \Cmd{iffloatpage\{}value for float page\verb|}{|value for other pages\verb|}| -% +% +% \medskip +% \Cmd{iffloatpage\{}\meta{value for float page}\verb|}{|\meta{value for other pages}\verb|}| +% \medskip +% % You can even use this to get rid of the decorative line on float pages only % by defining: -% +% % \begin{verbatim} % \renewcommand{\headrulewidth}{\iffloatpage{0pt}{0.4pt}} % \end{verbatim} -% +% % Sometimes you may want to change the layout also for pages that contain a % float on the top of the page, a float on the bottom of the page or a footnote on the bottom of the page. -% +% % \Package{fancyhdr} gives you the commands \cs{iftopfloat}, \cs{ifbotfloat} and \cs{iffootnote} -% similar to \cs{iffloatpage}. -% +% similar to \cs{iffloatpage}. For example: +% \begin{verbatim} +% \fancyhead[R]{\iftopfloat{This page has a topfloat} +% {There is no topfloat here}} +% \end{verbatim} +% % Note: Marks in floats will not be visible in \latex/'s output routine, so % it is not useful to put marks in floats. So there is currently no way to % let a float (e.g.\ a figure caption) influence the page header or footer. -% +% % \section{Those blank pages} % \label{sec:blank} -% +% % In the \texttt{book} class when the \texttt{openany} option is not given or % in the \texttt{report} class when the \texttt{openright} option is given, % chapters start at odd-numbered pages, half of the time causing a blank page -% to be inserted. Some people prefer this page to be completely empty, i.e.\ +% to be inserted. Some people prefer this page to be completely empty, i.e.\ % without headers and footers. This cannot be done with \cs{thispagestyle} % as this command would have to be issued on the \emph{previous} page. There % is, however, no magic necessary to get this done: -% +% % \PSindex{empty} % \CmdIndex{clearpage} % \CmdIndex{cleardoublepage} % \begin{verbatim} -% \clearpage{\pagestyle{empty}\cleardoublepage} +% \clearpage\begingroup\pagestyle{empty}\cleardoublepage\endgroup % \end{verbatim} -% +% % As the \Cmd{pagestyle\{empty\}} is enclosed in a group it only affects the % page that may be generated by the \cs{cleardoublepage}. You can of % course put the above in a private command. If you want to have this done @@ -1327,7 +1720,8 @@ % \begin{verbatim} % \makeatletter % \def\cleardoublepage{\clearpage\if@twoside \ifodd\c@page\else -% \hbox{} +% \begingroup +% \mbox{} % \vspace*{\fill} % \begin{center} % This page intentionally contains only this sentence. @@ -1335,18 +1729,19 @@ % \vspace{\fill} % \thispagestyle{empty} % \newpage -% \if@twocolumn\hbox{}\newpage\fi\fi\fi} +% \if@twocolumn\mbox{}\newpage\fi +% \endgroup\fi\fi} % \makeatother % \end{verbatim} -% +% % \section{\textsf{N} of \textsf{M} style page numbers} % \label{sec:nofm} -% +% % Some document writers prefer the pages to be numbered as \textsf{n} of % \textsf{m} where \textsf{m} is the number of pages in the document. % There is a package \Package{lastpage} % available which you can use with \Package{fancyhdr} as follows: -% +% % \begin{verbatim} % \usepackage{lastpage} % ... @@ -1360,13 +1755,13 @@ % \end{verbatim} % We clear all the headers including its rule. The footer will be % ``inherited'' from the pagestyle \texttt{fancy}. -% +% % The value of the \texttt{LastPage} label can be used to % make different headers or footers on the last page of a document. E.g.\ if % you want the footer of every odd page, except if it is the last one, to % contain the text ``please turn over'', this can be done as % follows: -% +% % \begin{verbatim} % \usepackage{lastpage} % \usepackage{ifthen} @@ -1374,33 +1769,37 @@ % \fancyfoot[R]{\ifthenelse{\isodd{\value{page}} \and \not % \(\value{page}=\pageref{LastPage}\)}{please turn over}{}} % \end{verbatim} -% +% +% In order to get the number of pages correctly used, you usually have +% to do one additional \LaTeX{} run. +% +% % \section{Chapter or section related page numbers} -% +% % In technical documentation very often page numbers are used of the form % 2-10 where the first number is the chapter number and the second is the % pagenumber relative to the chapter. Sometimes section is used rather than -% chapter. The package \Package{chappg} can be used to get this format. -% -% Basically this package redefines \cs{thepage} as +% chapter. The package \Package{chappg} can be used to get this format. +% +% Basically this package redefines \cs{thepage} as % \cs{thechapter}\cs{chappgsep}\Cmd{arabic\{page\}}, where % \cs{chappgsep} by default is `-'. If you want do use a different % separator, you must redefine \cs{chappgsep}, for example to use an % en-dash: -% +% % \begin{verbatim} % \renewcommand{\chappgsep}{--} % \end{verbatim} -% +% % To use a different prefix, for example the section number, use the % \Cmd{pagenumbering\{bychapter\}} command with an optional argument % specifying the prefix. % \CmdIndex{pagenumbering} -% +% % \begin{verbatim} % \pagenumbering[\thesection]{bychapter} % \end{verbatim} -% +% % What the package also does is reset the page number to 1 at the beginning % of each chapter. % @@ -1419,12 +1818,12 @@ % \pagenumbering{bychapter} % \chapter{Introduction} % \end{verbatim} -% +% % There is a caveat when you have appendices in your document. Before the % \cs{appendix} command you should give a \cs{clearpage} or % \cs{cleardoublepage}. See the \Package{chappg} documentation for % details. -% +% % There is a fundamental difference between the page numbering of the style % ``\emph{m} of \emph{n}'' as described in the previous section and the % current one. The \emph{m} of \emph{n} style is only used in the page header @@ -1432,37 +1831,83 @@ % ``\emph{See page \emph{xx}}''. Therefore it does not change the command % \cs{thepage}. The page numbering style ``2-10'', however should be used % in all references to the page number, therefore it must be done by redefining -% \cs{thepage}. -% -% +% \cs{thepage}. +% +% \section{Switching page styles} +% \label{sec:switching} +% +% Page style \texttt{fancy}, if not redefined, does not have the definitions of the +% headers and footers built-in, but they are defined in the document, +% globally, or locally in a group. This also applies to the definitions of the +% \cs{chaptermark} and/or \cs{[sub]sectionmark} commands. So if you want +% to switch from another page style to the \texttt{fancy} page style +% later in the document, and that other page style has changed for +% example the \cs{chaptermark} and/or \cs{[sub]sectionmark} commands, +% you will have to redefine these yourself and maybe also +% the definitions of the headers and footers, at that point. +% For example +% \begin{verbatim} +% \pagestyle{fancy} +% \renewcommand{\chaptermark}[1]{\markboth{Chapter \thechapter. ##1}{}} +% \renewcommand{\sectionmark}[1]{\markright{\thesection\ ##1}} +% \end{verbatim} +% Please note that you have to double the \verb|#| signs, because the +% definitions are inside a macro. +% +% If the previous page style was one of the standard \LaTeX{} page +% styles, or some page style that is not based on \Package{fancyhdr}, +% then the definitions of \cs{fancyhead} or \cs{fancyfoot} are not +% affected. So strictly you don't have to include them. But if it was +% based on \Package{fancyhdr} and had different definitions, you will +% get the wrong headers and/or footers when you switch back to page +% style \texttt{fancy}. So it is safer to include them anyway. +% +% A better possibility is to define your own page style, and include +% these definitions in that page style: +% \begin{verbatim} +% \fancypagestyle{myfancy}{ +% \renewcommand{\chaptermark}[1]{\markboth{Chapter \thechapter. ##1}{}} +% \renewcommand{\sectionmark}[1]{\markright{\thesection\ ##1}} +% \fancyhead{...} +% } +% ... +% \pagestyle{myfancy} +% \end{verbatim} +% +% In general, when you use only one page style \texttt{fancy} in your +% document, with the occasional \cs{thispagestyle} excursion to page +% style \texttt{plain} or \texttt{empty}, you can just keep the +% definitions globally in your document, but as soon as you use more +% than one page style, and swicth between them, it is highly advisable +% to define them (including page style \texttt{fancy}) with +% \cs{fancypagestyle} and put all the relevant definitions inside them. +% +% There is another caveat, when switching page styles, if they have +% different definitions of \cs{chaptermark} in the \texttt{book} or +% \texttt{report} document class or similar ones. When you put the +% \cs{pagestyle} command \emph{after} the \cs{chapter} command, then the +% \cs{chapter} command calls the \cs{chaptermark} of the previous page +% style, which is probably not what you intended. So you must issue the +% \cs{pagestyle} command \emph{before} the \cs{chapter} command. But +% this would probably change the page style of the previous page, which +% is too early. Therefore you would have to give a \cs{newpage}, +% \cs{clearpage} or \cs{cleardoublepage} command +% before the \cs{pagestyle} command, so that the last page will be +% finished with the previous page style. I.e., the proper sequence is: +% \begin{verbatim} +% \newpage % (or \clearpage or \cleardoublepage) +% \pagestyle{newstyle} +% \chapter{My New Chapter} +% \end{verbatim} +% % \section{When to change the headers and footers?} % \label{sec:change} -% -% Sometimes you want to change the header or footer layout in the course of a -% document. Some of these changes can be accomplished by using the mark -% mechanism as may be seen in section~\ref{sec:custom} and \ref{sec:xmarks}. -% However, sometimes we want a more drastic change, e.g.\ to change the page -% numbering from roman to arabic (with \cs{pagenumbering}), to change one of -% \index{page style>changes} -% the \Package{fancyhdr} fields or to change to another page style. -% Sometimes you may be surprised to find the change to occur too early. In -% general the above mentioned changes take effect immediately, i.e.\ on the -% page that is currently being built. If you want the change to take effect -% at the next page you must make sure that the current page is finished. In -% \CmdIndex{clearpage} -% most cases this can be done by issuing a \cs{newpage} or \cs{clearpage} command before -% any of the above mentioned changes. If this is not possible you can use the -% \TTindex{afterpage.sty} -% \Package{afterpage} package with:\\ -% \Cmd{afterpage\{}\Cmd{fancyhead[L]\{new value\}\}} or -% \CmdIndex{pagenumbering} -% \Cmd{afterpage\{}\Cmd{pagenumbering\{roman\}\}}. You cannot use \cs{afterpage} -% to change the \cs{pagestyle} as the commands issued by \cs{afterpage} -% are local in a group, and the \cs{pagestyle} command makes only local -% changes. The \cs{pagenumbering} and the \Package{fancyhdr} commands -% make global changes so they will work, as will the \cs{thispagestyle} -% command. -% +% +% In \smartref{sec:change}{sec:switching} we switched page styles at a +% point that has a clear page break (the beginning of a chapter). +% Sometimes you want to change only a header or footer without changing +% the whole page style. +% % It should be noted that although the \Package{fancyhdr} commands like % \cs{fancyhead} take effect immediately, this does not mean that any % ``variables'' used in these commands get the value they have at the place @@ -1470,37 +1915,285 @@ % the page number that will be inserted in the footer is not the page number % of the page where this command is given, but rather the page number of % the actual page where the footer is constructed. Of course for the page -% number this is what you expect, but it is also true for other commands. -% -% So if you have a book where each chapter is written by a different author -% and you want the name of the author in the lower left-hand corner you can -% use the following commands: -% +% number this is what you expect, but it is also true for other +% commands. There is a difference, however. The page number is +% incremented \emph{after} the page has been constructed. When we have +% our own ``variables'', however, these are usually changed in the +% middle of our text. +% +% As an example we take a book where each chapter is written by a different author. +% If we want the name of the author in the header opposite the chapter +% title, we can use the following commands: +% % \begin{verbatim} % \newcommand{\TheAuthor}{} % \newcommand{\Author}[1]{\renewcommand{\TheAuthor}{#1}} -% \fancyfoot[L]{\TheAuthor} +% \fancyhead[LE,RO]{\TheAuthor} % \end{verbatim} -% -% \noindent and start each chapter with the command +% +% \noindent and start each chapter with the command % \Cmd{Author\{Real Name\}}. -% If however, the author name would be changed before a page is -% completed the wrong author could come in the footer. This would be the case +% If, however, the author name would be changed before a page is +% completed the wrong author could come in the header. This would be the case % if you gave the above command \emph{before} the \cs{chapter} command -% rather than after it. +% rather than after it. So we give the \cs{Author} command after the +% \cs{chapter} command: +% \begin{verbatim} +% \chapter{Chapter Title} +% \Author{Author Name} +% \end{verbatim} +% As a chapter starts on a new page, we can be sure that the \cs{Author} +% command comes at the same page as the chapter start. +% % Another source of problems is the fact that \tex/'s output routine processes % commands ahead, so it may already have processed some commands that produce -% text that will appear on the next page. See the next section for an example. -% +% text that will appear on the next page. So if our book was not divided +% into chapters, but into sections, we cannot use the similar system: +% \begin{verbatim} +% %%% NOTE: This may not work %%%% +% \section{Chapter Title} +% \Author{Author Name} +% \end{verbatim} +% because in this case, when this command comes at the end of a page, +% the ``variable'' \cs{TheAuthor} could be set at that page, but then +% \TeX{} could decide to move the section title to the next page. And +% then the author name would appear one page too early. This problem can +% be solved using marks. In fact this is the whole reason the mark +% mechanism was developed in \TeX. See section~\ref{sec:xmarks}. +% +% The same applies to other changes in the middle of a page, e.g.\ to change the page +% numbering from roman to arabic (with \cs{pagenumbering}). For the same +% reason \Cmd{thispagestyle\{mystyle\}} will not always work in the +% middle of a page. +% +% Some of these changes can be accomplished by using the mark +% mechanism as may be seen in \smartref{sec:change}{sec:scoop} and +% \smartref{sec:change}{sec:xmarks}. +% +% In the remainder of this section we look at two different cases of +% changing the page style in the middle of a page: changing the style of +% the current page and changing the style of the next page. +% +% \subsection{Changing the page style of the current page} +% +% So now we are giving an example how to change the headers and footers, +% only on the current page. In some cases this can be done by the +% \CmdIndex{thispagestyle}% +% \cs{thispagestyle} command. This changes the page style for the +% ``current'' page only. But then we may be hit by the problem mentioned +% above. \LaTeX{} may have a different idea about +% the ``current'' page than you. The use of \cs{thispagestyle} is OK if +% you can be sure that the text where the command \cs{thispagestyle} is +% executed is the same page as where the surrounding text appears. So +% for example directly after a \cs{chapter} command, or after a +% \cs{newpage}. However, when the command is given near the end of a +% page, \LaTeX{} may execute the command, and then decide that the page +% is full and move the text that contains the command to the next page. +% So now the page style is changed on one page earlier than was intended. +% +% A good solution to this problem is to put a label, like +% \Cmd{label\{otherpagestyle\}} in the text where you want the different +% page style, and then in the header and/or footer definitions compare +% the page number with the label page number and choose the proper +% value. For example, if we want to replace the section title on the +% special page with ``MYFANCY SECTION'', like in +% \begin{verbatim} +% \fancypagestyle{myfancy}{ +% \fancyhead[LE,RO]{MYFANCY SECTION} +% } +% \end{verbatim} +% ^^A\Example +% we define a new pagestyle that makes the choice: +% \begin{verbatim} +% \usepackage{ifthen} +% . . . +% \fancypagestyle{switch}{ +% \fancyhead[LE,RO]{% +% \ifthenelse{\value{page}=\pageref{otherpagestyle}} +% {MYFANCY SECTION} +% {\textsl{\rightmark}}} +% } +% \end{verbatim} +% \CmdIndex{ifthenelse} +% where \verb|\textsl{\rightmark}| is the normal value of the header +% field from \Cmd{pagestyle\{fancy\}}. +% Now we choose \Cmd{pagestyle\{switch\}} before our text, or even for +% the whole document. +% +% There can still be some ambiguity on which page gets the different +% header. For example, if the text says: +% \begin{quote} +% This page gets a different header than the surrounding pages. +% \end{quote} +% where do you put the \cs{label}? \LaTeX{} could break the page between +% ``This'' and ``page'', and then would you want the special heading on +% the page where ``This'' appears, or on the page where ``page'' +% appears. It depends on the positioning of the \cs{label} command. +% Probably it is safer to make sure the sentence isn't broken. This can +% be dome by putting the text in a \cs{parbox} or \texttt{minipage} environment. +% \begin{verbatim} +% \noindent +% \begin{minipage}{\textwidth} +% This page should have a different header than the surrounding pages. +% \label{otherpagestyle} +% It is done with the \verb|\pagestyle{switch}| command, that +% has tests in the header field definitions. This chooses the actual +% header depending on the page number. +% \end{minipage} +% \end{verbatim} +% The \cs{noindent} is necessary, otherwise the whole \texttt{minipage} +% will be shifted right by the paragraph indentation. +% +% Note that you cannot reset the page style immediately after this code, +% as this may still influence the current page. If you want to reset it, +% for example to \Cmd{pagestyle\{fancy\}}, you must be sure that it +% happens on a following page. But in this case it isn't even necessary, +% as the special page style acts as the default on all pages except the +% special page. +% +% The special header and footer in page~\pageref{showstruts}, which +% show the struts are done in a similar way, although the header and +% footer are a bit more elaborated there. +% Also there is another complication there, as we also want to make both +% \cs{headruleskip} and \cs{footrulewidth} dependent on the page number. +% Unfortunately, this cannot be done with a simple \cs{ifthenelse} +% \CmdIndex{ifthenelse} +% command. +% Both \cs{headruleskip} and \cs{footrulewidth} are eventually +% used as length parameters, and this requires that they are +% \emph{expandable}. However, the \cs{ifthenelse} construct is not +% expandable, so you will get strange error messages if you use +% something like +% \begin{verbatim} +% %%% NOTE: This does not work %%%% +% \renewcommand{\footrulewidth}{% +% \ifthenelse{\value{page}=\pageref{otherpagestyle}}{0.4pt}{0pt}% +% } +% \end{verbatim} +% For cases like this \Package{fancyhdr} version~4.0 and later has some +% new commands \cs{fancyheadinit}, \cs{fancyfootinit} and \cs{fancyhfinit}. +% \DescribeMacro{\fancyheadinit} +% With \Cmd{fancyheadinit\{\meta{code}\}} you can define some code that will be executed +% just before the construction of the header. As it is executed in the +% header, it can test the correct page number, because the counter +% \texttt{page} is guaranteed to have the correct value in the headers +% and footers. Similarly, the code in \Cmd{fancyfootinit\{\meta{code}\}} is executed in +% \DescribeMacro{\fancyfootinit} +% the footer. And \Cmd{fancyhfinit\{\meta{code}\}} sets its code for both the header +% \DescribeMacro{\fancyhfinit} +% and the footer. Now we can set for example \cs{headruleskip} or +% \cs{footrulewidth} depending on the page number. So instead of putting +% the test inside the definition of \cs{headruleskip}, we can put it +% outside, and then we can use the command \cs{ifthenelse}. So we put +% the following in \Cmd{pagestyle\{switch\}}: +% \begin{verbatim} +% \fancyheadinit{% +% \ifthenelse{\value{page}=\pageref{otherpagestyle}} +% {\renewcommand{\headruleskip}{4pt}} +% {\renewcommand{\headruleskip}{0pt}} +% } +% \fancyfootinit{% +% \ifthenelse{\value{page}=\pageref{otherpagestyle}} +% {\renewcommand{\footrulewidth}{0.4pt}} +% {\renewcommand{\footrulewidth}{0pt}} +% } +% \end{verbatim} +% Now here is the definition of the page style used for page~\pageref{showstruts}. +% \begin{verbatim} +% \fancypagestyle{showstruts}{% +% \fancyhead[L]{% +% \ifthenelse{\value{page}=\pageref{showstruts}}% +% {\strutheader}% +% {\rightmark}% +% } +% \fancyfoot[L]{% +% \ifthenelse{\value{page}=\pageref{showstruts}}% +% {\strutfooter}% +% {}% +% } +% \fancyheadinit{% +% \ifthenelse{\value{page}=\pageref{showstruts}}% +% {\renewcommand{\headruleskip}{4pt}}% +% {\renewcommand{\headruleskip}{0pt}}% +% } +% \fancyfootinit{% +% \ifthenelse{\value{page}=\pageref{showstruts}}% +% {\renewcommand{\footrulewidth}{0.4pt}}% +% {\renewcommand{\footrulewidth}{0pt}}% +% } +% } +% \end{verbatim} +% The label used on that page is \texttt{showstruts}. \cs{strutheader} +% and \cs{strutfooter} are macros that contain the code to draw these +% pictures. In this example the values for \cs{headruleskip} and +% \cs{footrulewidth} in the \emph{else} case are the same as the global +% values. So we could have left these \emph{else} parts empty. Then they +% would keep the global values. +% However, often explicit is better than implicit. +% +% These initialisation commands cannot be used to make global changes to +% the page, for example to \cs{headheight}. Neither can you use them to +% change \cs{fancyhead} or \cs{fancyfoot}, because these have already +% been set up. But you can use it to set the color and font of the +% header and/or footer, for example to get large, red text in the +% headers and footers on this specific page: +% \begin{verbatim} +% \fancyhfinit{% +% \ifthenelse{\value{page}=\pageref{otherpagestyle}} +% {\color{red}\Large} +% {} +% } +% \end{verbatim} +% +% \subsection{Changing the page style of the next page} +% +% If you want the change of the page style to take effect +% at the next page you must make sure that the current page is finished. In +% most cases this can be done by issuing a +% \CmdIndex{clearpage}\CmdIndex{newpage}% +% \cs{newpage} or \cs{clearpage} command before % any changes. However, +% this will immediately end the current page, possibly leaving you with a +% half-empty page, which may be undesirable. +% +% If this is not what you want, you can use the +% \TTindex{afterpage.sty}% +% \Package{afterpage} package with:\\[1ex] +% \CmdIndex{afterpage}\Cmd{afterpage\{}\Cmd{fancyhead[L]\{new value\}\}} or\\ +% \CmdIndex{pagenumbering}\Cmd{afterpage\{}\Cmd{pagenumbering\{roman\}\}}. +% \\[1ex] +% You cannot use \cs{afterpage} +% to change the \cs{pagestyle} as the commands issued by \cs{afterpage} +% are local in a group, and the \cs{pagestyle} command makes only local +% changes. The \cs{pagenumbering} and the \cs{thispagestyle} +% command make global changes, as well as changes to \LaTeX's counters, +% such as \cs{setcounter} and \cs{addtocounter}. +% So these can be used\footnote{In \Package{fancyhdr} version~3 and +% earlier the commands like \cs{fancyhead} and \cs{fancyfoot} also made +% global changes. This is no longer the case in version~4.0 and later.}. +% Here is an example to change the page style of the next page with \cs{afterpage}: +% ^^A \Example +% \begin{verbatim} +% \usepackage{afterpage} +% \usepackage{fancyhdr} +% \fancypagestyle{myfancy}{ +% \fancyhead[LE,RO]{\textbf{MYFANCY SECTION}} +% \fancyhead[LO,RE]{\textbf{MYFANCY CHAPTER}} +% \fancyfoot[C]{\textbf{--~\thepage~--}} +% } +% . . . +% \afterpage{\thispagestyle{myfancy}} +% \end{verbatim} +% Then the page after this code will have the page style \texttt{myfancy}. +% % \section{Headers and footers induced by the text} % \label{sec:xmarks} -% +% % We have seen how we can use \LaTeX's marks to get information from the % document contents to the headers and footers. The marks mechanism is the % only reliable mechanism that you can use to get changing information to the % headers or footers. This is because \latex/ may be processing your document -% ahead before deciding to break the page. -% +% ahead before deciding to break the page. +% % Sometimes the two marks that \latex/ offers are not enough. An example is % the following: % \begin{quote} @@ -1509,14 +2202,14 @@ % \index{Continued\ldots} % first page and ``(Continued\ldots)'' at the top in the margin of the next page. % \end{quote} -% +% % You cannot use \latex/'s mark mechanisms for this if you also want to use % chapter and section information. -% +% % The \Package{extramarks} package gives you % two extra marks that can be used in this situation. % Here is a way to use this package: -% +% % \begin{verbatim} % \usepackage{extramarks} % ... @@ -1529,14 +2222,14 @@ % \extramarks{Continued\ldots}{} %2 % \extramarks{}{} %3 % \end{verbatim} -% +% % \CmdIndex{extramarks} % Note that the \cs{extramarks} command must be close to the text, i.e no % empty lines (paragraph boundaries) should intervene. Otherwise the page may % be broken at that boundary and the extramarks would come on the wrong page. % The final \verb+\extramarks{}{}+ is to prevent the `Continued\ldots' % header to appear on the following pages. -% +% % Explanation: There are two new marks that can be used in the page layout with this % package: If commands of the form % \verb|\extramarks{|$m_1$\verb|}{|$m_2$\verb|}| are given @@ -1551,12 +2244,12 @@ % \cs{extramarks} command (indicated by \texttt{\%3}). % % However, when the page break falls in the block, the mark generated by -% \%1 will be the last one on the first page. Therefore on that page +% \texttt{\%1} will be the last one on the first page. Therefore on that page % \cs{lastxmark} will be `Continued on next page\ldots'. On the second % page, the first mark will be \texttt{\%2}, therefore \cs{firstxmark} will be `Continued\ldots'. % On all the following pages the values of \texttt{\%3} will be used, % i.e. empty ones. Of course in real life you would leave out the \texttt{\%} indicators. -% +% % In case you want the last $m_1$ value or the first $m_2$ value, you % can use the \cs{lastleftxmark} or \cs{firstrightxmark}, respectively. % For symmetry reasons there are also commands \cs{firstleftxmark} @@ -1569,17 +2262,17 @@ % \CmdIndex{lastrightxmark} % \CmdIndex{topleftxmark} % \CmdIndex{toprightxmark} -% +% % The package also gives you the \cs{firstleftmark} and \cs{lastrightmark} % commands that complement the standard \latex/ marks. % \CmdIndex{firstleftmark} % \CmdIndex{lastrightmark} -% +% % To stress the point that marks are the correct way to do this, let me % give you a ``solution'' that will not work\footnote{Actually there is % another way but it requires two \latex/ passes: you can put \cs{label} % commands before and after the text and compare the \cs{pageref}s.}: -% +% % \begin{verbatim} % \fancyhead[L]{Continued} % \fancyfoot[R]{Continued on next page\ldots} @@ -1587,7 +2280,7 @@ % \fancyhead[L]{} % \fancyfoot[R]{} % \end{verbatim} -% +% % You may be tempted to think that the first \cs{fancyhead} and \cs{fancyfoot} % will be in effect when \tex/ breaks the page in the middle of the text, % and the last ones when the page breaks after the text. This is not true as @@ -1600,21 +2293,21 @@ % the first definitions to be in effect when \tex/ decides to break the page % exactly at this boundary. Actually the marks mechanism was invented to get % rid of these kinds of problems. -% +% % In the above example the text ``Continued'' appears in the page header. It % \index{margin} % may be nicer to put it in the margin. This can be easily % accomplished by positioning it at a fixed place relative to the page header. % In plain \tex/ you would use a concoction of \Cmd{hbox to 0pt}, % \Cmd{vbox to 0pt}, \cs{hskip},\cs{vskip}, \cs{hss} and -% \cs{vss} but fortunately +% \cs{vss} but fortunately % \latex/'s \texttt{picture} environment gives a much cleaner way to do this. % In order not to disturb the normal header layout we put the text in a zero-sized % \texttt{picture}. Generally this is the best way to position things on fixed % places on the page. You can then also use the normal headings. See also -% section~\ref{sec:thumb} for another example of +% section~\ref{sec:thumb} for another example of % this technique. -% +% % \TTindex{picture} % \begin{verbatim} % \fancyhead[L]{\setlength{\unitlength}{\baselineskip}% @@ -1622,34 +2315,34 @@ % \put(-2,-3){\makebox(0,0)[r]{\firstxmark}} % \end{picture}\leftmark} % \end{verbatim} -% +% % This solution can of course also be used for the footer. Make sure you put the % \texttt{picture} as the first thing in left-handside entries and last in right-handside % ones. -% +% % Finally you may want to put ``(Continued\ldots)'' in the \emph{text} % rather than in the header or the margin. Then you have to use the % \TTindex{afterpage.sty} % \Package{afterpage} package. We also decide to make a separate % environment for it. -% +% % \begin{verbatim} % \newenvironment{continued}{\par % \extramarks{}{Continued on next page\ldots} % \afterpage{\noindent\firstxmark\vspace{1ex}} % }{\extramarks{(Continued\ldots)}{}\par} % \end{verbatim} -% +% % It is a bit dangerous to use \cs{firstxmark} outside the page layout % routine, but apparently with \cs{afterpage} this works. If you would % need the information further on in the page you must remember the state of % the marks in your own variable. You can set this in one of the % \Package{fancyhdr} fields. For example if you want to add something % \emph{after} the broken piece of text you can use the following: -% +% % \begin{verbatim} % \newcommand{\mysaved}{} -% +% % \newenvironment{continued}{\par % \extramarks{}{Continued on next page\ldots} % }{\extramarks{(Continued\ldots)}{}\par\vspace{1ex}\mysaved} @@ -1658,14 +2351,14 @@ % {\gdef\mysaved{}} % {\gdef\mysaved{\noindent[Continued from previous page]}}} % \end{verbatim} -% +% % If you want to include one of the marks or other varying information in the % saved text, you must use \cs{xdef} rather than \cs{gdef}. -% -% +% +% % \section{A movie} % \label{sec:movie} -% +% % \index{movie} % \TTindex{picture} % If you put at each page on the same place a picture that slightly changes @@ -1674,27 +2367,27 @@ % simplicity we assume that each picture is in a postscript (EPS) file called % \texttt{pic}$\langle n\rangle$.\texttt{ps} where $\langle n\rangle$ is the page number and that we use % the \Package{graphics} or \Package{graphicx} package\footnote{If you use an older version of -% \LaTeX{} you could use the \Package{epsf} or \Package{epsfig} package.}. +% \LaTeX{} you could use the \Package{epsf} or \Package{epsfig} package.}. % \TTindex{graphics} % \TTindex{graphicx} % \TTindex{epsf} % \TTindex{epsfig} % To put the movie in the righthandside bottom corner the following will work: -% +% % \begin{verbatim} % \fancyfoot[R]{\setlength{\unitlength}{1mm} % \begin{picture}(0,0) % \put(5,0){\includegraphics{pic\thepage.ps}} % \end{picture}} % \end{verbatim} -% +% % Notice that the \cs{unitlength} parameter should % be set locally in the fancyhdr field in order to avoid unwanted % interference with its value in the text. -% +% % \section{Thumb-indexes} % \label{sec:thumb} -% +% % \index{bible} % Some railroad guides and expensive bibles have so called % \index{thumb-index} @@ -1705,7 +2398,7 @@ % independent of the contents of the page, we print these blobs as part of % the header in a zero-sized \texttt{picture} as described in the previous % section. -% +% % Of course we have to take care of two-sided printing, and we may want to % have an index page with all the blobs in the correct position. The solution % requires some hand-tuning to get the blobs nicely spaced out vertically. @@ -1715,10 +2408,10 @@ % \cs{unitlength} set to 18~mm. Page numbers are set in the headers at the % outer sides, and the blobs are attached to these. In this example the % section numbers are used to position the blobs, but you can replace this -% with any numeric value. +% with any numeric value. % See figure~\ref{fig:overview} for the resulting % overview page and figure~\ref{fig:thumb} for the code. -% +% % \begin{figure}[htbp] % \setlength{\unitlength}{9mm} % \newcommand{\blob}{\rule[-.2\unitlength]{1\unitlength}{.5\unitlength}} @@ -1727,14 +2420,14 @@ % \put(1,-\value{line}){\blob} % \put(-7.5,-\value{line}){\arabic{line}} % \put(-7,-\value{line}){#1}} -% +% % \newcommand{\overview}{1 % \begin{picture}(0,0) % \secname{Introduction} % \secname{The first year} % \secname{Specialisation} % \end{picture}} -% +% % \begin{center} % \leavevmode % \begin{picture}(11.3,5) @@ -1749,27 +2442,27 @@ % \begin{verbatim} % \setlength{\unitlength}{18mm} % \newcommand{\blob}{\rule[-.2\unitlength]{2\unitlength}{.5\unitlength}} -% +% % \newcommand\rblob{\thepage % \begin{picture}(0,0) % \put(1,-\value{section}){\blob} % \end{picture}} -% +% % \newcommand\lblob{^^A % \begin{picture}(0,0) % \put(-3,-\value{section}){\blob} % \end{picture}^^A % \thepage} -% +% % \pagestyle{fancy} % \fancyfoot[C]{} -% +% % \newcounter{line} % \newcommand{\secname}[1]{\addtocounter{line}{1}^^A % \put(1,-\value{line}){\blob} % \put(-7.5,-\value{line}){\Large \arabic{line}} % \put(-7,-\value{line}){\Large #1}} -% +% % \newcommand{\overview}{\thepage % \begin{picture}(0,0) % \secname{Introduction} @@ -1777,7 +2470,7 @@ % \secname{Specialisation} % ...etc... % \end{picture}} -% +% % \begin{document} % \fancyhead[R]{\overview}\mbox{}\newpage % This produces the overview page % \fancyhead[R]{} % Front matter may follow here @@ -1791,9 +2484,9 @@ % \caption{Thumb-index code} % \label{fig:thumb} % \end{figure} -% +% % \section{Float placement} -% +% % Floats are page elements that float with respect to the rest of the % document. Standard floats are tables and figures, but with the % \Package{float} package you can easily make new ones, like algorithms. Most @@ -1803,7 +2496,7 @@ % however be some pathological cases where it is impossible to convince % \LaTeX{} to do things your way. In the following we will use figures as an % example but everything applies to other floats as well. -% +% % The most encountered problems with floats are: % \begin{enumerate} % \item You want a float at a certain position in the text, but \LaTeX{} @@ -1812,7 +2505,7 @@ % the document or the end of a chapter. % \item \LaTeX{} complains about ``Too many floats''. % \end{enumerate} -% +% % In the first two cases you must first check if you have given the correct % ``placement'' parameter to you float, e.g. \Cmd{begin\{figure\}[htp]} % specifies that your figure may be placed either: Here (i.e. in the text @@ -1821,7 +2514,7 @@ % could also have specified ``b'' for Bottom of the page. The order of the % letters is insignificant, you cannot force \LaTeX{} to try Bottom first % and then Top by specifying \texttt{[bt]}. -% +% % If \LaTeX{} doesn't put the float at the place where you expected it, it is % usually caused by the following: % \begin{enumerate} @@ -1858,13 +2551,13 @@ % \bs bottomfraction & max fraction of page for floats at bottom & 0.3 \\ % \bs textfraction & min fraction of page for text & 0.2 \\ % \bs floatpagefraction & min fraction of floatpage that should have -% floats & 0.5 \\ +% floats & 0.5 \\ % \bottomrule % \end{tabular} % \end{center} -% +% % There are also some others for double column floats in two-column documents. -% +% % The values in the righthand column are the defaults for the standard % \latex/ classes. Other classes could use different defaults. As you see % with the default values a float will not be put in the bottom of a page if @@ -1883,18 +2576,18 @@ % \end{verbatim} % You may want to be careful not to make \cs{floatpagefraction} too small, % otherwise you may get too many small floatpages. -% +% % You can force \latex/ to ignore most of the parameters for one specific float % occurrence by % including an exclamation mark (!) in the placement parameters, e.g. % \begin{verbatim} % \begin{figure}[!htb] % \end{verbatim} -% +% % Floats which contain a ``\texttt{t}'' in the position parameter could be % placed before the place where they are referenced (but on the same page). % This is normal behaviour for \latex/ but some people just don't like it. -% There are a number of ways to prevent this: +% There are a number of ways to prevent this: % \begin{enumerate} % \item Of course deleting the ``\texttt{t}'' will help, but in general this is % undesirable, as you may want the float to be placed at the top of the @@ -1906,20 +2599,20 @@ % moved to the next page. This can also be done with \texttt{[b]} or % without parameter for all floats on this page. % \end{enumerate} -% +% % If in spite of all your attempts \latex/ still moves your floats to the end % of the document or the end of a chapter, you can insert a \cs{clearpage} % command. This will start a new page and insert all pending floats before % continueing. If it is undesirable to have a pagebreak you can use the % \Package{afterpage} package and the following command: % \begin{verbatim} -% \afterpage{clearpage} +% \afterpage{\clearpage} % \end{verbatim} -% +% % This will wait until the current page is finished and then flush all % outstanding floats. In some pathological circumstances \Package{afterpage} % may give strange results, however. -% +% % Finally, if you want a float only at the place where you define it, without % \latex/ moving it whatsoever, you can use the \Package{float} package and % give the command: @@ -1935,7 +2628,7 @@ % \begin{verbatim} % \afterpage{\clearpage \begin{figure}[H] ... \end{figure}} % \end{verbatim} -% +% % Complaints from \latex/ about ``Too many floats'' are usually caused by one % of the above problems: floats not being able to be placed and \latex/ % collecting too many of them. The solutions given above, especially those @@ -1945,9 +2638,9 @@ % this number. If you need still more then you must edit a private copy of % this file, but even then there will be some limit that you cannot pass. % Then your only resort will be to change your document. -% +% % \section{Multipage Floats} -% +% % \LaTeX's floats cannot be split across pages. Sometimes, however, you want % to have a table or figure that doesn't fit on one page. The easiest way is % to split these into multiple table or figure environments, but this has a @@ -1958,12 +2651,12 @@ % \item How do you keep them together? % \item You don't want more than one entry in the list of figures/tables. % \end{itemize} -% +% % Although these problems are not fully solvable in all cases, here are a % couple of suggestions: -% +% % \subsection{Tables} -% +% % For tables longer than a page you can use the \Package{longtable} package. % \TTindex{longtable} % This package defines a \texttt{longtable} environment that is a kind of @@ -1990,16 +2683,16 @@ % \end{verbatim} % The last form has the additional advantage that most of the outstanding % floats will be printed first. -% -% +% +% % \subsection{Figures} -% +% % There isn't an equivalent \texttt{longfigure} solution, so for figures you % will usually have to split it yourself. In general this is less of a % problem. However, the problem you get now is how to keep them together, % i.e. how to get the parts on subsequent pages, and how to get a single % entry in the list of figures. -% +% % You will have to split the figure into pieces and put each part % in a separate \texttt{figure} environment. To keep them together it is best % to use only the \texttt{[p]} placement, so that they will be put on @@ -2027,13 +2720,13 @@ % \end{center} % \end{figure} % \end{verbatim} -% +% % You have to make sure that the last part is big enough, otherwise \LaTeX{} % could decide to postpone it until it has collected some more floats. This % can be done either by making the figure big enough (e.g. by adding some -% \cs{vspace}), or by tweaking the \cs{floatpagefraction} +% \cs{vspace}), or by tweaking the \cs{floatpagefraction} % \CmdIndex{floatpagefraction} parameter. -% +% % If you want your multipage figure to start at a lefthand-side % (even-numbered) page you can use a test in the \cs{afterpage} command % (using the \Package{ifthen} package): @@ -2044,18 +2737,18 @@ % \end{verbatim} % If there are too many floats on the skipped page, this may still fail to % start your multipage figure on an even page, however. -% +% % \section{Deprecated commands} % \label{sec:depr} -% +% % This section contains the description of deprecated commands. These % were parts of the original implementation of \Package{fancyheadings}. -% They continue to work for compatibility reasons, +% They continue to work for compatibility reasons, % but it is recommended not to use them anymore. This description is % given so that you know what they mean and how to convert them to the % standard commands. To be honest, I use these sometimes myself in quick % examples, because \cs{lhead} is less typing than \Cmd{fancyhead[L]}. -% +% % These commands for specifying the header or footer fields and their translation to % the modern commands are given in table~\ref{tab:depr}. % @@ -2108,7 +2801,7 @@ % The \cs{fancyplain} command is only useful within the pagestyle \texttt{fancyplain}. % Nowadays you would just redefine pagestyle \texttt{plain} with the % \Cmd{fancypagestyle\{plain\}\{xxxx\}} command (see section~\ref{sec:pagestyle-plain}). -% +% % \CmdIndex{plainheadrulewidth} % \CmdIndex{plainfootrulewidth} % There are also \cs{plainheadrulewidth} and \cs{plainfootrulewidth} @@ -2118,15 +2811,20 @@ % redefine pagestyle \texttt{plain} with the \cs{fancypagestyle} command. % % \section{Contact information} -% -% Piet van Oostrum\\ -% E-mail: piet@vanoostrum.org \\ -% WWW: http://piet.vanoostrum.org -% +% +% Pieter van Oostrum\\ +% E-mail: pieter@vanoostrum.org \\ +% WWW: http://pieter.vanoostrum.org +% \\[1ex] +% The source code can be found on Github:\\ +% \url{https://github.com/pietvo/fancyhdr}\\ +% Bugs and suggestions for improvements can be reported at\\ +% \url{https://github.com/pietvo/fancyhdr/issues} +% % \section{Version information} % \begin{itemize} -% \item Version 1.0. March 11, 2003. This is the version that was distributed for a -% long time on CTAN. Version history before this has been lost. +% \item Version 1.0. March 11, 2003. This is the version that was distributed for a +% long time on CTAN. Version history before this has been lost. % \item Version 2.0. August 27, 2016: % \begin{itemize} % \item Removed references to fixmarks.sty as that is no longer used. @@ -2171,6 +2869,44 @@ % vertical space outside of the definition of \cs{footrule}. % \end{itemize} % \end{itemize} +% \subsection{Changes in version 4} +% \label{sec:version-4} +% Version 4 is a significant rewrite of the package. It also introduces +% a number of new features. +% \begin{itemize} +% \item Version 4.0, March 15, 2020--Jan 04, 2021 +% \begin{itemize} +% \item Options introduced on the \cs{usepackage} command. +% \item The check whether the header or footer fits in +% \cs{headheight} and \cs{footskip}, respectively, no longer +% adjusts these values for the following pages. This appeared to be too +% confusing. However, when the package option \texttt{compatV3} is given, the old +% behaviour is kept. \\ +% The \texttt{nocheck} option now eliminates these checks completely, on +% your own risk. (See section~\ref{sec:warning} on page~\pageref{page:warning}.) +% \item Eliminated global definitions. All definitions are now local. +% The \cs{global} case was originally so that you could do definitions in +% a group and they would be applied globally. This was a mistake. If +% you make them locally they should stay local. And it caused +% problems with switching page styles, because then the global style +% would be changed, which you generally don't want.\\ +% However, when the package option \texttt{compatV3} is given, the old +% behaviour is kept. (See section~\ref{sec:options}.) +% \item The page style \texttt{fancydefault}. +% \item The \cs{headruleskip} parameter. +% \item The \cs{fancyheadinit}, \cs{fancyfootinit}, and +% \cs{fancyhfinit} commands. +% \item[] \textbf{Note:} The following changes were mostly copied from the +% \texttt{nccfancyhdr} package by Alexander I. Rozhenko. +% \item The \cs{fancycenter} command (section~\ref{sec:fancycenter}). +% \item The \texttt{headings} and \texttt{myheadings} package options +% (see section~\ref{sec:options}). +% \item The \cs{fancypagestyle} command has an optional parameter \oarg{base-style}. +% +% \end{itemize} +% +% \end{itemize} +% % % \StopEventually{% % \PrintChanges @@ -2185,6 +2921,7 @@ % % % \section{Large chapter/section titles} +% \label{sec:longtitles} % % \index{long titles} % Sometimes a chapter or section title is too large to fit in the header @@ -2379,69 +3116,69 @@ % %<*fancyhdr> % \changes{fancyhdr v1.4}{1994/09/16}{Correction for use with \cs{reversemarginpar}} -% +% % \changes{fancyhdr v1.5}{1994/09/29}{Added the \cs{iftopfloat}, % \cs{ifbotfloat} and \cs{iffloatpage} commands} -% +% % \changes{fancyhdr v1.6}{1994/10/04}{Reset single spacing in headers/footers for use with % \Package{setspace.sty} or \Package{doublespace.sty}} -% +% % \changes{fancyhdr v1.7}{1994/10/04}{Changed \cs{let}\cs{@mkboth}\cs{markboth} to % \texttt{\cs{def}\cs{@mkboth}\{\cs{protect}\cs{markboth}\}} to make it more robust.} -% +% % \changes{fancyhdr v1.8}{1994/12/05}{corrections for % \Package{amsbook}/\Package{amsart}: define \cs{@chapapp} and (more % importantly) use the \cs{chapter/sectionmark} definitions from \texttt{ps@headings} if % they exist (which should be true for all standard classes).} -% -% \changes{fancyhdr v1.9}{1995/03/31}{The proposed +% +% \changes{fancyhdr v1.9}{1995/03/31}{The proposed % \texttt{\cs{renewcommand}\{\cs{headrulewidth}\}} \texttt{\{\cs{iffloatpage}\ldots} % construction in the doc did not work properly with the \texttt{fancyplain} style.} -% -% \changes{fancyhdr v1.91}{1995/06/01}{The definition of \cs{@mkboth} wasn't +% +% \changes{fancyhdr v1.91}{1995/06/01}{The definition of \cs{@mkboth} wasn't % restored on subsequent \texttt{\cs{pagestyle}\{fancy\}}'s.} -% +% % \changes{fancyhdr v1.92}{1995/06/01}{The sequence % \texttt{\cs{pagestyle}\{fancyplain\} \cs{pagestyle}\{plain\} % \cs{pagestyle}\{fancy\}} would erroneously select the plain version.} -% +% % \changes{fancyhdr v1.93}{1995/06/01}{\cs{fancypagestyle} command added.} -% +% % \changes{fancyhdr v1.94}{1995/12/11}{(suggested by Conrad Hughes % \texttt{<chughes@maths.tcd.ie!>}): added \cs{footruleskip} to allow control over footrule % position (old hardcoded value of .3\cs{normalbaselineskip} is far too high % when used with very small footer fonts).} -% -% \changes{fancyhdr v1.95}{1996/01/31}{call \cs{@normalsize} in the reset code if that is defined, +% +% \changes{fancyhdr v1.95}{1996/01/31}{call \cs{@normalsize} in the reset code if that is defined, % otherwise \cs{normalsize}. This is to solve a problem with % \Package{ucthesis.cls}, as this doesn't define \cs{@currsize}. % Unfortunately for latex209 calling \cs{normalsize} doesn't % work as this is optimized to do very little, so there \cs{@normalsize} should % be called. Hopefully this code works for all versions of LaTeX known to % mankind.} -% -% \changes{fancyhdr v1.96}{1996/04/25}{Initialize \cs{headwidth} to a +% +% \changes{fancyhdr v1.96}{1996/04/25}{Initialise \cs{headwidth} to a % magic (negative) value to catch most common cases that people change -% it before calling \texttt{\cs{pagestyle}\{fancy\}}. -% Note it can't be initialized when reading in this file, because +% it before calling \texttt{\cs{pagestyle}\{fancy\}}. +% Note it can't be initialised when reading in this file, because % \cs{textwidth} could be changed afterwards. This is quite probable. % We also switch to \cs{MakeUppercase} rather than \cs{uppercase} and introduce a % \cs{nouppercase} command for use in headers. and footers.} -% +% % \changes{fancyhdr v1.97}{1996/05/03}{Two changes: \\ % 1. Undo the change in version 1.8 -% (using the \texttt{\cs{pagestyle}\{headings\}} defaults +% (using the \texttt{\cs{pagestyle}\{headings\}} defaults % for the chapter and section marks). The current version of amsbook and % amsart classes don't seem to need them anymore. Moreover the standard % \LaTeX{} classes don't use \cs{markboth} if twoside isn't selected, and this is % confusing as \cs{leftmark} doesn't work as expected.\\ % 2. Include a call to \cs{ps@empty} -% in \cs{ps@@fancy}. This is to solve a problem +% in \cs{ps@@fancy}. This is to solve a problem % in the amsbook and amsart classes, that make global changes to \cs{topskip}, % which are reset in \cs{ps@empty}. Hopefully this doesn't break other things.} -% +% % \changes{fancyhdr v1.98}{1996/05/07}{Added \% after the line \cs{def}\cs{nouppercase}} -% +% % \changes{fancyhdr v1.99}{1996/05/07}{This is the alpha version of fancyhdr 2.0\\ % Introduced the new commands \cs{fancyhead}, \cs{fancyfoot}, and \cs{fancyhf}. % Changed \cs{headrulewidth}, \cs{footrulewidth}, \cs{footruleskip} to @@ -2450,31 +3187,31 @@ % to have them as length registers unless you want to do calculations with % them, which is unlikely. Note that this may make some uses of them % incompatible (i.e. if you have a file that uses \cs{setlength} or \cs{xxxx}!=)} -% +% % \changes{fancyhdr v1.99a}{1996/05/10}{Added a few more \% signs.} -% +% % \changes{fancyhdr v1.99b}{1996/05/10}{Changed the syntax of % \cs{f@nch@for} to be resistent to catcode changes of \texttt{:!=}.\protect\\ % Removed the \texttt{[1]} from the defs of \cs{lhead} etc. because the parameter is % consumed by the \cs{@[xy]lhead} etc. macros.} -% +% % \changes{fancyhdr v1.99c}{1997/06/24}{Corrected \cs{nouppercase} to -% also include the protected form of \cs{MakeUppercase}.\\ +% also include the protected form of \cs{MakeUppercase}.\\ % \cs{global} added to manipulation of \cs{headwidth}.\\ % \cs{iffootnote} command added.\\ % Some comments added about \cs{f@nch@head} and \cs{f@nch@foot}.} -% +% % \changes{fancyhdr v1.99d}{1998/08/24}{Changed the default % \cs{ps@empty} to \cs{ps@@empty} in order to allow % \texttt{\cs{fancypagestyle}\{empty\}} redefinition.} -% +% % \changes{fancyhdr v2.0}{2000/10/11}{Added LPPL license clause.\\ % A check for \cs{headheight} is added. An errormessage is given (once) if the % header is too large. Empty headers don't generate the error even if % \cs{headheight} is very small or even 0pt. \\ % Warning added for the use of '\texttt{E}' option when twoside option is not used. % In this case the '\texttt{E}' fields will never be used.} -% +% % \changes{fancyhdr v2.1beta}{2002/03/10}{New command: % \texttt{\cs{fancyhfoffset}[place]\{length\}} defines offsets to be applied to % the header/footer to let it stick into the margins (if length $!>$ 0). @@ -2483,9 +3220,9 @@ % area. % \cs{headwidth} will be dynamically calculated in the headers/footers when % this is used.} -% +% % \changes{fancyhdr v2.1beta2}{2002/03/26}{\cs{fancyhfoffset} now also -% takes \texttt{H,F} as possible letters in the argument to +% takes \texttt{H,F} as possible letters in the argument to % allow the header and footer widths to be different.\\ % New commands \cs{fancyheadoffset} and \cs{fancyfootoffset} added comparable to % \cs{fancyhead} and \cs{fancyfoot}.\\ @@ -2502,28 +3239,28 @@ % \changes{fancyhdr v3.1}{2004/10/07}{Added '\texttt{\cs{endlinechar}!=13}' to % \cs{f@nch@reset} to prevent problems with \cs{includegraphics} in % header/footer when \environment{verbatiminput} is active.} -% +% % \changes{fancyhdr v3.2}{2005/03/22}{Reset \cs{everypar} (the real one) % in \cs{f@nch@reset} because spanish.ldf does strange things with % \cs{everypar} between \guillemotleft\ and \guillemotright.} -% +% % \changes{fancyhdr v3.3}{2016/08/20}{Replace -% `\texttt{\cs{@ifundefined}\{chapter\}}' with `\cs{ifx}\cs{chapter}\cs{@undefined}' +% `\texttt{\cs{@ifundefined}\{chapter\}}' with `\cs{ifx}\cs{chapter}\cs{@undefined}' % because the former subtly makes \cs{chapter} equal to \cs{relax}, which may be % undesirable in some cases.} -% +% % \changes{fancyhdr v3.4}{2016/08/21}{Replace \cs{rm} by % \cs{normalfont}\cs{rmfamily} and \cs{sl} by \cs{normalfont}\cs{slshape}.} -% +% % \changes{fancyhdr v3.5}{2016/08/21}{Don't define \cs{footruleskip} if it is already defined.} -% +% % \changes{fancyhdr v3.6}{2016/08/27}{Added a \cs{ProvidesPackage} line.\\ % Updated contact information.} -% +% % \changes{fancyhdr v3.7}{2016/08/28}{Removed \cs{normalfont} from default values, as every field % is already initialised with \cs{normalfont}.\\ % Set \cs{hsize} to \cs{headwidth} in header/footer.} -% +% % \changes{fancyhdr v3.8}{2016/09/06}{Reset \bsbs, \cs{raggedleft}, % \cs{raggedright} and \cs{centering} to their default values to avoid a % clash with the tabu package.\\ @@ -2538,25 +3275,57 @@ % \begin{macro}{\if@nch@mpty} % This macro tests if its argument is empty. % \begin{macrocode} -\def\if@nch@mpty#1{\def\temp@a{#1}\ifx\temp@a\@empty} +\newcommand\if@nch@mpty[1]{\def\temp@a{#1}\ifx\temp@a\@empty} % \end{macrocode} % \end{macro} -% -% \begin{macro}{\f@nch@def} -% This macro defines another macro (usually a header or footer field). -% Depending on the value of \cs{f@nch@gbl} the definition will be -% global or local (the latter case is used in \cs{fancypagestyle}). If -% the value (argument 2) is empty, a \cs{leavevmode} will be substituted. -% If it is not empty, a \cs{strut} will be added. +% +% \begin{macro}{\iff@nch@check} +% Boolean for the \texttt{nocheck} option. +% \changes{fancyhdr v4.0}{2019/03/15}{Implement the \texttt{nocheck} option} +% \OPTindex{nocheck} % \begin{macrocode} -\def\f@nch@def#1#2{\if@nch@mpty{#2}\f@nch@gbl\def#1{\leavevmode}\else - \f@nch@gbl\def#1{#2\strut}\fi} +\newif\iff@nch@check +\f@nch@checktrue +\DeclareOption{nocheck}{% + \f@nch@checkfalse +} % \end{macrocode} % \end{macro} +% +% \begin{macro}{\iff@nch@compatViii} +% Define \cs{iff@nch@compatViii} to track the \texttt{compatV3} option. +% \begin{macrocode} +\newif\iff@nch@compatViii +% \end{macrocode} % \begin{macro}{\f@nch@gbl} -% Initialize \cs{f@nch@gbl} to \cs{global}. +% Initialise \cs{f@nch@gbl} to do nothing (except with the \texttt{compatV3} +% option). +% \changes{fancyhdr v4.0}{2019/03/19}{Remove the \cs{global} in definitions} +% \changes{fancyhdr v4.0}{2019/03/16}{Implement the \texttt{compatV3} option} +% \begin{macrocode} +\let\f@nch@gbl\relax +\DeclareOption{compatV3}{% + \let\f@nch@gbl\global + \f@nch@compatViiitrue +} +% \end{macrocode} +% \end{macro} +% \end{macro} +% +% \begin{macro}{\f@nch@def} +% This macro defines another macro (usually a header or footer field). +% Depending on the value of \cs{f@nch@gbl} the definition will be +% global or local. +% Default it is always local. But with the \texttt{compatV3} option it +% is \cs{global} in the normal definitions, and local in \cs{fancypagestyle}. +% The \cs{global} case is now considered a bug (or at least undesirable). +% +% If the value (argument 2) is empty, a \cs{leavevmode} will be substituted. +% If it is not empty, a \cs{strut} will be added. +% % \begin{macrocode} -\let\f@nch@gbl\global +\newcommand\f@nch@def[2]{\if@nch@mpty{#2}\f@nch@gbl\def#1{\leavevmode}\else + \f@nch@gbl\def#1{#2\strut}\fi} % \end{macrocode} % \end{macro} % @@ -2584,22 +3353,148 @@ % \end{macrocode} % \end{macro} % +% \changes{fancyhdr v4.0}{2019/03/17}{Added \texttt{headings} and +% \texttt{myheadings} options.} +% Standard styles are redefined optionally. These definitions are +% borrowed from the \Package{nccfancyhdr} package by by Alexander I. Rozhenko. +% +% \begin{macro}{\ps@myheadings} +% The redefinition of the \texttt{myheadings} style is conditional. +% We test the existence of the \cs{chapter} command and redefine the +% style accordingly. +% +% \OPTindex{myheadings}\PSindex{myheadings} +% \begin{macrocode} +\DeclareOption{myheadings}{% + \f@nch@ifundefined{chapter}{% +% \end{macrocode} +% An article-like class without chapters: +% \begin{macrocode} + \def\ps@myheadings{\ps@f@nch@fancyproto \let\@mkboth\@gobbletwo + \fancyhf{} + \fancyhead[LE,RO]{\thepage}% + \fancyhead[RE]{\slshape\leftmark}% + \fancyhead[LO]{\slshape\rightmark}% + \let\sectionmark\@gobble + \let\subsectionmark\@gobble + }% + }% +% \end{macrocode} +% A book/report-like class with chapters: +% \begin{macrocode} + {\def\ps@myheadings{\ps@f@nch@fancyproto \let\@mkboth\@gobbletwo + \fancyhf{} + \fancyhead[LE,RO]{\thepage}% + \fancyhead[RE]{\slshape\leftmark}% + \fancyhead[LO]{\slshape\rightmark}% + \let\chaptermark\@gobble + \let\sectionmark\@gobble + }% + }% +} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\ps@headings} +% The redefinition of the \texttt{headings} style also differs for +% book-like and article-like classes. It also differs for +% one-side and two-side modes. +% \begin{macrocode} +\DeclareOption{headings}{% + \f@nch@ifundefined{chapter}{% + \if@twoside +% \end{macrocode} +% An article in two-side mode: +% \begin{macrocode} + \def\ps@headings{\ps@f@nch@fancyproto \let\@mkboth\markboth + \fancyhf{} + \fancyhead[LE,RO]{\thepage}% + \fancyhead[RE]{\slshape\leftmark}% + \fancyhead[LO]{\slshape\rightmark}% + \def\sectionmark##1{% + \markboth{\MakeUppercase{% + \ifnum \c@secnumdepth >\z@ \thesection\quad \fi##1}}{}}% + \def\subsectionmark##1{% + \markright{% + \ifnum \c@secnumdepth >\@ne \thesubsection\quad \fi##1}}% + }% + \else +% \end{macrocode} +% An article in one-side mode: +% \begin{macrocode} + \def\ps@headings{\ps@f@nch@fancyproto \let\@mkboth\markboth + \fancyhf{} + \fancyhead[LE,RO]{\thepage}% + \fancyhead[RE]{\slshape\leftmark}% + \fancyhead[LO]{\slshape\rightmark}% + \def\sectionmark##1{% + \markright {\MakeUppercase{% + \ifnum \c@secnumdepth >\z@ \thesection\quad \fi##1}}}% + \let\subsectionmark\@gobble % Not needed but inserted for safety + }% + \fi + }{\if@twoside +% \end{macrocode} +% A book in two-side mode: +% \begin{macrocode} + \def\ps@headings{\ps@f@nch@fancyproto \let\@mkboth\markboth + \fancyhf{} + \fancyhead[LE,RO]{\thepage}% + \fancyhead[RE]{\slshape\leftmark}% + \fancyhead[LO]{\slshape\rightmark}% + \def\chaptermark##1{% + \markboth{\MakeUppercase{% + \ifnum \c@secnumdepth >\m@ne \if@mainmatter + \@chapapp\ \thechapter. \ \fi\fi##1}}{}}% + \def\sectionmark##1{% + \markright {\MakeUppercase{% + \ifnum \c@secnumdepth >\z@ \thesection. \ \fi##1}}}% + }% + \else +% \end{macrocode} +% A book in one-side mode: +% \begin{macrocode} + \def\ps@headings{\ps@f@nch@fancyproto \let\@mkboth\markboth + \fancyhf{} + \fancyhead[LE,RO]{\thepage}% + \fancyhead[RE]{\slshape\leftmark}% + \fancyhead[LO]{\slshape\rightmark}% + \def\chaptermark##1{% + \markright{\MakeUppercase{% + \ifnum \c@secnumdepth >\m@ne \if@mainmatter + \@chapapp\ \thechapter. \ \fi\fi##1}}}% + \let\sectionmark\@gobble % Not needed but inserted for safety + }% + \fi + }% +} +% \end{macrocode} +% \end{macro} +% +% Process the options. +% \changes{fancyhdr v4.0}{2019/03/15}{Process package options.} +% \SpecialUsageIndex{\ProcessOptions} +% \begin{macrocode} +\ProcessOptions* +% \end{macrocode} +% % \begin{macro}{\f@nch@errmsg} % This macro generates an error message. -% \changes{fancyhdr v3.10}{2019/01/25}{Use \cs{\f@nch@ifundefined} instead of \cs{ifx}.} +% \changes{fancyhdr v3.10}{2019/01/25}{Use \cs{f@nch@ifundefined} instead of \cs{ifx}.} % \changes{fancyhdr v3.10}{2019/01/25}{Use \cs{newcommand} instead of \cs{def}.} % \begin{macrocode} \newcommand\f@nch@errmsg[1]{% - \f@nch@ifundefined{PackageError}{\errmessage{#1}}{\PackageError{Fancyhdr}{#1}{}}} + \f@nch@ifundefined{PackageError}{\errmessage{#1}}{\PackageError{fancyhdr}{#1}{}}} % \end{macrocode} % \end{macro} +% % \begin{macro}{\f@nch@warning} % This macro generates a warning. % \changes{fancyhdr v3.10}{2019/01/25}{Use \cs{f@nch@ifundefined} instead of \cs{ifx}.} % \changes{fancyhdr v3.10}{2019/01/25}{Use \cs{newcommand} instead of \cs{def}.} % \begin{macrocode} \newcommand\f@nch@warning[1]{% - \f@nch@ifundefined{PackageWarning}{\errmessage{#1}}{\PackageWarning{Fancyhdr}{#1}{}}} + \f@nch@ifundefined{PackageWarning}{\errmessage{#1}}{\PackageWarning{fancyhdr}{#1}{}}} % \end{macrocode} % \end{macro} % @@ -2610,10 +3505,10 @@ % This is similar to \LaTeX's \cs{@tfor}, but it expands the \texttt{charstring}. % \begin{macrocode} % \changes{fancyhdr v3.10}{2019/01/25}{Use \cs{newcommand} instead of \cs{def}.} -\newcommand{\f@nch@forc}[3]{\expandafter\f@rc\expandafter#1\expandafter{#2}{#3}} -\newcommand{\f@rc}[3]{\def\temp@ty{#2}\ifx\@empty\temp@ty\else +\newcommand{\f@nch@forc}[3]{\expandafter\f@nchf@rc\expandafter#1\expandafter{#2}{#3}} +\newcommand{\f@nchf@rc}[3]{\def\temp@ty{#2}\ifx\@empty\temp@ty\else \f@nch@rc#1#2\f@nch@rc{#3}\fi} -\def\f@nch@rc#1#2#3\f@nch@rc#4{\def#1{#2}#4\f@rc#1{#3}{#4}} +\def\f@nch@rc#1#2#3\f@nch@rc#4{\def#1{#2}#4\f@nchf@rc#1{#3}{#4}} % \end{macrocode} % \end{macro} % \begin{macro}{\f@nch@for} @@ -2641,7 +3536,7 @@ \ifx\@empty#1\def#1{#2}\fi} % \end{macrocode} % \end{macro} -% +% % \begin{macro}{\f@nch@ifin} % Usage: \cs{f@nch@ifin} \meta{char} \meta{set} \meta{truecase} \meta{falsecase} \\ % If \meta{char} is in \meta{set}, then \meta{truecase} else \meta{falsecase}. @@ -2718,14 +3613,14 @@ e\f@nch@warning {\string#1's `E' option without twoside option is useless}\fi\fi \f@nch@default\f@nch@@lcr{lcr}\temp@c \f@nch@default\f@nch@@hf{hf}{#2\temp@c}% - \f@nch@forc\f@nch@eo\f@nch@@eo - {\f@nch@forc\f@nch@lcr\f@nch@@lcr + \f@nch@forc\f@nch@eo\f@nch@@eo + {\f@nch@forc\f@nch@lcr\f@nch@@lcr {\f@nch@forc\f@nch@hf\f@nch@@hf {\expandafter\f@nch@def\csname f@nch@\f@nch@eo\f@nch@lcr\f@nch@hf\endcsname {#4}}}}}} % \end{macrocode} % \end{macro} -% +% % \begin{macro}{\f@nch@fancyhfoffs} % This macro interprets the parameters for the header and footer % offsets.\\ @@ -2739,7 +3634,7 @@ % The header and footer offsets are stored in command sequences with % names of the form: \cs{f@nch@O@}\meta{x}\meta{y}\meta{z} with \meta{x} from % \texttt{[eo]}, \meta{y} from \texttt{[lr]} and \meta{z} from \texttt{[hf]}. -% +% % \begin{macrocode} \def\f@nch@fancyhfoffs#1#2[#3]#4{% \def\temp@c{}% @@ -2753,7 +3648,7 @@ e\f@nch@warning {\string#1's `E' option without twoside option is useless}\fi\fi \f@nch@default\f@nch@@lcr{lr}\temp@c \f@nch@default\f@nch@@hf{hf}{#2\temp@c}% - \f@nch@forc\f@nch@eo\f@nch@@eo + \f@nch@forc\f@nch@eo\f@nch@@eo {\f@nch@forc\f@nch@lcr\f@nch@@lcr {\f@nch@forc\f@nch@hf\f@nch@@hf {\expandafter\setlength\csname @@ -2821,28 +3716,28 @@ % \begin{macro}{\f@nch@headwidth} % Length parameter to be used for \cs{headwidth}. We use this rather % than defining \cs{headwidth} as a length paramater directly to protect -% ourself to someone saying: \verb+\let\headwidth\textwidth+. +% ourself to someone saying: \verb+\let\headwidth\textwidth+. % \begin{macrocode} \newlength{\f@nch@headwidth} \let\headwidth\f@nch@headwidth % \end{macrocode} % \end{macro} -% \begin{macro}{\f@nch@O@elh} -% \begin{macro}{\f@nch@O@erh} +% \begin{macro}{\f@nch@O@elh} +% \begin{macro}{\f@nch@O@erh} % \begin{macro}{\f@nch@O@olh} -% \begin{macro}{\f@nch@O@orh} -% \begin{macro}{\f@nch@O@elf} +% \begin{macro}{\f@nch@O@orh} +% \begin{macro}{\f@nch@O@elf} % \begin{macro}{\f@nch@O@erf} -% \begin{macro}{\f@nch@O@olf} +% \begin{macro}{\f@nch@O@olf} % \begin{macro}{\f@nch@O@orf} % Length parameters for the offsets. % \begin{macrocode} -\newlength{\f@nch@O@elh} -\newlength{\f@nch@O@erh} +\newlength{\f@nch@O@elh} +\newlength{\f@nch@O@erh} \newlength{\f@nch@O@olh} -\newlength{\f@nch@O@orh} -\newlength{\f@nch@O@elf} +\newlength{\f@nch@O@orh} +\newlength{\f@nch@O@elf} \newlength{\f@nch@O@erf} -\newlength{\f@nch@O@olf} +\newlength{\f@nch@O@olf} \newlength{\f@nch@O@orf} % \end{macrocode} % \end{macro} @@ -2853,16 +3748,25 @@ % \end{macro} % \end{macro} % \end{macro} -% +% % \begin{macro}{\headrulewidth} % \begin{macro}{\footrulewidth} % \begin{macrocode} -\newcommand{\headrulewidth}{0.4pt} +\newcommand{\headrulewidth}{0.4pt} \newcommand{\footrulewidth}{0pt} % \end{macrocode} % \end{macro} % \end{macro} -% +% +% \begin{macro}{\headruleskip} +% Don't define \cs{headruleskip} if it is already defined. +% \changes{fancyhdr v4.0}{2019/03/22}{Parameter \cs{headruleskip}.} +% \begin{macrocode} +\f@nch@ifundefined{headruleskip}% + {\newcommand{\headruleskip}{0pt}}{} +% \end{macrocode} +% \end{macro} +% % \begin{macro}{\footruleskip} % Memoir also defines \cs{footruleskip}. % Don't define \cs{footruleskip} if it is already defined. @@ -2871,7 +3775,7 @@ {\newcommand{\footruleskip}{.3\normalbaselineskip}}{} % \end{macrocode} % \end{macro} -% +% % \begin{macro}{\plainheadrulewidth} % \begin{macro}{\plainfootrulewidth} % Fancyplain stuff shouldn't be used anymore (rather @@ -2884,14 +3788,14 @@ % \end{macrocode} % \end{macro} % \end{macro} -% +% % \begin{macro}{\if@fancyplain} % Boolean for the implementation of \cs{fancyplain} % \begin{macrocode} \newif\if@fancyplain \@fancyplainfalse % \end{macrocode} % \end{macro} -% +% % \begin{macro}{\fancyplain} % Deprecated macro % \begin{macrocode} @@ -2900,7 +3804,7 @@ % \end{macro} % % \begin{macro}{\headwidth} -% Initialize \cs{headwidth} with a magic constant. +% Initialise \cs{headwidth} with a magic constant. % \begin{macrocode} \headwidth=-123456789sp % \end{macrocode} @@ -2915,7 +3819,7 @@ % typesetting the headers and footers. Some packages change these to % incompatible values. % \begin{macrocode} -\let\f@nch@raggedleft\raggedleft +\let\f@nch@raggedleft\raggedleft \let\f@nch@raggedright\raggedright \let\f@nch@centering\centering \let\f@nch@everypar\everypar @@ -2952,22 +3856,122 @@ % \end{macrocode} % \end{macro} % -% Initialization of the head and foot text. +% \begin{macro}{\fancycenter} +% \changes{fancyhdr v4.0}{2019/03/15}{Macro \cs{fancycenter} added} +% \cs{fancycenter}\oarg{dist}\oarg{stretch}\marg{left-mark}\marg{center-mark}\marg{right-mark} +% \begin{macrocode} +\newcommand*{\fancycenter}[1][1em]{% + \@ifnextchar[{\f@nch@center{#1}}{\f@nch@center{#1}[3]}% +} +\def\f@nch@center#1[#2]#3#4#5{% +% \end{macrocode} +% At first, we execute the case when the \meta{center-mark} is empty: +% \begin{macrocode} + \def\@tempa{#4}\ifx\@tempa\@empty + \hbox to\linewidth{\color@begingroup{#3}\hfil {#5}\color@endgroup}% + \else +% \end{macrocode} +% All we need to do is to calculate skips inserted before and after +% \meta{center-mark}. We will calculate them in the |\@tempskipa| +% and |\@tempskipb|. At first: +% \begin{quote} +% \verb|\@tempdima:=|\meta{dist};\\ +% \verb|\@tempdimb:=|\meta{dist}\verb|*|\meta{stretch};\\ +% \verb|\@tempdimc:=|\meta{dist}\verb|*|\meta{stretch}\verb|-|\meta{dist};\\ +% \verb|\@tempskipa:=\@tempskipb:=\@tempdimb + 1fil - \@tempdimc|; +% \end{quote} +% \begin{macrocode} + \setlength\@tempdima{#1}% + \setlength{\@tempdimb}{#2\@tempdima}% + \@tempdimc \@tempdimb \advance\@tempdimc -\@tempdima + \setlength\@tempskipa{\@tempdimb \@plus 1fil \@minus \@tempdimc}% + \@tempskipb\@tempskipa +% \end{macrocode} +% At this point, the \cs{@tempskipa} and \cs{@tempskipb} registers +% have the natural size \meta{dist}\verb|*|\meta{stretch}, +% unlimited stretchability, and the minimum size \meta{dist}. +% Now we decrease the minimum size of \cs{@tempskipa} to zero if +% the \meta{left-mark} is empty: +% \begin{macrocode} + \def\@tempa{#3}\ifx\@tempa\@empty + \addtolength\@tempskipa{\z@ \@minus \@tempdima}% + \fi +% \end{macrocode} +% Do the same things with the \cs{@tempskipb} register if the +% \meta{right-mark} is empty: +% \begin{macrocode} + \def\@tempa{#5}\ifx\@tempa\@empty % empty right + \addtolength\@tempskipb{\z@ \@minus \@tempdima}% + \fi +% \end{macrocode} +% Finally, we correct the left and right glues taking into +% account the difference between lengths of \meta{left-mark} +% and \meta{right-mark}. We calculate which mark is shorter +% and increase the natural size of the corresponding register +% by the difference between their lengths. +% \begin{macrocode} + \settowidth{\@tempdimb}{#3}% + \settowidth{\@tempdimc}{#5}% + \ifdim\@tempdimb>\@tempdimc + \advance\@tempdimb -\@tempdimc + \addtolength\@tempskipb{\@tempdimb \@minus \@tempdimb}% + \else + \advance\@tempdimc -\@tempdimb + \addtolength\@tempskipa{\@tempdimc \@minus \@tempdimc}% + \fi +% \end{macrocode} +% The \cs{@tempskipa} and \cs{@tempskipb} have been calculated. +% Put everything in the box. +% \begin{macrocode} + \hbox to\linewidth{\color@begingroup{#3}\hskip \@tempskipa + {#4}\hskip \@tempskipb {#5}\color@endgroup}% + \fi +} +% \end{macrocode} +% \end{macro} % -% The default values still contain \cs{fancyplain} for compatibility: -% lefthead empty on ``plain'' pages, \cs{rightmark} on even, \cs{leftmark} on odd pages; -% evenhead empty on ``plain'' pages, \cs{leftmark} on even, \cs{rightmark} on odd pages. +% \begin{macro}{\fancyheadinit} +% This macro can be used to define initialisation code that will be run +% before the construction of the header. It can for example set the +% color or the font, or change \cs{headrulewidth} or \cs{headruleskip}. +% It cannot make global changes, just changes for the header. +% \begin{macro}{\f@nch@headinit} +% Storage for the header initialisation code. % \begin{macrocode} -\fancyhf{} -\if@twoside - \fancyhead[el,or]{\fancyplain{}{\slshape\rightmark}} - \fancyhead[er,ol]{\fancyplain{}{\slshape\leftmark}} -\else - \fancyhead[l]{\fancyplain{}{\slshape\rightmark}} - \fancyhead[r]{\fancyplain{}{\slshape\leftmark}} -\fi -\fancyfoot[c]{\rmfamily\thepage} % page number +\newcommand{\f@nch@headinit}{} +\newcommand{\fancyheadinit}[1]{% + \def\f@nch@headinit{#1}% +} % \end{macrocode} +% \end{macro} +% \end{macro} +% +% \begin{macro}{\fancyfootinit} +% This macro can be used to define initialisation code that will be run +% before the construction of the footer. It can for example set the +% color or the font, or change \cs{footrulewidth} or \cs{footruleskip}. +% It cannot make global changes, just changes for the footer. +% \begin{macro}{\f@nch@footinit} +% Storage for the footer initialisation code. +% \begin{macrocode} +\newcommand{\f@nch@footinit}{} +\newcommand{\fancyfootinit}[1]{% + \def\f@nch@footinit{#1}% +} +% \end{macrocode} +% \end{macro} +% \end{macro} +% +% \begin{macro}{\fancyhfinit} +% This macro sets both the header and the footer initialisation codes to +% the same value. +% \begin{macrocode} +\newcommand{\fancyhfinit}[1]{% + \def\f@nch@headinit{#1}% + \def\f@nch@footinit{#1}% +} +% \end{macrocode} +% \end{macro} % % \begin{macro}{\f@nch@vbox} % Make a \cs{vbox} with the header or footer. Check whether there is @@ -2980,26 +3984,46 @@ % % \changes{fancyhdr v3.10}{2019/01/25}{Don't use \cs{global}\cs{setlength}.} % \changes{fancyhdr v3.10}{2019/01/26}{Use \cs{newcommand} instead of \cs{def}.} +% \changes{fancyhdr v4.0}{2019/03/15}{Don't adjust the +% \cs{headheight}/\cs{footskip}, except when the \texttt{compatV3} option is given.} +% \changes{fancyhdr v4.0}{2019/03/15}{Don't check when the \texttt{nocheck} option is given.} % \begin{macrocode} \newcommand\f@nch@vbox[2]{% \setbox0\vbox{#2}% \ifdim\ht0>#1\relax - \f@nch@warning{% - \string#1 is too small (\the#1): ^^J% - Make it at least \the\ht0.^^J% - We now make it that large for the rest of the document.^^J% - This may cause the page layout to be inconsistent, however\@gobble - }% - \dimen0=#1\relax - \global#1=\ht0\relax - \ht0=\dimen0 % + \iff@nch@check + \dimen0=#1\advance\dimen0-\ht0 + \f@nch@warning{% + \string#1 is too small (\the#1): \MessageBreak + Make it at least \the\ht0, for example:\MessageBreak + \string\setlength{\string#1}{\the\ht0}% + \iff@nch@compatViii .\MessageBreak + We now make it that large for the rest of the document.\MessageBreak + This may cause the page layout to be inconsistent, however + \fi + \ifx#1\headheight .\MessageBreak + You might also make \topmargin smaller to compensate:\MessageBreak + \string\addtolength{\string\topmargin}{\the\dimen0}% + \fi + \@gobble + }% + \fi + \iff@nch@compatViii + \dimen0=#1\relax + \global#1=\ht0\relax + \ht0=\dimen0 % + \else + \ht0=#1% + \fi \fi \box0} % \end{macrocode} % \end{macro} % % \begin{macro}{\f@nch@head} -% \begin{macro}{\f@nch@foot} +% \changes{fancyhdr v4.0}{2019/03/22}{Parameter \cs{headruleskip}.} +% \changes{fancyhdr v4.0}{2019/03/25}{\cs{fancyheadinit} initialisation +% code added and \cs{f@nch@reset} moved up.} % Put together a header or footer given the left, center and right % text, fillers at left and right and a rule. The \cs{xlap} commands put % the text into an hbox of zero size, so overlapping text does not @@ -3015,12 +4039,15 @@ % This is the right component. \\ % 5. RIGHTSIDE BEARING. This is always \cs{relax} or \cs{hss} % (after expansion). -% +% Before constructing the header or footer, the environment is reset to +% a known state, and then the corresponding initialisation code as given +% in \cs{fancyheadinit} or \cs{fancyfootinit}, respectively, is run. % \begin{macrocode} \newcommand\f@nch@head[5]{% + \f@nch@reset + \f@nch@headinit\relax #1% \hbox to\headwidth{% - \f@nch@reset \f@nch@vbox\headheight{% \hbox{% \rlap{\parbox[b]{\headwidth}{\raggedright#2}}% @@ -3029,6 +4056,7 @@ \hfill \llap{\parbox[b]{\headwidth}{\raggedleft#4}}% }% + \vskip\headruleskip\relax \headrule }% }% @@ -3036,12 +4064,15 @@ } % \end{macrocode} % +% \begin{macro}{\f@nch@foot} % \changes{fancyhdr v3.10}{2019/01/26}{Put \cs{footrule} in a \cs{vbox} % to accommodate for flexible footrules.} % \changes{fancyhdr v3.10}{2019/01/28}{Use \cs{unvbox} on the footrule \cs{vbox} % to preserve vertical spacing.} % \changes{fancyhdr v3.10}{2019/01/28}{Move \cs{footruleskip} outside of the \cs{footrule} % definition.} +% \changes{fancyhdr v4.0}{2019/03/25}{\cs{fancyfootinit} initialisation +% code added and \cs{f@nch@reset} moved up.} % We put the \cs{footrule} in a \cs{vbox} to accommodate for flexible % footrules (e.g. using \cs{hrulefill}), so that the \cs{headwidth} will % be used as the line width. But to preserve the vertical spacing we @@ -3049,9 +4080,10 @@ % % \begin{macrocode} \newcommand\f@nch@foot[5]{% + \f@nch@reset + \f@nch@footinit\relax #1% \hbox to\headwidth{% - \f@nch@reset \f@nch@vbox\footskip{% \setbox0=\vbox{\footrule}\unvbox0 \vskip\footruleskip @@ -3070,113 +4102,179 @@ % \end{macro} % \end{macro} % -% \begin{macro}{\headrule} -% \begin{macrocode} -\def\headrule{{\if@fancyplain\let\headrulewidth\plainheadrulewidth\fi - \hrule\@height\headrulewidth\@width\headwidth - \vskip-\headrulewidth}} -% \end{macrocode} -% \end{macro} +% \begin{macro}{\MakeUppercase} +% Define \MakeUppercase for old \LaTeX{}en. Note: we used \cs{def} rather +% than \cs{let}, so that \verb+\let\uppercase\relax+ (from the version 1 +% documentation) will still work. % -% \begin{macro}{\footrule} -% \changes{fancyhdr v3.10}{2019/01/28}{Move \cs{footruleskip} outside of the \cs{footrule} -% definition and remove useless \cs{vskip} at the top.} % \begin{macrocode} -\def\footrule{{\if@fancyplain\let\footrulewidth\plainfootrulewidth\fi - \hrule\@width\headwidth\@height\footrulewidth}} +\f@nch@ifundefined{MakeUppercase}{\def\MakeUppercase{\uppercase}}{}% % \end{macrocode} % \end{macro} % -% \begin{macro}{\ps@fancy} -% Pagestyle \texttt{fancy} +% \begin{macro}{\@chapapp} +% Define \cs{@chapapp} for classes that don't have it, e.g. amsbook % \begin{macrocode} -\def\ps@fancy{% - \f@nch@ifundefined{@chapapp}{\let\@chapapp\chaptername}{}% for amsbook +\f@nch@ifundefined{@chapapp}{\let\@chapapp\chaptername}{}% % \end{macrocode} % \end{macro} -% -% \begin{macro}{\MakeUppercase} -% Define \MakeUppercase for old \LaTeX{}en. Note: we used \cs{def} rather -% than \cs{let}, so that \verb+\let\uppercase\relax+ (from the version 1 -% documentation) will still work. -% +% \begin{macro}{\f@nch@initialise} +% \changes{fancyhdr v4.0}{2019/03/21}{Put all the initialisation code in +% \cs{f@nch@initialise}} +% This macro initialises the headers and footers and \cs{chaptermark} +% and/or \cs{[sub]sectionmark} for pagestyle \texttt{fancy} % \begin{macrocode} -\f@nch@ifundefined{MakeUppercase}{\def\MakeUppercase{\uppercase}}{}% +\def\f@nch@initialise{% % \end{macrocode} -% \end{macro} -% +% % \begin{macro}{\chaptermark} % \begin{macro}{\sectionmark} % \begin{macro}{\subsectionmark} % Standard definitions for \cs{chaptermark}, \cs{sectionmark} and \cs{subsectionmark}. -% +% % \begin{macrocode} -\f@nch@ifundefined{chapter}% - {\def\sectionmark##1{\markboth{\MakeUppercase{\ifnum \c@secnumdepth>\z@ - \thesection\hskip 1em\relax - \fi ##1}}{}}% - \def\subsectionmark##1{\markright {\ifnum \c@secnumdepth >\@ne - \thesubsection\hskip 1em\relax \fi ##1}}}% - {\def\chaptermark##1{\markboth {\MakeUppercase{\ifnum - \c@secnumdepth>\m@ne \@chapapp\ \thechapter. \ \fi ##1}}{}}% -\def\sectionmark##1{\markright{\MakeUppercase{\ifnum \c@secnumdepth >\z@ - \thesection. \ \fi ##1}}}% -} + \f@nch@ifundefined{chapter}% + {\def\sectionmark##1{\markboth{\MakeUppercase{\ifnum \c@secnumdepth>\z@ + \thesection\hskip 1em\relax + \fi ##1}}{}}% + \def\subsectionmark##1{\markright {\ifnum \c@secnumdepth >\@ne + \thesubsection\hskip 1em\relax \fi ##1}}}% + {\def\chaptermark##1{\markboth {\MakeUppercase{\ifnum + \c@secnumdepth>\m@ne \@chapapp\ \thechapter. \ \fi ##1}}{}}% + \def\sectionmark##1{\markright{\MakeUppercase{\ifnum \c@secnumdepth >\z@ + \thesection. \ \fi ##1}}}% + }% % \end{macrocode} % \end{macro} % \end{macro} % \end{macro} -% -% \begin{macro}{\ps@fancy} -% Pagestyle \texttt{fancy}. \cs{ps@@fancy} is the real pagestyle -% \texttt{fancy}, i.e. the non-plain one. +% +% \begin{macro}{\headrule} % \begin{macrocode} -\ps@@fancy -\gdef\ps@fancy{\@fancyplainfalse\ps@@fancy}% + \def\headrule{{\if@fancyplain\let\headrulewidth\plainheadrulewidth\fi + \hrule\@height\headrulewidth\@width\headwidth + \vskip-\headrulewidth}}% % \end{macrocode} % \end{macro} -% -% Initialize \cs{headwidth} if the user didn't. If \cs{headwidth} ${}< 0$, -% then the user did not initialize it, or they just added something to +% +% \begin{macro}{\footrule} +% \changes{fancyhdr v3.10}{2019/01/28}{Move \cs{footruleskip} outside of the \cs{footrule} +% definition and remove useless \cs{vskip} at the top.} +% \begin{macrocode} + \def\footrule{{\if@fancyplain\let\footrulewidth\plainfootrulewidth\fi + \hrule\@width\headwidth\@height\footrulewidth}}% +% \end{macrocode} +% \end{macro} +% +% Default values for \cs{headrulewidth}, \cs{footrulewidth}, +% \cs{headruleskip} and \cs{footruleskip}. +% \begin{macrocode} + \def\headrulewidth{0.4pt}% + \def\footrulewidth{0pt}% + \def\headruleskip{0pt}% + \def\footruleskip{0.3\normalbaselineskip}% +% \end{macrocode} +% Initialisation of the head and foot text. +% +% The default values still contain \cs{fancyplain} for compatibility: +% lefthead empty on ``plain'' pages, \cs{rightmark} on even, \cs{leftmark} on odd pages; +% evenhead empty on ``plain'' pages, \cs{leftmark} on even, \cs{rightmark} on odd pages. +% \begin{macrocode} + \fancyhf{}% + \if@twoside + \fancyhead[el,or]{\fancyplain{}{\slshape\rightmark}}% + \fancyhead[er,ol]{\fancyplain{}{\slshape\leftmark}}% + \else + \fancyhead[l]{\fancyplain{}{\slshape\rightmark}}% + \fancyhead[r]{\fancyplain{}{\slshape\leftmark}}% + \fi + \fancyfoot[c]{\rmfamily\thepage}% page number +} +% \end{macrocode} +% Call the initialisation +% \begin{macrocode} +\f@nch@initialise +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\ps@f@nch@fancyproto} +% \cs{ps@f@nch@fancyproto} is the +% initial value for pagestyle \texttt{fancy}. The real page style +% is \cs{ps@f@nch@fancycore} but \cs{ps@f@nch@fancyproto} for the first use +% of \Cmd{pagestyle\{fancy\}} or any of its derivatives. It +% initialises \cs{headwidth}, and then resets itself to +% \cs{ps@f@nch@fancycore}. For backwards compatibility it still +% contains \cs{@fancyplainfalse}. +% The reason we have \cs{ps@f@nch@fancyproto} is so that page style +% \texttt{fancy} can be redefined. +% \changes{fancyhdr v4.0}{2019/03/21}{Reorganise \cs{ps@fancy}} +% \begin{macrocode} +\def\ps@f@nch@fancyproto{% +% \end{macrocode} +% Initialise \cs{headwidth} if the user didn't. If \cs{headwidth} ${}< 0$, +% then the user did not initialise it, or they just added something to % it in the expectation that -% it was initialized to \cs{textwidth}. We compensate this now. This loses if +% it was initialised to \cs{textwidth}. We compensate this now. This loses if % the user intended to multiply it by a factor. But that case is more -% likely done by saying something like \verb+\setlength{\headwidth}{1.2\textwidth}+. -% The documentation says you have to change \cs{headwidth} after the first call to +% likely done by saying something like \verb+\setlength{\headwidth}{1.2\textwidth}+. +% The documentation advises to change \cs{headwidth} after the first call to % \verb+\pagestyle{fancy}+. This code is just to catch the most common cases were -% that requirement is violated. -% +% that is not the case. % \begin{macrocode} -\ifdim\headwidth<0sp + \ifdim\headwidth<0sp \global\advance\headwidth123456789sp\global\advance\headwidth\textwidth -\fi} + \fi +% \end{macrocode} +% Now we reset \cs{ps@f@nch@fancyproto} to \cs{ps@f@nch@fancycore} with \cs{@fancyplainfalse} +% and call that version. +% \begin{macrocode} + \gdef\ps@f@nch@fancyproto{\@fancyplainfalse\ps@f@nch@fancycore}% + \@fancyplainfalse\ps@f@nch@fancycore +}% +% \end{macrocode} +% Let the system know this is a \texttt{fancyhdr} pagestyle. +% \begin{macrocode} +\@namedef{f@nch@ps@f@nch@fancyproto-is-fancyhdr}{} % \end{macrocode} +% \end{macro} +% \begin{macro}{ps@fancy} +% Define \cs{ps@fancy} just to call \cs{ps@f@nch@fancyproto}. +% \begin{macrocode} +\def\ps@fancy{\ps@f@nch@fancyproto} +\@namedef{f@nch@ps@fancy-is-fancyhdr}{} +% \end{macrocode} +% \end{macro} % % \begin{macro}{\ps@fancyplain} % The pagestyle \texttt{fancyplain} (deprecated). -% +% After initializing by calling \cs{ps@f@nch@fancyproto} it sets page style +% \texttt{plain} to our version \cs{ps@plain@fancy}, which just sets +% \cs{@fancyplaintrue} and then calls the page style fancy implementation. +% % \begin{macrocode} -\def\ps@fancyplain{\ps@fancy \let\ps@plain\ps@plain@fancy} -\def\ps@plain@fancy{\@fancyplaintrue\ps@@fancy} +\def\ps@fancyplain{\ps@f@nch@fancyproto \let\ps@plain\ps@plain@fancy} +\def\ps@plain@fancy{\@fancyplaintrue\ps@f@nch@fancycore} % \end{macrocode} % \end{macro} -% -% \begin{macro}{\ps@@empty} +% +% \begin{macro}{\f@nch@ps@empty} % Save the definition of \cs{ps@empty} (pagestyle \texttt{empty}). -% +% \changes{fancyhdr v4.0}{2019/03/21}{Rename \cs{ps@@empty} to \cs{f@nch@ps@empty}} +% % \begin{macrocode} -\let\ps@@empty\ps@empty +\let\f@nch@ps@empty\ps@empty % \end{macrocode} % \end{macro} -% -% \begin{macro}{\ps@@fancy} -% The actual pagestyle \texttt{fancy}. For amsbook/amsart, which do -% strange things with \cs{topskip}, we start with \cs{ps@@empty}. We +% +% \begin{macro}{\ps@f@nch@fancycore} +% \changes{fancyhdr v4.0}{2019/03/21}{Rename \cs{ps@@fancy} to \cs{ps@f@nch@fancycore}} +% The actual implementation of pagestyle \texttt{fancy}. For amsbook/amsart, which do +% strange things with \cs{topskip}, we start with \cs{f@nch@ps@empty}. We % construct the even and odd headers and footers from all the parts that % we have collected. % \begin{macrocode} -\def\ps@@fancy{% - \ps@@empty +\def\ps@f@nch@fancycore{% + \f@nch@ps@empty \def\@mkboth{\protect\markboth}% \def\@oddhead{\f@nch@head\f@nch@Oolh\f@nch@olh\f@nch@och\f@nch@orh\f@nch@Oorh}% \def\@oddfoot{\f@nch@foot\f@nch@Oolf\f@nch@olf\f@nch@ocf\f@nch@orf\f@nch@Oorf}% @@ -3185,7 +4283,22 @@ } % \end{macrocode} % \end{macro} -% +% \begin{macro}{ps@fancydefault} +% \changes{fancyhdr v4.0}{2019/03/21}{Added \cs{ps@fancydefault}} +% This is page style \texttt{fancydefault}. It is in fact page style +% \texttt{fancy} with all the defaults embedded. In contrast with page +% style \texttt{fancy} that gets all its settings from the environment. +% It reruns all initialisations and then calls \cs{ps@f@nch@fancyproto}. +% \begin{macrocode} +\def\ps@fancydefault{% + \f@nch@initialise + \ps@f@nch@fancyproto +} +\@namedef{f@nch@ps@fancydefault-is-fancyhdr}{} +% \end{macrocode} +% +% \end{macro} +% % \begin{macro}{\f@nch@Oolh} % \begin{macro}{\f@nch@Oorh} % \begin{macro}{\f@nch@Oelh} @@ -3201,7 +4314,7 @@ % \begin{macrocode} \def\f@nch@Oolh{\if@reversemargin\hss\else\relax\fi} \def\f@nch@Oorh{\if@reversemargin\relax\else\hss\fi} -\let\f@nch@Oelh\f@nch@Oorh +\let\f@nch@Oelh\f@nch@Oorh \let\f@nch@Oerh\f@nch@Oolh \let\f@nch@Oolf\f@nch@Oolh \let\f@nch@Oorf\f@nch@Oorh @@ -3236,7 +4349,7 @@ % \begin{macro}{\f@nch@offsolh} % \begin{macro}{\f@nch@offselh} % The same for the footer. -% +% % \begin{macrocode} \def\f@nch@offsolf{\headwidth=\textwidth\advance\headwidth\f@nch@O@olf \advance\headwidth\f@nch@O@orf\hskip-\f@nch@O@olf} @@ -3273,7 +4386,7 @@ % We need a boolean \cs{iff@nch@footnote} to capture if there was a footnote. % % \begin{macrocode} -\newif\iff@nch@footnote +\newif\iff@nch@footnote \AtBeginDocument{% \let\latex@makecol\@makecol \def\@makecol{\ifvoid\footins\f@nch@footnotefalse\else\f@nch@footnotetrue\fi @@ -3282,7 +4395,7 @@ % \end{macrocode} % \end{macro} % \end{macro} -% +% % \begin{macro}{\iftopfloat} % \begin{macro}{\ifbotfloat} % \begin{macro}{\iffloatpage} @@ -3301,9 +4414,33 @@ % \end{macro} % % \begin{macro}{\fancypagestyle} +% Define a new page style. The optional second argument is the base page style. +% It defaults to \cs{ps@f@nch@fancyproto}. +% \changes{fancyhdr v4.0}{2019/03/21}{Added optional base style argument.} % \begin{macrocode} -\newcommand{\fancypagestyle}[2]{% - \@namedef{ps@#1}{\let\f@nch@gbl\relax#2\relax\ps@fancy}} +\newcommand{\fancypagestyle}[1]{% + \@ifnextchar[{\f@nch@pagestyle{#1}}{\f@nch@pagestyle{#1}[f@nch@fancyproto]}% +} +% \end{macrocode} +% \end{macro} +% \begin{macro}{\f@nch@pagestyle} +% The actual code for \cs{fancypagestyle}. Build the page style body. +% Declare it as a fancyhdr page style. +% \changes{fancyhdr v4.0}{2019/09/05}{Make the definition of \cs{f@nch@pagestyle} \cs{long}.} +% \begin{macrocode} +\long\def\f@nch@pagestyle#1[#2]#3{% + \f@nch@ifundefined{ps@#2}{% + \f@nch@errmsg{\string\fancypagestyle: Unknown base page style `#2'}% + }{% + \f@nch@ifundefined{f@nch@ps@#2-is-fancyhdr}{% + \f@nch@errmsg{\string\fancypagestyle: Base page style `#2' is not fancyhdr-based}% + }% + {% + \@namedef{ps@#1}{\let\f@nch@gbl\relax\@nameuse{ps@#2}#3\relax}% + \@namedef{f@nch@ps@#1-is-fancyhdr}{}% + }% + }% +}% % \end{macrocode} % \end{macro} %</fancyhdr> @@ -3323,7 +4460,7 @@ % \changes{extramarks v2.1}{2016/08/27}{Added a \cs{ProvidesPackage} line.\\ % Updated contact information.} % \changes{extramarks v3.9}{2016/10/12}{Unify version number with \Package{fancyhdr.sty}.} -% +% % \changes{extramarks v3.9a}{2017/06/30}{Restore \cs{newtoks}\cs{@temptokenb}} % \begin{macro}{\@temptokenb} % A token register to store some marks information @@ -3339,7 +4476,7 @@ \let\protect\@unexpandable@protect \xdef} % \end{macrocode} % \end{macro} -% +% % \begin{macro}{\markboth} % Our own definition of \cs{markboth}, mainly because \cs{@markboth} % gets more parameters. @@ -3357,7 +4494,7 @@ % \begin{macro}{\markright} % We use the standard definition of \cs{markright}. No use to duplicate here. % \end{macro} -% +% % \begin{macro}{\@markboth} % Note: put \texttt{\#3\#4} in toks register. % \begin{macrocode} @@ -3365,7 +4502,7 @@ \unrestored@protected@xdef\@themark{{#5}{#6}\the\@temptokena}} % \end{macrocode} % \end{macro} -% +% % \begin{macro}{\@markright} % Note: put \texttt{\#1} and \texttt{\#3\#4} in toks registers. % Maybe I can get rid of the extra \cs{@temptokenb} by doing the expansion @@ -3381,7 +4518,7 @@ % \begin{macro}{\@rightmark} % Internal macros to get the standard marks. % \begin{macrocode} -\def\@leftmark#1#2#3#4{#1} +\def\@leftmark#1#2#3#4{#1} \def\@rightmark#1#2#3#4{#2} % \end{macrocode} % \end{macro} @@ -3433,7 +4570,7 @@ \if@nobreak\ifvmode\nobreak\fi\fi} % \end{macrocode} % \end{macro} -% +% % \begin{macro}{\@markextra} % Internal macro to store the extra marks in the marks storage.\\ % Note: Put \texttt{\#1\#2} in toks register. @@ -3442,7 +4579,7 @@ \unrestored@protected@xdef\@themark{\the\@temptokena{#5}{#6}}} % \end{macrocode} % \end{macro} -% +% % \begin{macro}{\firstleftxmark} % \begin{macro}{\firstrightxmark} % \begin{macro}{\topleftxmark} @@ -3479,7 +4616,7 @@ % \end{macro} % \end{macro} % \end{macro} -% +% % \begin{macro}{\@tleftxmark} % \begin{macro}{\@rightxmark} % Internal macros to extract the extra marks out of the marks storage. @@ -3489,7 +4626,7 @@ % \end{macrocode} % \end{macro} % \end{macro} -% +% %</extramarks> % % \section{fancyheadings.sty} @@ -3521,7 +4658,7 @@ \MessageBreak fancyhdr is 99 percent compatible with\MessageBreak fancyheadings. The only incompatibility is\MessageBreak - that \protect\headrulewidth\space and \protect\footrulewidth\space + that \protect\headrulewidth\space and \protect\footrulewidth\space and\MessageBreak their \protect\plain... versions are no longer length\MessageBreak parameters, but normal macros (to be changed\MessageBreak diff --git a/Master/texmf-dist/source/latex/fancyhdr/fancyhdr.ins b/Master/texmf-dist/source/latex/fancyhdr/fancyhdr.ins index e3f68035daa..c6013955926 100644 --- a/Master/texmf-dist/source/latex/fancyhdr/fancyhdr.ins +++ b/Master/texmf-dist/source/latex/fancyhdr/fancyhdr.ins @@ -1,5 +1,5 @@ %% -%% Copyright (C) 2016 by Piet van Oostrum <piet@vanoostrum.org> +%% Copyright (C) 2016-2019 by Pieter van Oostrum <pieter@vanoostrum.org> %% %% This file may be distributed and/or modified under the conditions of %% the LaTeX Project Public License, either version 1.3 of this license |