Contents | < Browse | Browse >
Highlighting Commands are Useful
--------------------------------
The highlighting commands can be used to generate useful information
from the file, such as lists of functions or file names. It is
possible, for example, to write a program in Emacs Lisp (or a keyboard
macro) to insert an index entry after every paragraph that contains
words or phrases marked by a specified command. You could do this to
construct an index of functions if you had not already made the entries.
The commands serve a variety of purposes:
`@code{SAMPLE-CODE}'
Indicate text that is a literal example of a piece of a program.
`@kbd{KEYBOARD-CHARACTERS}'
Indicate keyboard input.
`@key{KEY-NAME}'
Indicate the conventional name for a key on a keyboard.
`@samp{TEXT}'
Indicate text that is a literal example of a sequence of
characters.
`@var{METASYNTACTIC-VARIABLE}'
Indicate a metasyntactic variable.
`@file{FILE-NAME}'
Indicate the name of a file.
`@dfn{TERM}'
Indicate the introductory or defining use of a term.
`@cite{REFERENCE}'
Indicate the name of a book.