diff options
Diffstat (limited to 'macros/text1/cms_help_files/shcf.helpmark')
-rw-r--r-- | macros/text1/cms_help_files/shcf.helpmark | 81 |
1 files changed, 81 insertions, 0 deletions
diff --git a/macros/text1/cms_help_files/shcf.helpmark b/macros/text1/cms_help_files/shcf.helpmark new file mode 100644 index 0000000000..bb7cbe0822 --- /dev/null +++ b/macros/text1/cms_help_files/shcf.helpmark @@ -0,0 +1,81 @@ ++-----------------------------------------------------------------------------+ +| subheadcformat | ++-----------------------------------------------------------------------------+ + +\subheadcformat{\numberingstyle{1} + \titleformat{\removelastskip + \goodbreak\vs{2\bl} + \twelvept + \rm\nin\subheadctitle + \par\nobreak + \vs{1\bl}\nobreak + \setsubheaddnumber{0}} + \incontents{no} + } + +Abbreviation: ã|\shcfã% + +Parameters: ã|submarkupã% + +Submarkup: ã|\numberingstyle, \titleformat, \incontentsã% + + ã|Description:ã% +The \subheadcformat markup lets you change the appearance of the subheading +title. There are three submarkup that control how the \subheadc 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 \subheadcnumber is incremented. + +ã|\titleformat{Nested Markup}ã% is used to describe how the \subheadc 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 +\subheadcformat: + + * \subheadcnumberprints the most recent subheadc number. + + * \subheadctitleprints the most recent subheadc title. + +ã|\incontentsã% places the subheadc 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": + +\shcf{\incontents{yes}} + + ã|Example:ã% +Some applications require the subheads to be numbered. If you wanted +\subheadc to include a number like "Section cc:" where "cc" is a bold +subheadc number, you could modify the \subheadcformat: + +\subheadcformat{\numberingstyle{1} + \titleformat{\removelastskip\goodbreak\vs{2\bl} + \nin\bd Section \subheadcnumber: + \quad\subheadctitle\par + \nobreak\vs{1\bl}\nobreak} + \incontents{no} +} + +more realistic. +\subheadc{Nationalism and War} +Nationalism is directly related to war. +Lord Acton observed that . . . + +The third subheadc would print as: + ++-----------------------------------------------------------------------------+ +| | +| more realistic. | +| | +| | +| Section 3: Nationalism and War | +| | +| Nationalism is directly related to war. Lord Acton observed that | +| . . . | +| | ++-----------------------------------------------------------------------------+ + + ã|Notes:ã% +The \subheadcformat markup must come after the \monospace markup, if both +are used. |