summaryrefslogtreecommitdiff
path: root/macros/text1/cms_help_files/appendix.helpmenu
blob: 4e5ea240dbc4e7ac971f77db95151dfc05851909 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
+-----------------------------------------------------------------------------+
|                               appendixformat                                |
+-----------------------------------------------------------------------------+
 
\appendixformatÅ\numberingstyleÅAÌ
  \titleformatÅ\dumpinsertseject
        \centerlineÅ\twelvept\bold
                         Appendix \appendixnumberÌ
        \centerlineÅ\twelvept\bold\appendixtitleÌ
        \vsÅ 1\blÌ
        \setchapternumberÅ 0Ì
        \setsubheadanumberÅ 0Ì
        \setsubheadbnumberÅ 0Ì
        \setsubheadcnumberÅ 0Ì
        \setsubheaddnumberÅ 0Ì
        \setfigurenumberÅ 0Ì
        \settablenumberÅ 0Ì
        Ì
  \incontentsÅ yesÌ
Ì
 
Abbreviation:  ã|\apfã%
 
Parameters:    ã|submarkupã%
 
Submarkup:     ã|\numberingstyle, \titleformat, \incontentsã%
 
    ã|Description:ã%
The  \appendixformat markup  allows you  to modify  the default  markup that
controls the appearance of the appendix title.  The submarkup is described.
 
\numberingstyle   allows you to change  the style from  capital letters, the
default, to Arabic numerals (1) or roman numerals (I).
 
    ã|Example:ã%
 
\appendixformatÅ \numberingstyleÅ IÌÌ
\appendixÅ GlossaryÌ
 
If this were the fourth appendix, it would print as:
+-----------------------------------------------------------------------------+
|                                                                             |
|                                 Appendix IV                                 |
|                                  Glossary                                   |
|                                                                             |
+-----------------------------------------------------------------------------+
 
\titleformatÅNested MarkupÌ   controls the appearance  of the appendix title
banner.   You may use markup such as  \newpage, \verticalspace, and \center-
line within \titleformat as Nested Markup.   Other markup you may use within
or outside of \appendixformat:
 
  * \appendixnumberprints the most recent appendix number.
 
  * \appendixtitleprints the most recent appendix title.
 
\incontents  determines whether the  appendix title is to be included in the
contents.   The default can be  changed to no to  inhibit the appendix title
from being included in the contents.  See the second example below.
 
    ã|Example:ã%
In this example,  the appendix starts  a new page, the  number and title are
centered in bold, and one line is skipped afterwards.
 
\appendixformatÅ \numberingstyleÅ 1Ì
    \titleformatÅ \dumpinsertseject
      \clÅ \bd \appendixnumber. \appendixtitleÌ
      \vsÅ 1\blÌ
               Ì
    \incontentsÅ yesÌ
            Ì
\appÅ GlossaryÌ
 
This would print the fourth appendix as:
+-----------------------------------------------------------------------------+
|                                                                             |
|                                4.  Glossary                                 |
|                                                                             |
+-----------------------------------------------------------------------------+
 
    ã|Example:ã%
In  this  example,  the  appendix  starts  a  new  page  (instead  of  using
\dumpinsertseject,  skips  down the  page  2 inches,  centers  the  title in
italics, and skips one line.  The title is not put in contents.
 
\appendixformatÅ
    \titleformatÅ \newpage
      \vskÅ 2inÌ
      \clÅ \it \appendixtitleÌ
      \vsÅ 1\blÌÌ
    \incontentsÅ noÌ Ì
\appÅ GlossaryÌ
 
This would print the fourth appendix as:
 
+-----------------------------------------------------------------------------+
|                                                                             |
|                                  Glossary                                   |
+-----------------------------------------------------------------------------+
 
    ã|Notes:ã%
The \appendixformat  markup must come  after the \monospace  markup, if both
are used.