summaryrefslogtreecommitdiff
path: root/macros/text1/cms_help_files/chf.helpmark
diff options
context:
space:
mode:
Diffstat (limited to 'macros/text1/cms_help_files/chf.helpmark')
-rw-r--r--macros/text1/cms_help_files/chf.helpmark98
1 files changed, 98 insertions, 0 deletions
diff --git a/macros/text1/cms_help_files/chf.helpmark b/macros/text1/cms_help_files/chf.helpmark
new file mode 100644
index 0000000000..c20cd7f815
--- /dev/null
+++ b/macros/text1/cms_help_files/chf.helpmark
@@ -0,0 +1,98 @@
++-----------------------------------------------------------------------------+
+| chapterformat |
++-----------------------------------------------------------------------------+
+
+\chapterformat{\numberingstyle{1}
+ \titleformat{\dumpinsertseject
+ \cl{\twelvept\bd Chapter \chapternumber}
+ \cl{\twelvept\bd \chaptertitle}
+ \vs{1\bl}
+ \setsubheadanumber{0}
+ \setsubheadbnumber{0}
+ \setsubheadcnumber{0}
+ \setsubheaddnumber{0}}
+ \incontents{yes}}
+
+Abbreviation: ã|\chfã%
+
+Parameters: ã|submarkupã%
+
+Submarkup: ã|\numberingstyle, \titleformat, \incontentsã%
+
+ ã|Description:ã%
+The \chapterformat markup allows you to modify the defaults that controls
+the appearance of the chapter title. The submarkup is described.
+
+\numberingstyle allows you to change the style from Arabic numerals, the
+default, to letters {A} or roman numerals {I}.
+
+\chapterformat{\numberingstyle{A}}
+
+\titleformat{Nested Markup} controls the appearance of the chapter title
+banner. You may use markup such as \newpage, \verticalspace, and \center-
+line within \titleformat as Nested Markup. Other markup you may use within
+or outside of \chapterformat:
+
+ * \chapternumberprints the most recent chapter number.
+
+ * \chaptertitleprints the most recent chapter title.
+
+\incontents places the chapter title in contents (if one is printed).
+Printing can be suppressed by changing to "no."
+
+\chapterformat{\incontents{no}}
+
+ ã|Example:ã%
+When you enter,
+
+\chapter{Introduction}
+
+you get the default chapter style which looks like:
+
++-----------------------------------------------------------------------------+
+| |
+| Chapter 1 |
+| Introduction |
+| |
++-----------------------------------------------------------------------------+
+
+ ã|Example:ã%
+In the following example this default style has been modified such that each
+chapter starts on a new page, the title is centered in bold (no chapter
+number printed), and one line is skipped after the chapter title.
+
+\chapterformat{\numberingstyle{1}
+
+ \titleformat{\newpage
+ \cl{\bd \chaptertitle}
+ \vs{1\bl}}
+ \incontents{yes}}
+
+Then each time you specify \chapter you will get:
+
++-----------------------------------------------------------------------------+
+| |
+| Introduction |
+| |
++-----------------------------------------------------------------------------+
+
+ ã|Example:ã%
+In this sample, each chapter title is prefaced by the chapter number. As
+before, the title is centered in bold, and one line is skipped before text.
+
+\chapterformat{\numberingstyle{1}
+ \titleformat{\newpage
+ \cl{\bd\chapternumber.~\chaptertitle}
+
+ \vs{1\bl}}
+ \incontents{yes}}
+
++-----------------------------------------------------------------------------+
+| |
+| 1. Introduction |
+| |
++-----------------------------------------------------------------------------+
+
+ ã|Notes:ã%
+The \chapterformat markup must come after the \monospace markup, if both are
+used.