Control statements

Far Manager

previous page next page

Control statements

In the beginning, language and help files can contain the following control statements, starting from a dot character.

Control statement Description

Control statement	Description
.Language	.Language=<Language name>,<Language description> This statement must be present at the beginning of all language and help files. <Language name> describes the file language and must be a standard language name in English. All files with the same language must have the same `<Language name>` field. <Language description> can contain a language description in arbitrary form. It will be displayed in the `Languages` menu..
.PluginContents	.PluginContents=<Contents topic name> This optional statement can be used to add the <Contents topic name> entry to the plugins help list that is displayed in FAR help when `Shift-F2` is pressed. After choosing this entry, the topic `Contents` of the plugin help will be displayed. (see "Help files" about the `Contents` topic).
.Options	.Options <KeyName>=<Value> This optional statement can be used to specify additional options in help files. There are several available options, described below. <KeyName> One of the following options: CtrlColorChar <Value> contains the character that will be used to specify the color attribute for the text in help file. (see "Help files" about the `CtrlColorChar` option). For example specifying: .Options CtrlColorChar=\ sets the `\` character to be the color specifying character. TabSize <Value> specifies the tab size in the HLF file. Must be in the range of 1 to 16, the default value is 8. CtrlStartPosChar <Value> contains the character that will be used to mark a block alignment position. For example, setting: .Options CtrlStartPosChar=& means that the '&' character will mark a block alignment position, then the block: item 1 - &Joe;'s father is strong in math, he studies instead of Joe all year long. will be aligned as follows: item 1 - Joe's father is strong in math, he studies instead of Joe all year long.

.Language=<Language name>,<Language description>

This statement must be present at the beginning of all language and help files.

describes the file language and must be a standard language name in English. All files with the same language must have the same <Language name> field.

can contain a language description in arbitrary form. It will be displayed in the Languages menu..

.PluginContents

.PluginContents=<Contents topic name>

This optional statement can be used to add the <Contents topic name> entry to the plugins help list that is displayed in FAR help when Shift-F2 is pressed. After choosing this entry, the topic Contents of the plugin help will be displayed. (see "Help files" about the Contents topic).

.Options

.Options <KeyName>=<Value>

This optional statement can be used to specify additional options in help files. There are several available options, described below.

One of the following options:

CtrlColorChar <Value> contains the character that will be used to specify the color attribute for the text in help file. (see "Help files" about the CtrlColorChar option). For example specifying:
```
.Options CtrlColorChar=\
```
sets the \ character to be the color specifying character.
TabSize
<Value> specifies the tab size in the HLF file. Must be in the range of 1 to 16, the default value is 8.
CtrlStartPosChar
<Value> contains the character that will be used to mark a block alignment position. For example, setting:
```
.Options CtrlStartPosChar=&
```
means that the '&' character will mark a block alignment position, then the block:
```
item 1 - &Joe;'s father is strong in math, he studies instead of Joe all year long.
```
will be aligned as follows:
```
item 1 - Joe's father is strong in math,
         he studies instead of Joe all year long.
```

Example:

.Language=Engish,English
.PluginContents=FTP client
@Contents
$ #FTP client#
   ~Connecting to an FTP server~@FTPConnect@

   ~Working with server names~@FTPNames@

   ~FTP client commands~@FTPCmd@

   ~FTP client configuration~@FTPCfg@

   ~FTP client panel modes~@FTPPanel