The appendix package - ibiblio

1 Theappendixpackage Author: Peter Wilson, Herries PressMaintainer: Will Robertsonwill dot robertson at latex-project dot org2020/02/08 AbstractTheappendixpackage provides some facilities for modifying the typeset-ting of appendix titles. Further,(sub)appendicesenvironments are avail-able that can be used, for example, for per chapter/section package is designed to work only with classes that have a\chapterand/or\sectioncommand. It has not been tested with other packages thatchange the definitions of the sectioning Introduction12 Known problems ..43 The package code51 IntroductionIn the standard classes the\appendixcommand does the following: For classes with Chapters: Resets the chapter and section counters to zero Redefines\thechapterto produce alphabetic appendix numbers.

2 For the other classes Resets the section and subsection counters to zero. This file ( ) has version number , last revised 2020/02 Redefines\thesectionto produce alphabetic appendix provides additional appendixing capabilities. It cooper-ates with thehyperrefpackage1but may be problematic when used with packagesthat change the definition of the sectioning of the package were developed as part of a class and package bundlefor typesetting ISO standards [Wil96]. This manual is typeset according to theconventions of the LATEX docstriputility which enables the automatic extractionof the LATEX macro source files [GMS94].Section 2 describes the usage of the package . Commented source code for thepackage is in Section TheappendixpackageTheappendixpackage provides some commands that can be used in addition tothe\appendixcommand.

3 It also provides a new environment that can be usedinstead of the\appendixcommand. The environment provides some additionalactions with respect to the simple\ appendix . First the new commands will bedescribed and then the new environment will be \appendixpagecommand will typeset a heading in the style of a\part\appendixpageheading for the class. The wording of the heading is given by the value of\ command will insert general heading into the Table of Contents (ToC).\addappheadtotocThe text is given by the value of\appendixtocname. If used, the command mustcome before the first appendix , as it is meant to be used to introduce the appendixtitles in the above commands can be used in conjunction with the traditional\appendixcommand, which they should immediately follow.

4 For example:\ appendix \appendixpage\addapphea dtotocBy default the\addappheadtotoccommand puts a page number in the ToC.\noappendicestocpagenum\appendicesto cpagenumThis can be prevented by using\noappendicestocpagenum. For symmetry, the\appendicestocpagenumcommand ensures that a page number is put in the :Unless\noappendicestocpagenumis used the\addappheadtotoccommand uses the current page number when it makes the entry in the ToC. The\appendixpagecommand puts a heading in the document like a\partheading;in un-chaptered documents the\partheading appears in the ordinary run of thetext like a\sectionheading, but in chaptered documents it is on a page by is, in chaptered documents\appendixpagedoes a\clear[double]pagetypesets the heading, and then does another\clear[double]page.

5 Therefore, in1 With thanks to Hylke W. van Dijk who pointed out that ver-sion did not and set me on the track for supporting chaptered document the above sequence of commands will use the page numberafterthe\appendixpageas the ToC entry2and if the ordering is reversed ( ,\addappheadtotoc \appendixname) then the page numberbefore\appendixnamewill be used as the ToC entry. For chaptered documents it is probably best to do:\clearpage % or \cleardoublepage\addappheadtotoc\appendi xpagewhich will use the page number of\appendixpageas the ToC \appendixnamecommand is defined in those classes that provide for chap-\appendixname\appendixtocname\appen dixpagenameters. It is provided in this package whether or not it has been defined in the s default value is appendix .

6 The default value of both\appendixtocnameand\appendixpagename is Appendices . These names can all be changed via\renewcommand. For example,\renewcommand{\appendixtocname}{ List of appendices}Theappendicesenvironment can be used instead of the\appendixcom-appendicesmand. It provides more functionality than is possible from the combination of the\ appendix ,\addappheadtotocand\appendi xpagecommands. The functions oftheappendicesenvironment are usually accessed through the package options,but there are declarations that may be used instead. The options are: tocPut a header ( , Appendices ) into the Table of Contents (the ToC)before listing the appendices. (This is done by calling the\addappheadtotoccommand.)

7 PagePuts a title ( , Appendices ) into the document at the pointwhere theappendicesenvironment is begun. (This is done by calling the\appendixpagecommand.) titleAdds a name ( , appendix ) before each appendix title in the bodyof the document. The name is given by the value of\appendixname. Notethat this is the default behaviour for classes that have chapters. titletocAdds a name ( , appendix ) before each appendix listed in theToC. The name is given by the value of\appendixname. headerAdds a name ( , appendix ) before each appendix in page name is given by the value of\appendixname. Note that this is thedefault behaviour for classes that have on the particular package options that are set and the documentclass, theappendicesenvironment may change the definition of elements of thesectioning commands ( ,\chapteror\section).

8 This may be a problem if theenvironment is used in conjunction with any other package that makes changes tothese commands. If this is the case, then you will have to examine the code for2 With thanks to Eduardo Jacob for pointing this and make any necessary changes to one or the otherof the packages (via your own package file). The changes to the sectional headingcommands are discarded at the end of theappendicesenvironment.\appendixtoconi s a declaration equivalent to thetocoption. The\appendixtocoff\appendixtocon\appendi xtocoffdeclaration is equivalent to not using that option.\appendixpageconis a declaration equivalent to \appendixpageon\appendixpageoff\ appendix pageoffdeclaration is equivalent to not using that option.

9 \appendixtitleonis a declaration equivalent to \appendixtitleon\appendixtitleoff\append ixtitleoffdeclaration is equivalent to not using that option.\appendixtitletoconis a declaration equivalent to thetitletocoption. The\appendixtitletocon\appendixtitletoco ff\appendixtitletocoffdeclaration is equivalent to not using that option.\appendixheaderonis a declaration equivalent to theheaderoption. The\appendixheaderon\appendixheaderoff\a ppendixheaderoffdeclaration is equivalent to not using that restores the prior value of the chapter/section\restoreappcounter at the end of the environment, so the environment may be used betweenthe main document divisions. By default, the appendix counter value is savedand restored by the environment.

10 That means that appendices in a series ofappendicesenvironments will be lettered sequentially. To make the letteringstart from A each time, put the following into the preamble:\renewcommand{\restoreapp}{}Wit hin thesubappendicesenvironment, an appendix is introduced by asubappendices\sectioncommand in chaptered documents, otherwise it is introduced by a\subsectioncommand. Effectively, this provides for appendices at the end of amain document division, as an integral part of the division. Thesubappendicesenvironment supports only default, the subappendices are numbered like normal (sub)sections, ex-\setthesection\setthesubsectioncept that the (sub)section number itself is typeset as an uppercase letter.