summaryrefslogtreecommitdiff
path: root/macros/text1/cms_help_files/shdf.helpmark
blob: 39b552a43044adb4f7f698c136c9d8c5ea03a6dd (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
+-----------------------------------------------------------------------------+
|                               subheaddformat                                |
+-----------------------------------------------------------------------------+
 
\subheaddformat{\numberingstyle{1}
  \titleformat{\goodbreak
             {\twelvept
               \it\subheaddtitle.}
    \incontents{no}
   }
 
Abbreviation:  ã|\shdfã%
 
Parameters:    ã|submarkupã%
 
Submarkup:     ã|\numberingstyle, \titleformat, \incontentsã%
 
    ã|Description:ã%
The \subheaddformat markup lets  you change the appearance of the subheading
title.   There  are three  submarkup that  control how  the \subheadd  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 \subheaddnumber 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
\subheaddformat:
 
  * \subheaddnumberprints the most recent subheadd number.
 
  * \subheaddtitleprints the most recent subheadd title.
 
ã|\incontentsã% places the subheadd  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":
 
\shdf{\incontents{yes}}
 
    ã|Example:ã%
If you wanted a subhead to  place the title in a lable, you would modify the
\subheaddformat:
 
\subheaddformat{\numberingstyle{1}
  \titleformat{\removelastskip\goodbreak\vs{2\bl}
       \label{\subheaddtitle}
       }
  \incontents{no}
}
 
more realistic.
\subheadd{Nationalism and War}
Nationalism is directly related to war.
Lord Acton observed that the increase in nationalism
significantly increases a country's ability to
protect itself . . .
 
The fourth subheadd would print as:
 
+-----------------------------------------------------------------------------+
|                                                                             |
| more realistic.                                                             |
|                                                                             |
|                                                                             |
|                                                                             |
| Nationalism                                                                 |
| and War    thatonthesmincreaseeinlynationalism  significantlyctincreasesea  |
|            country's ability to protect itself . . .                        |
|                                                                             |
+-----------------------------------------------------------------------------+
 
    ã|Notes:ã%
The \subheaddformat  markup must come  after the \monospace  markup, if both
are used.