summaryrefslogtreecommitdiff
path: root/macros/text1/cms_help_files/shbf.helpmark
blob: 7c0e27505b7a8dbc8b4b4a2dd8ca6ad09d9ed4d8 (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
+-----------------------------------------------------------------------------+
|                               subheadbformat                                |
+-----------------------------------------------------------------------------+
 
\subheadbformat{\numberingstyle{1}
  \titleformat{\removelastskip
               \goodbreak\vs{2\bl}
               \twelvept
               \it\nin\subheadbtitle
               \par\nobreak
               \vs{1\bl}\nobreak
               \setsubheadcnumber{0}
               \setsubheaddnumber{0}}
    \incontents{yes}
   }
 
Abbreviation:  ã|\shbfã%
 
Parameters:    ã|submarkupã%
 
Submarkup:     ã|\numberingstyle, \titleformat, \incontentsã%
 
    ã|Description:ã%
The \subheadbformat markup lets  you change the appearance of the subheading
title.   There  are three  submarkup that  control how  the \subheadb  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 \subheadbnumber 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
\subheadbformat:
 
  * \subheadbnumberprints the most recent subheadb number.
 
  * \subheadbtitleprints the most recent subheadb title.
 
ã|\incontentsã% places the subheadb title by default in the contents (if one is
printed).   Printing in the table of contents  can be suppressed by changing
to "no":
 
\shbf{\incontents{no}}
 
    ã|Example:ã%
Some  applications require  the subheads  to  be numbered.    If  you wanted
\subheadb to  include a  number like  "pp.cc.aa.bb" where  "pp" is  the part
number, "cc" is the chapter number, "aa" is the subheada number, and "bb" is
the subheadb number, you would modify the \subheadbformat:
 
  \subheadbformat{\numberingstyle{1}
    \titleformat{\removelastskip\goodbreak\vs{2\bl}
     \italic
     \partnumber.\chapternumber.\subheadanumber.\subheadbnumber
         \quad\subheadbtitle\par
         \nobreak\vs{1\bl}\nobreak}
    \incontents{yes}
  }
 
  more realistic.
  \subheadb{Nationalism and War}
  Nationalism is directly related to war.
 
  Lord Acton observed that . . .
 
The first subheadb in the second  subheada of the third chapter of the first
part would print as:
+-----------------------------------------------------------------------------+
|                                                                             |
| more realistic.                                                             |
|                                                                             |
|                                                                             |
| 1.3.2.1 Nationalism and War                                                 |
|                                                                             |
|     Nationalism is  directly related  to war.    Lord Acton  observed that  |
| . . .                                                                       |
|                                                                             |
+-----------------------------------------------------------------------------+
 
    ã|Notes:ã%
The \subheadbformat  markup must come  after the \monospace  markup, if both
are used.