diff options
Diffstat (limited to 'macros/text1/cms_help_files/ixf.helpmark')
-rw-r--r-- | macros/text1/cms_help_files/ixf.helpmark | 260 |
1 files changed, 260 insertions, 0 deletions
diff --git a/macros/text1/cms_help_files/ixf.helpmark b/macros/text1/cms_help_files/ixf.helpmark new file mode 100644 index 0000000000..a57b8f352b --- /dev/null +++ b/macros/text1/cms_help_files/ixf.helpmark @@ -0,0 +1,260 @@ ++-----------------------------------------------------------------------------+ +| indexformat | ++-----------------------------------------------------------------------------+ + +Abbreviation: ã|\ixfã% + +Parameters: ã|submarkupã% + +Submarkup: ã|\respectcase, \style, \leadering, \everyhang, +\everyletterbreak, \indentsubentry, \everyindexã% + + ã|Description:ã% +The defaults listed above for each markup applies initially to each of +the three indexes. One or more indexes' defaults can all be changed +by modifying the \indexformat markup. The complete description of the +\indexformat markup and its related submarkup is: + +\indexformatn{format} + +where n is the index (1, 2, or 3) and format is the submarkup. + +ã|respectcaseã% ignores the case of an index entry. This markup can only be +used within the \indexformat markup. If you wanted case respected and have +the lower case letters sorted before the upper case entries (i.e., "boat" +sorted before "Bed") then enter + +\respectcase{yes} + + ã|Notes:ã% +Respecting case applies to all letters. If \respectcase{yes} has been +specified, then "boat" and "cat" will both be sorted before "Bed". The +default value is \respectcase{no} for each of the 3 indexes. + +ã|styleã% regulates the general index format. \style{indent}, the default, +indents each index entry. This style looks like: + ++-----------------------------------------------------------------------------+ +| | +| Constantinople, 12, See also Istanbul | +| alien rule of, 20 | +| Arab invasion of, 19, 31 | +| Crusades and, 22, 57 | +| Ottoman conquest of, 29--31 | +| | ++-----------------------------------------------------------------------------+ + + There are two other styles to choose from: "paragraph" and "dash". The +style "paragraph" is a run-on hanging paragraph. You get it by specifying: + +\indexformat1{\style{paragraph}} + +With this style, the above index would look like: + ++-----------------------------------------------------------------------------+ +| | +| Constantinople, 12, alien rule | +| of, 20, Arab invasion of, 19, | +| 31, Crusades and, 22, 57, | +| Ottoman conquest of, 29--31, See | +| also Istanbul | +| | ++-----------------------------------------------------------------------------+ + +Note that with this style, the blind entry from the \blindentry submarkup +comes after the subentry, instead of after the main entry as was done for +the "indent" style. + The third style is "dash", an em-dash style. You get it by specifying + +\indexformat1{\style{dash}} + +It is very similar to the default "indent" style, except subentries are +prefaced with an em dash following the initial indent of space. + ++-----------------------------------------------------------------------------+ +| | +| Constantinople, 12, See also Istanbul | +| ---alien rule of, 20 | +| ---Arab invasion of, 19, 31 | +| ---Crusades and, 22, 57 | +| ---Ottoman conquest of, 29--31 | +| | ++-----------------------------------------------------------------------------+ + +ã|leaderingã% turns on/off dot leadering. The default is "off". You +can change this default only within the \indexformat markup. To have dot +leadering, enter: + +\ixf1{\leadering{yes}} + +If you are using \style{indent} and \leadering{yes} you get: + ++-----------------------------------------------------------------------------+ +| | +| Constantinople, See also | +| Istanbul ... . ... ... . ....12 | +| alien rule of ... . ... 20 | +| Arab invasion of . . .19, 31 | +| Crusades and .... . .22, 57 | +| Ottoman conquest of .29--31 | +| | ++-----------------------------------------------------------------------------+ + + ã|Notes:ã% +Do not use dot leadering with \style{paragraph}. + +ã|everyletterbreakã% is what will be printed between each letter break, +(i.e. between "A" and "B"). By default, one blank line is skipped when +starting a new letter (at each letter break). The \everyletterbreak markup +can only appear within the \indexformat markup. + + ã|Example:ã% +You could modify the default to place a rule and skip between breaks: + +\ixf1{\everyletterbreak{\vs{\bl} + \hrule width 2in + \vs{\bl}}} + + This would look something like: + ++-----------------------------------------------------------------------------+ +| | +| ..................... | +| alpha, 62 | +| America, 38 | +| Austria, 55 | +| ..................... | +| | +| Bach, 98 | +| Bethlehem, 87 | +| | ++-----------------------------------------------------------------------------+ + + ã|Example:ã% +Something else you can do with indexes is to make use of the "\nextletter" +submarkup, which gives you the next uppercase character about to be listed +in the sorted index list. For example, between "apple" and "boat" the +value of "\nextletter" would be "B". One application would be to print the +"\nextletter" in a large type. This could be accomplished by changing the +default for "\everyletterbreak" to: + +\indexformat{\everyletterbreak{\vs{\bl} + \noindent{\twelvepoint\bd\nextletter}\par}} + +The resulting index would look like: + ++-----------------------------------------------------------------------------+ +| | +| | +| A | +| alpha, 62 | +| America, 38 | +| Austria, 55 | +| | +| B | +| Bach, 98 | +| Bethlehem, 87 | ++-----------------------------------------------------------------------------+ + + ã|Example:ã% +Another variation of the above would be to draw a box around the next +letter. You could do this by adding \drawbox to \everyletterbreak: + +\ixf1{\everyletterbreak{\vs{\bl} + \drawbox{\bd\nextletter}\par}} + +and you will get an index that prints as illustrated on the next page. + ++-----------------------------------------------------------------------------+ +| | +| ..... | +| ..... | +| alpha, 62 | +| America, 38 | +| Austria, 55 | +| | +| ..... | +| ..... | +| Bach, 98 | +| Bethlehem, 87 | +| | ++-----------------------------------------------------------------------------+ + + ã|Notes:ã% +The "\nextletter" is always an uppercase letter. + Only letters, not numbers or special characters such as the backslash +(\) are used as \nextletter. + +ã|indentsubentryã% There are two levels of subentries available. The amount +of distance they are indented when you are using the "indent" or "dash" +styles is controlled by the \indentsubentry submarkup. If you are using +the "paragraph" style for the index, the \indentsubentry is ignored. The +definition of this markup is, + +\ixf1{\indentsubentryn{amt}} + +where n is the subentry level, 1 or 2, and amt is the amount to be indented. +The default indent for these two subentry levels is: + +\ixf1{\indentsubentry1{1em} + \indentsubentry2{2em}} + + If, for example, you were using the "indented" style and wanted each +subentry level indented two em's from the previous level, you would enter, + +\ixf1{\indentsubentry1{2em} + \indentsubentry2{4em}} + +which would print the index illustrated earlier as: ++-----------------------------------------------------------------------------+ +| | +| Constantinople, 12, See also Istanbul | +| alien rule of, 20 | +| Arab invasion of, 19, 31 | +| Crusades and, 22, 57 | +| Ottoman conquest of, 29--31 | +| | ++-----------------------------------------------------------------------------+ + +ã|everyhangã% controls the hanging indent for the primary index level and +each of the two subentry levels. If you had an index entry with many page +numbers, + ++-----------------------------------------------------------------------------+ +| | +| Write state- | +| ment, 26, | +| 34--38, 70, | +| 86, | +| 103, 191, | +| 202, 203-- | +| 204, 281 | +| | ++-----------------------------------------------------------------------------+ + +The hangingindent would be 1.5em by default. + + ã|Example:ã% +If you wanted to increase that value to 3em, you would enter, + +\ixf1{\everyhang{3em}} + +and you would get: + ++-----------------------------------------------------------------------------+ +| | +| Write state- | +| ment, 26, | +| 34--38, | +| 70, 86, | +| 103, 191, | +| 202, 203-- | +| 204, 281 | +| | ++-----------------------------------------------------------------------------+ + +ã|everyindexã% is a list of one or more commands to be executed before +printing the sorted index. By default, \tenpt is the value of \everyindex. + + ã|Notes:ã% +The default type style used with \monospace is \roman instead of \tenpt. |