Subversion Repositories wimsdev

Rev

Rev 10895 | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 10895 Rev 16346
Line 4... Line 4...
4 
 
 4 
 
5 
Datafiles in src/data can be taken into account by the mkindex script.
 5 
Datafiles in src/data can be taken into account by the `mkindex` script.
6 
Such files must have extension ".data".
 6 
Such files must have extension `.data`.
7 
 
 7 
 
8 
Datafiles are record files. If the first line of the data file (in record 0)
 8 
Datafiles are record files. If the first line of the data file (in record 0)
9 
does not start with '.' or ':', it will be considered as the title and
 9 
does not start with `.` or `:`, it will be considered as the title and
10 
treated accordingly. Otherwise the title will default to the file base name.
 10 
treated accordingly. Otherwise the title will default to the file base name.
11 
 
 11 
 
12 
The index of datafile is in the file Dataindex of the module.
 12 
The index of datafile is in the file `Dataindex` of the module.
13 
This is a multi-line structure, each line corresponding to a data file.
 13 
This is a multi-line structure, each line corresponding to a data file.
14 
A line has 3 columns separated by comma:
 14 
A line has 3 columns separated by comma:
- 
 
 15 
 
15 
first is the file's base name,
 16 
1. first is the file's base name,
16 
the second the title,
 17 
2. the second the title,
- 
 
 18 
3. then the author Firstname,
- 
 
 19 
4. ...and author Lastname
17 
and the 3rd counts the records in the file.
 20 
* and the last one counts the records in the file.
18
21 
 
19 
The content of the datafile records can be of any format.
 22 
The content of the datafile records can be of any format.
20 
The record 0 can contain any metadata of the file.
 23 
The record 0 can contain any metadata of the file.
21 
Lines in record 0 other than the title line should start with a dot ('.').
 24 
Lines in record 0 other than the title line should start with a dot (`.`).