summaryrefslogtreecommitdiff
path: root/macros/text1/cms_help_files/shdf.helpmark
diff options
context:
space:
mode:
Diffstat (limited to 'macros/text1/cms_help_files/shdf.helpmark')
-rw-r--r--macros/text1/cms_help_files/shdf.helpmark77
1 files changed, 77 insertions, 0 deletions
diff --git a/macros/text1/cms_help_files/shdf.helpmark b/macros/text1/cms_help_files/shdf.helpmark
new file mode 100644
index 0000000000..39b552a430
--- /dev/null
+++ b/macros/text1/cms_help_files/shdf.helpmark
@@ -0,0 +1,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.