summaryrefslogtreecommitdiff
path: root/macros/text1/cms_help_files/prf.helpmark
diff options
context:
space:
mode:
Diffstat (limited to 'macros/text1/cms_help_files/prf.helpmark')
-rw-r--r--macros/text1/cms_help_files/prf.helpmark42
1 files changed, 42 insertions, 0 deletions
diff --git a/macros/text1/cms_help_files/prf.helpmark b/macros/text1/cms_help_files/prf.helpmark
new file mode 100644
index 0000000000..c0f4cde759
--- /dev/null
+++ b/macros/text1/cms_help_files/prf.helpmark
@@ -0,0 +1,42 @@
++-----------------------------------------------------------------------------+
+| prefaceformat |
++-----------------------------------------------------------------------------+
+
+\prefaceformat{\titleformat{\dumpinsertseject
+ \cl{\twelvept\bd \prefacetitle}
+ \vs{1\bl}}
+ \incontents{yes}
+ }
+
+Abbreviation: ã|\prfã%
+
+Parameters: ã|submarkupã%
+
+Submarkup: ã|\titleformat, \incontentsã%
+
+ ã|Description:ã%
+The \prefaceformat markup allows you to modify the defaults that control the
+appearance of the preface title. There are two submarkup:
+
+ã|titleformatã% controls the appearance of the part title banner. You
+may use markup such as \newpage, \verticalspace, and \centerline within
+\titleformat as Nested Markup. You may also use:
+ ã|prefacetitle.ã% prints the most recent preface title.
+
+ã|incontentsã% places the preface title in contents (if one is printed).
+Printing can be suppressed by changing to "no."
+
+ ã|Example:ã%
+In this example, the preface starts a new page, the title is centered in
+bold, and one line is skipped afterwards. No preface is put in contents.
+
+\prefaceformat{\titleformat{\newpage
+ \cl{\bd \prefacetitle}
+ \vs{1\bl}
+ }
+ \incontents{no}
+ }
+
+ ã|Notes:ã%
+The \prefaceformat markup must come after the \monospace markup, if both are
+used.