diff options
Diffstat (limited to 'macros/text1/cms_help_files/apf.helpmark')
-rw-r--r-- | macros/text1/cms_help_files/apf.helpmark | 93 |
1 files changed, 93 insertions, 0 deletions
diff --git a/macros/text1/cms_help_files/apf.helpmark b/macros/text1/cms_help_files/apf.helpmark new file mode 100644 index 0000000000..cad86ce1cc --- /dev/null +++ b/macros/text1/cms_help_files/apf.helpmark @@ -0,0 +1,93 @@ ++-----------------------------------------------------------------------------+ +| appendixformat | ++-----------------------------------------------------------------------------+ + +Abbreviation: ã|\apfã% + +Parameters: ã|submarkupã% + +Submarkup: ã|\numberingstyle, \titleformat, \incontentsã% + + ã|Description:ã% +The \appendixformat markup allows you to modify the default markup that +controls the appearance of the appendix title. The submarkup is described. + +\numberingstyle allows you to change the style from capital letters, the +default, to Arabic numerals (1) or roman numerals (I). + + ã|Example:ã% + +\appendixformat{\numberingstyle{I}} + +\appendix{Glossary} + +If this were the fourth appendix, it would print as: + ++-----------------------------------------------------------------------------+ +| | +| Appendix IV | +| Glossary | +| | ++-----------------------------------------------------------------------------+ + +\titleformat{Nested Markup} controls the appearance of the appendix 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 \appendixformat: + + * \appendixnumberprints the most recent appendix number. + + * \appendixtitleprints the most recent appendix title. + +\incontents determines whether the appendix title is to be included in the +contents. The default can be changed to no to inhibit the appendix title +from being included in the contents. See the second example below. + + ã|Example:ã% +In this example, the appendix starts a new page, the number and title are +centered in bold, and one line is skipped afterwards. + +\appendixformat{\numberingstyle{1} + \titleformat{\dumpinsertseject + + \cl{\bd \appendixnumber. \appendixtitle} + \vs{1\bl} + } + \incontents{yes} + } + +\app{Glossary} + +This would print the fourth appendix as: + ++-----------------------------------------------------------------------------+ +| | +| 4. Glossary | +| | ++-----------------------------------------------------------------------------+ + + ã|Example:ã% +In this example, the appendix starts a new page (instead of using +\dumpinsertseject, skips down the page 2 inches, centers the title in +italics, and skips one line. The title is not put in contents. + +\appendixformat{ + \titleformat{\newpage + \vsk{2in} + \cl{\it \appendixtitle} + \vs{1\bl}} + \incontents{no} } + +\app{Glossary} + +This would print the fourth appendix as: + ++-----------------------------------------------------------------------------+ +| | +| Glossary | +| | ++-----------------------------------------------------------------------------+ + + ã|Notes:ã% +The \appendixformat markup must come after the \monospace markup, if both +are used. |