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