Previous: , Up: Introduction   [Contents]


1.5 Conventions

This manual is available in three formats: PDF, HTML, and info files, which can be read using Emacs’ info browser.

Throughout this manual, commands offered by stand-off mode are represented following the conventions:

Command: standoff-some-command-name ARG1 ARG2

(x) (‘Stand-Off->Some command’) Explanation what this command does. Explanation of the Arguments ARG1 and ARG2.

Here is an example:

Command: standoff-display-manual

(?) (‘Stand-Off->Manual’) Open the manual for standoff mode. There are manuals in two languages: english and german. The customization option standoff-info-language is used, to select a language. If is set to “de”, the german manual is opened. If it is nil, then the LANG environment variable is evaluated. When the result of the evaluation is not “de”, the english manual is opened.

The command standoff-display-manual takes no arguments an is bound to the key ? and the menu entry Manual in the Stand-Off menu.

You can call such a command in three ways. (1) Call it by name, (2) by key code, (3) select it from the menu. The name is given in the first line right after the keyword Command. Here, the command’s name is standoff-display-manual. The key code is given in the first parentheses, here it is ?. So you can call the manual by simply pressing the ? on your keyboard, provided that the current buffer is in standoff mode. The menu entry is given in the second parenthesis, here it is the menu entry “Manual” in the menu “Stand-Off”.