Mercurial > hg > batmud > maputils

annotate README.loc @ 2833:d0e186348cb2 default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add mention of soft level limitation to 'Eightleg woods'.
author Matti Hamalainen <ccr@tnsp.org>
date Sun, 26 May 2024 20:33:53 +0300
parents d2b36f0cebec
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
593
1b450b73e47c Added proper documentation for loc-files.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
1 MapUtils '.loc' file format documentation
1b450b73e47c Added proper documentation for loc-files.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
2 =========================================
2591
f207279a5f89 Bump loc file spec to v4.1, and implement handling of location addition
Matti Hamalainen <ccr@tnsp.org>
parents: 2412
diff changeset
3 This document describes format version 4.1.
2000
db306ae41c6d Add note about LOC documentation version.
Matti Hamalainen <ccr@tnsp.org>
parents: 1923
diff changeset
4
775
fad358ddb46f Updated LOC-format documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 597
diff changeset
5 GENERAL FORMAT DESCRIPTION
fad358ddb46f Updated LOC-format documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 597
diff changeset
6 --------------------------
fad358ddb46f Updated LOC-format documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 597
diff changeset
7 A properly formatted loc-file MUST start with line:
fad358ddb46f Updated LOC-format documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 597
diff changeset
8
961
45497e8a7c90 Bump loc version to 4.0; Update loc format documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 920
diff changeset
9 # MapUtils LOC file (version 4.0)
775
fad358ddb46f Updated LOC-format documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 597
diff changeset
10
fad358ddb46f Updated LOC-format documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 597
diff changeset
11 Processing software MAY check against the version number to see if they
597
9e6d08e67740 Updated.
Matti Hamalainen <ccr@tnsp.org>
parents: 593
diff changeset
12 are compatible with the format. Any backwards-incompatible changes
9e6d08e67740 Updated.
Matti Hamalainen <ccr@tnsp.org>
parents: 593
diff changeset
13 will result in change of the major version digit.
9e6d08e67740 Updated.
Matti Hamalainen <ccr@tnsp.org>
parents: 593
diff changeset
14
775
fad358ddb46f Updated LOC-format documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 597
diff changeset
15 Rest of the format is as follows:
593
1b450b73e47c Added proper documentation for loc-files.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
16
920
37cfc99fae08 Note character set here.
Matti Hamalainen <ccr@tnsp.org>
parents: 887
diff changeset
17 * Character set used is ISO-8859-1.
1407
84c3eb66a4b5 Update LOC documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 1024
diff changeset
18
775
fad358ddb46f Updated LOC-format documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 597
diff changeset
19 * Location record starts with a number describing the X-coordinate.
1407
84c3eb66a4b5 Update LOC documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 1024
diff changeset
20
775
fad358ddb46f Updated LOC-format documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 597
diff changeset
21 * Records can span multiple lines (line can be continued by ending
fad358ddb46f Updated LOC-format documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 597
diff changeset
22 with a slash character '\').
1407
84c3eb66a4b5 Update LOC documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 1024
diff changeset
23
84c3eb66a4b5 Update LOC documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 1024
diff changeset
24 * Records end with a linefeed (\n) character (unless continued with '\')
84c3eb66a4b5 Update LOC documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 1024
diff changeset
25
593
1b450b73e47c Added proper documentation for loc-files.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
26 * Empty lines (this includes lines with whitespace only) are IGNORED.
1407
84c3eb66a4b5 Update LOC documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 1024
diff changeset
27
775
fad358ddb46f Updated LOC-format documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 597
diff changeset
28 * Lines where the first non-whitespace character is a hash (#), are
fad358ddb46f Updated LOC-format documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 597
diff changeset
29 considered comments and are thus IGNORED. Processing software MAY
795
21e148e89bcc Some improvements and clarifications in LOC format v3 documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 778
diff changeset
30 preserve and add comments, if wished. Comment lines CAN NOT be
21e148e89bcc Some improvements and clarifications in LOC format v3 documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 778
diff changeset
31 continued with the above mentioned line continuation method.
1407
84c3eb66a4b5 Update LOC documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 1024
diff changeset
32
795
21e148e89bcc Some improvements and clarifications in LOC format v3 documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 778
diff changeset
33 * String-type fields can contain ESCAPED sequences (escape character
21e148e89bcc Some improvements and clarifications in LOC format v3 documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 778
diff changeset
34 is slash '\'), which MUST be parsed into literals.
775
fad358ddb46f Updated LOC-format documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 597
diff changeset
35 Example: foo\;bar would be parsed to "foo;bar"
593
1b450b73e47c Added proper documentation for loc-files.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
36
1407
84c3eb66a4b5 Update LOC documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 1024
diff changeset
37
775
fad358ddb46f Updated LOC-format documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 597
diff changeset
38 Each record is divided to fields 8 fields via semicolons (;). Fields MAY
593
1b450b73e47c Added proper documentation for loc-files.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
39 contain extra whitespace padding on both sides (left and right), which
775
fad358ddb46f Updated LOC-format documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 597
diff changeset
40 SHOULD be trimmed by the parser. Each record consists of following fields:
593
1b450b73e47c Added proper documentation for loc-files.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
41
775
fad358ddb46f Updated LOC-format documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 597
diff changeset
42 X;Y;flags;location name(s);creator(s);timestamp;URL;freeform
fad358ddb46f Updated LOC-format documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 597
diff changeset
43
593
1b450b73e47c Added proper documentation for loc-files.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
44
1b450b73e47c Added proper documentation for loc-files.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
45 The fields are as follows: (REQ = field is required, OPT = field can be
1b450b73e47c Added proper documentation for loc-files.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
46 left empty)
1b450b73e47c Added proper documentation for loc-files.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
47
1b450b73e47c Added proper documentation for loc-files.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
48 * [REQ] X (horizontal) and Y (vertical) coordinates of the location
1407
84c3eb66a4b5 Update LOC documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 1024
diff changeset
49 with origo (1,1) being in upper left corner of the map. The coodinate
84c3eb66a4b5 Update LOC documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 1024
diff changeset
50 pair MUST be unique in the context of the LOC file.
593
1b450b73e47c Added proper documentation for loc-files.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
51
1b450b73e47c Added proper documentation for loc-files.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
52 * [REQ] Flags: Contains information about the marker's type, etc:
1b450b73e47c Added proper documentation for loc-files.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
53 First (non-whitespace) character MUST be a number [0-3], which describes
1b450b73e47c Added proper documentation for loc-files.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
54 the alignment of the marker's label. Rest of the flags are OPTIONAL, and
1b450b73e47c Added proper documentation for loc-files.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
55 may comprise of following:
1b450b73e47c Added proper documentation for loc-files.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
56
1b450b73e47c Added proper documentation for loc-files.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
57 Marker types:
1b450b73e47c Added proper documentation for loc-files.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
58 '?' = Scenic
1b450b73e47c Added proper documentation for loc-files.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
59 '%' = Shrine scenic
2350
4653f50e34c6 Update some loc-file marker descriptions and comments.
Matti Hamalainen <ccr@tnsp.org>
parents: 2000
diff changeset
60 'C' = Player city
4653f50e34c6 Update some loc-file marker descriptions and comments.
Matti Hamalainen <ccr@tnsp.org>
parents: 2000
diff changeset
61 'c' = Major city
593
1b450b73e47c Added proper documentation for loc-files.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
62
1b450b73e47c Added proper documentation for loc-files.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
63 Location types:
1b450b73e47c Added proper documentation for loc-files.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
64 'S' = Raceshrine
1b450b73e47c Added proper documentation for loc-files.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
65 'G' = Guild
1b450b73e47c Added proper documentation for loc-files.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
66 'P' = Player guild/secret society
2350
4653f50e34c6 Update some loc-file marker descriptions and comments.
Matti Hamalainen <ccr@tnsp.org>
parents: 2000
diff changeset
67 'M' = Special monster
777
5c6d7350cd4e Added information about 'T' (Trainer) flag.
Matti Hamalainen <ccr@tnsp.org>
parents: 775
diff changeset
68 'T' = Guild-related Trainer
775
fad358ddb46f Updated LOC-format documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 597
diff changeset
69 'F' = Regional Fort
593
1b450b73e47c Added proper documentation for loc-files.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
70
1b450b73e47c Added proper documentation for loc-files.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
71 Special flags:
1b450b73e47c Added proper documentation for loc-files.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
72 '-' = Location is "invisible". Practically means that some operations
1b450b73e47c Added proper documentation for loc-files.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
73 of mkloc utility ignore this marker. In generated maps the marker
1b450b73e47c Added proper documentation for loc-files.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
74 itself MUST be placed, but label MUST NOT be drawn.
2350
4653f50e34c6 Update some loc-file marker descriptions and comments.
Matti Hamalainen <ccr@tnsp.org>
parents: 2000
diff changeset
75 '!' = Location is CLOSED.
1661
c8520999cfb0 Document "I" instanced location flag.
Matti Hamalainen <ccr@tnsp.org>
parents: 1525
diff changeset
76 'I' = Location is "instanced", e.g. usually personal for each player.
593
1b450b73e47c Added proper documentation for loc-files.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
77
778
065619974041 Ordering fixed.
Matti Hamalainen <ccr@tnsp.org>
parents: 777
diff changeset
78 * [REQ] Location name(s): The first name acts as UNIQUE identifier, but
065619974041 Ordering fixed.
Matti Hamalainen <ccr@tnsp.org>
parents: 777
diff changeset
79 there are exceptions: locations marked with invisible flag (-) may
065619974041 Ordering fixed.
Matti Hamalainen <ccr@tnsp.org>
parents: 777
diff changeset
80 share the same location identifier. Additional alternative names can
065619974041 Ordering fixed.
Matti Hamalainen <ccr@tnsp.org>
parents: 777
diff changeset
81 be specified, separated by pipe character ('|').
1525
6c78282b6deb Add examples.
Matti Hamalainen <ccr@tnsp.org>
parents: 1407
diff changeset
82 Example: ;Sharnacle Forest|@Sharnacle|Monsoon area;
778
065619974041 Ordering fixed.
Matti Hamalainen <ccr@tnsp.org>
parents: 777
diff changeset
83
961
45497e8a7c90 Bump loc version to 4.0; Update loc format documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 920
diff changeset
84 Each subfield (including the first unique identifier), MAY be prefixed
1923
29a2223814f8 Clarify some things in the LOC documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 1661
diff changeset
85 with ONE of the following flag characters:
961
45497e8a7c90 Bump loc version to 4.0; Update loc format documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 920
diff changeset
86
45497e8a7c90 Bump loc version to 4.0; Update loc format documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 920
diff changeset
87 '@' = Original, in-game name of the area. Typically output of 'whereami'
45497e8a7c90 Bump loc version to 4.0; Update loc format documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 920
diff changeset
88 command in flower BatMUD.
887
84664b2f6c61 Add a note about area name listing conventions.
Matti Hamalainen <ccr@tnsp.org>
parents: 795
diff changeset
89
593
1b450b73e47c Added proper documentation for loc-files.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
90 * [OPT] Creators: Contains comma-separated list of wizard names involved in
1b450b73e47c Added proper documentation for loc-files.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
91 creating or maintaining the area or otherwise related to the location.
1525
6c78282b6deb Add examples.
Matti Hamalainen <ccr@tnsp.org>
parents: 1407
diff changeset
92 Example: ;@Darol,!Durand,%Dazzt;
593
1b450b73e47c Added proper documentation for loc-files.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
93
1923
29a2223814f8 Clarify some things in the LOC documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 1661
diff changeset
94 Each subfield, MAY be prefixed with ONE of the following flag characters:
961
45497e8a7c90 Bump loc version to 4.0; Update loc format documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 920
diff changeset
95
45497e8a7c90 Bump loc version to 4.0; Update loc format documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 920
diff changeset
96 '@' = Original creator/coder of the area.
968
d124a3f8b917 Clarify flag explanation.
Matti Hamalainen <ccr@tnsp.org>
parents: 967
diff changeset
97 '!' = Converter or recoder of the area.
967
68c91395d9a0 Added '&' "expander" flag for creators.
Matti Hamalainen <ccr@tnsp.org>
parents: 961
diff changeset
98 '%' = Maintainer (sometimes analogous to recoder, though.)
68c91395d9a0 Added '&' "expander" flag for creators.
Matti Hamalainen <ccr@tnsp.org>
parents: 961
diff changeset
99 '&' = Expander (added new things, but not original creator.)
961
45497e8a7c90 Bump loc version to 4.0; Update loc format documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 920
diff changeset
100
593
1b450b73e47c Added proper documentation for loc-files.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
101 * [OPT] Timestamp: MAY be left empty, otherwise a timestamp of when the area
1024
e6f728cdbaf9 Correct some errors etc.
Matti Hamalainen <ccr@tnsp.org>
parents: 981
diff changeset
102 was added in the game. Formatted as 'dd.mm.yyyy', MUST be zero-padded.
2591
f207279a5f89 Bump loc file spec to v4.1, and implement handling of location addition
Matti Hamalainen <ccr@tnsp.org>
parents: 2412
diff changeset
103 The value MAY be prefixed with one of the following signifying accuracy:
f207279a5f89 Bump loc file spec to v4.1, and implement handling of location addition
Matti Hamalainen <ccr@tnsp.org>
parents: 2412
diff changeset
104
f207279a5f89 Bump loc file spec to v4.1, and implement handling of location addition
Matti Hamalainen <ccr@tnsp.org>
parents: 2412
diff changeset
105 nothing = Default accuracy
f207279a5f89 Bump loc file spec to v4.1, and implement handling of location addition
Matti Hamalainen <ccr@tnsp.org>
parents: 2412
diff changeset
106 '?' = Timestamp is "guesstimated". Basically an educated "guess"
f207279a5f89 Bump loc file spec to v4.1, and implement handling of location addition
Matti Hamalainen <ccr@tnsp.org>
parents: 2412
diff changeset
107 possibly based on some evidence.
f207279a5f89 Bump loc file spec to v4.1, and implement handling of location addition
Matti Hamalainen <ccr@tnsp.org>
parents: 2412
diff changeset
108 '!' = Timestamp is "known", e.g. as accurate as it can be.
f207279a5f89 Bump loc file spec to v4.1, and implement handling of location addition
Matti Hamalainen <ccr@tnsp.org>
parents: 2412
diff changeset
109 '#' = Timestamp is "approximate", e.g. may be off by some.
f207279a5f89 Bump loc file spec to v4.1, and implement handling of location addition
Matti Hamalainen <ccr@tnsp.org>
parents: 2412
diff changeset
110
f207279a5f89 Bump loc file spec to v4.1, and implement handling of location addition
Matti Hamalainen <ccr@tnsp.org>
parents: 2412
diff changeset
111 Examples: 21.03.2008; ?02.12.1996
593
1b450b73e47c Added proper documentation for loc-files.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
112
1b450b73e47c Added proper documentation for loc-files.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
113 * [OPT] URL: Properly encoded URL-link pointing to related web-page.
1b450b73e47c Added proper documentation for loc-files.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
114
1b450b73e47c Added proper documentation for loc-files.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
115 * [OPT] Freeform: Any location-related data. Ends in linefeed as it is the
1b450b73e47c Added proper documentation for loc-files.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
116 last field.
2412
218af640851e Move old format notes to bottom of the file.
Matti Hamalainen <ccr@tnsp.org>
parents: 2350
diff changeset
117
218af640851e Move old format notes to bottom of the file.
Matti Hamalainen <ccr@tnsp.org>
parents: 2350
diff changeset
118
2595
d2b36f0cebec Document the format change.
Matti Hamalainen <ccr@tnsp.org>
parents: 2591
diff changeset
119 CHANGES FROM v4.0
d2b36f0cebec Document the format change.
Matti Hamalainen <ccr@tnsp.org>
parents: 2591
diff changeset
120 -----------------
d2b36f0cebec Document the format change.
Matti Hamalainen <ccr@tnsp.org>
parents: 2591
diff changeset
121
d2b36f0cebec Document the format change.
Matti Hamalainen <ccr@tnsp.org>
parents: 2591
diff changeset
122 * Location added field can now have a timestamp accuracy prefix character.
d2b36f0cebec Document the format change.
Matti Hamalainen <ccr@tnsp.org>
parents: 2591
diff changeset
123
d2b36f0cebec Document the format change.
Matti Hamalainen <ccr@tnsp.org>
parents: 2591
diff changeset
124
2412
218af640851e Move old format notes to bottom of the file.
Matti Hamalainen <ccr@tnsp.org>
parents: 2350
diff changeset
125 CHANGES FROM v3.x
218af640851e Move old format notes to bottom of the file.
Matti Hamalainen <ccr@tnsp.org>
parents: 2350
diff changeset
126 -----------------
218af640851e Move old format notes to bottom of the file.
Matti Hamalainen <ccr@tnsp.org>
parents: 2350
diff changeset
127
218af640851e Move old format notes to bottom of the file.
Matti Hamalainen <ccr@tnsp.org>
parents: 2350
diff changeset
128 * Origin (origo) is now (1,1), compared to previous (0,0). This means
218af640851e Move old format notes to bottom of the file.
Matti Hamalainen <ccr@tnsp.org>
parents: 2350
diff changeset
129 that coordinates < 1 are illegal and that the data files have been
218af640851e Move old format notes to bottom of the file.
Matti Hamalainen <ccr@tnsp.org>
parents: 2350
diff changeset
130 adjusted +1,+1. This change was made to match BatMUD's internal
218af640851e Move old format notes to bottom of the file.
Matti Hamalainen <ccr@tnsp.org>
parents: 2350
diff changeset
131 coordinates, as shown by 'whereami' command.
218af640851e Move old format notes to bottom of the file.
Matti Hamalainen <ccr@tnsp.org>
parents: 2350
diff changeset
132 * Location name field can now have special flag prefixes on each
218af640851e Move old format notes to bottom of the file.
Matti Hamalainen <ccr@tnsp.org>
parents: 2350
diff changeset
133 subfield to indicate original (in-game) area name, etc.
218af640851e Move old format notes to bottom of the file.
Matti Hamalainen <ccr@tnsp.org>
parents: 2350
diff changeset
134 * Creator/coder name field can now have special flag prefixes on each
218af640851e Move old format notes to bottom of the file.
Matti Hamalainen <ccr@tnsp.org>
parents: 2350
diff changeset
135 subfield to indicate original coder, maintainer or recoder.
218af640851e Move old format notes to bottom of the file.
Matti Hamalainen <ccr@tnsp.org>
parents: 2350
diff changeset
136 * Certain new flags were added.
218af640851e Move old format notes to bottom of the file.
Matti Hamalainen <ccr@tnsp.org>
parents: 2350
diff changeset
137
218af640851e Move old format notes to bottom of the file.
Matti Hamalainen <ccr@tnsp.org>
parents: 2350
diff changeset
138
218af640851e Move old format notes to bottom of the file.
Matti Hamalainen <ccr@tnsp.org>
parents: 2350
diff changeset
139 CHANGES FROM v2.x
218af640851e Move old format notes to bottom of the file.
Matti Hamalainen <ccr@tnsp.org>
parents: 2350
diff changeset
140 -----------------
218af640851e Move old format notes to bottom of the file.
Matti Hamalainen <ccr@tnsp.org>
parents: 2350
diff changeset
141
218af640851e Move old format notes to bottom of the file.
Matti Hamalainen <ccr@tnsp.org>
parents: 2350
diff changeset
142 * Records are no longer line-based, but can span multiple lines.
218af640851e Move old format notes to bottom of the file.
Matti Hamalainen <ccr@tnsp.org>
parents: 2350
diff changeset
143 A new record can only start after a newline, though.
218af640851e Move old format notes to bottom of the file.
Matti Hamalainen <ccr@tnsp.org>
parents: 2350
diff changeset
144 * String fields can have escaped sequences inside them.
218af640851e Move old format notes to bottom of the file.
Matti Hamalainen <ccr@tnsp.org>
parents: 2350
diff changeset
145 * Name field can now contain optional alternative names,
218af640851e Move old format notes to bottom of the file.
Matti Hamalainen <ccr@tnsp.org>
parents: 2350
diff changeset
146 separated by pipe ('|'). First name, is still used as the
218af640851e Move old format notes to bottom of the file.
Matti Hamalainen <ccr@tnsp.org>
parents: 2350
diff changeset
147 primary "key", however.