Text Formatting:Language Files

From Anope Wiki

Jump to: navigation, search

Contents

Text Formatting: Language Files

Basic rules

String Names

Every string name starts at the beginning of a line: no space, no tabs, no comment-marks, just plain CAPS text.

Comments

Comments are on lines starting with a comment-mark (#).

Text

Lines with text start with a tab. The next string name indicates the end of the text.

Special Characters

Strings and Numbers

Strings and numbers are indicated with %s and %d, printf styleh. Note that they HAVE to stay in the same order as the source string, or things will break badly.

Services Alias

You can insert the alias of the currently active service by using %S. Usage of this is limited to help messages.

Notes

Line Length

Every line should be at most 60 characters. This makes sure that text-based clients also get a nice view. Usually they have a screen with a width of 80 characters, and if you substract the services alias, timestamp, and the other usual stuff on a line, you usually keep at least 60 characters left to fill. Note that the Special Characters noted above expand, so if you use a %S, add 6 characters to your used line length (%S is 2, a services name usually is 8, 8 - 2 = 6).

Personal tools