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