8 Library Interchange
8.3 LID keyword statements
A LID file consists of a series of keyword/value statements, just like the Dylan source file interchange format described in DRM (page 21.) In this section, we describe the standard LID keywords.
Library:LID file keyword
Library: library-name
- Names the Dylan library being described. The library-name must be the name of the Dylan library that the LID file describes. This keyword is required in every LID file, and it may appear only once per LID file.
LID file keyword
Files: file-designators
- Associates a set of files with the library named by the
Library:keyword. This keyword can appear one or more times per LID file. Every file specified is considered to be associated with the library. - A file designator is something that can be mapped to a concrete file name. Only one file designator can appear per line of the LID file. See Section 8.5 on page 189 for a description of the format of file designators and how they are mapped to concrete file names.
- The order in which the designated source files are specified with the
Files:keyword in the LID file determines the initialization order across the files within the defined library. - All the files specified must reside in the same folder (directory) as the LID file.
LID file keyword
Synopsis: arbitrary text
- A concise description of the library.
LID file keyword
Keywords: comma-separated phrases
- Any number of phrases, separated by commas, that are relevant to the description or use of the library.
LID file keyword
Author: arbitrary text
- The name of the library's author.
LID file keyword
Version: arbitrary text
- The current version number of the library.
LID file keyword
Description: arbitrary text
- A description of the library. The intention of this keyword is to provide a fuller, less concise description than that given by the
Synopsis:keyword.
LID file keyword
Comment: arbitrary text
- Any additional comments about the library.