summaryrefslogtreecommitdiff
path: root/macros/text1/cms_help_files/shaf.helpmark
blob: 3cf2d51cd946cda3cfe134440d9cb7aeccee2735 (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
+-----------------------------------------------------------------------------+
|                               subheadaformat                                |
+-----------------------------------------------------------------------------+
 
\subheadaformat{\numberingstyle{1}
  \titleformat{\removelastskip
               \goodbreak\vs{2\bl}
               \twelvept
               \bd\nin\subheadatitle
               \par\nobreak
               \vs{1\bl}\nobreak
               \setsubheadbnumber{0}
               \setsubheadcnumber{0}
               \setsubheaddnumber{0}}
    \incontents{yes}
   }
 
Abbreviation:  ã|\shafã%
 
Parameters:    ã|submarkupã%
 
Submarkup:     ã|\numberingstyle, \titleformat, \incontentsã%
 
    ã|Description:ã%
The \subheadaformat markup lets  you change the appearance of the subheading
title.   There  are three  submarkup that  control how  the \subheada  is to
appear.
 
ã|\numberingstyleã%  by default  is 1  which will  print the subhead  number in
Arabic numbers.   Other possibilities  are "A" and "I".  By default, subhead
numbers are not printed, even though the \subheadanumber is incremented.
 
ã|\titleformat{Nested Markup}ã%  is used to  describe how the  subhead title is
to  be printed.    You  may use  markup such  as  \newpage, \removelastskip,
\goodbreak,  \nobreak, \verticalspace,  and \centerline  within \titleformat
as  Nested  Markup.     Other  markup  you  may  use within  or  outside  of
\subheadaformat:
 
  * \subheadanumberprints the most recent subheada number.
 
  * \subheadatitleprints the most recent subheada title.
 
ã|\incontentsã% places the subheada title by default in the contents (if one is
printed).   Printing in the table of contents  can be suppressed by changing
to "no":
 
\shaf{\incontents{no}}
 
    ã|Example:ã%
Some applications  require the subheads  to be numbered.    For \subheada to
include a  number like  "pp.cc-aa" where  "pp" is the  part number,  "cc" is
the chapter  number, and "aa" is  the subheada number, you  would modify the
\subheadaformat:
 
\subheadaformat{\numberingstyle{1}
  \titleformat{\removelastskip\goodbreak\vs{2\bl}
       \bd\partnumber.\chapternumber-\subheadanumber
       \quad\subheadatitle\par
       \nobreak\vs{1\bl}\nobreak}
  \incontents{yes}
}
 
more realistic.
\par
\subheada{Nationalism and War}
Nationalism is directly related to war.
Lord Acton observed that . . .
 
The second subheada in the third chapter of the first part would print as:
 
+-----------------------------------------------------------------------------+
|                                                                             |
| more realistic.                                                             |
|                                                                             |
|                                                                             |
| 1.3-2 Nationalism and War                                                   |
|                                                                             |
|     Nationalism is  directly related  to war.    Lord Acton  observed that  |
| . . .                                                                       |
|                                                                             |
+-----------------------------------------------------------------------------+
 
    ã|Notes:ã%
The \subheadaformat  markup must come  after the \monospace  markup, if both
are used.