summaryrefslogtreecommitdiff
path: root/macros/text1/cms_help_files/shcf.helpmark
blob: bb7cbe082295c37e54b89b2f87c5387cd2f1681c (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
+-----------------------------------------------------------------------------+
|                               subheadcformat                                |
+-----------------------------------------------------------------------------+
 
\subheadcformat{\numberingstyle{1}
  \titleformat{\removelastskip
               \goodbreak\vs{2\bl}
               \twelvept
               \rm\nin\subheadctitle
               \par\nobreak
               \vs{1\bl}\nobreak
               \setsubheaddnumber{0}}
    \incontents{no}
   }
 
Abbreviation:  ã|\shcfã%
 
Parameters:    ã|submarkupã%
 
Submarkup:     ã|\numberingstyle, \titleformat, \incontentsã%
 
    ã|Description:ã%
The \subheadcformat markup lets  you change the appearance of the subheading
title.   There  are three  submarkup that  control how  the \subheadc  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 \subheadcnumber is incremented.
 
ã|\titleformat{Nested Markup}ã%  is  used to  describe how the  \subheadc 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
\subheadcformat:
 
  * \subheadcnumberprints the most recent subheadc number.
 
  * \subheadctitleprints the most recent subheadc title.
 
ã|\incontentsã% places the subheadc  title in the contents (if one is printed).
By default, the title is not  placed in the contents.  Printing in the table
of contents can be included by changing to "yes":
 
\shcf{\incontents{yes}}
 
    ã|Example:ã%
Some  applications require  the subheads  to  be numbered.    If  you wanted
\subheadc to  include a  number like  "Section cc:"   where  "cc" is  a bold
subheadc number, you could modify the \subheadcformat:
 
\subheadcformat{\numberingstyle{1}
  \titleformat{\removelastskip\goodbreak\vs{2\bl}
       \nin\bd Section \subheadcnumber:
       \quad\subheadctitle\par
       \nobreak\vs{1\bl}\nobreak}
  \incontents{no}
}
 
more realistic.
\subheadc{Nationalism and War}
Nationalism is directly related to war.
Lord Acton observed that . . .
 
The third subheadc would print as:
 
+-----------------------------------------------------------------------------+
|                                                                             |
| more realistic.                                                             |
|                                                                             |
|                                                                             |
| Section 3:  Nationalism and War                                             |
|                                                                             |
|     Nationalism is  directly related  to war.    Lord Acton  observed that  |
| . . .                                                                       |
|                                                                             |
+-----------------------------------------------------------------------------+
 
    ã|Notes:ã%
The \subheadcformat  markup must come  after the \monospace  markup, if both
are used.