TextRef is designed with a simple data model enabling data to be both human editable and machine actionable, supporting manual curation of datasets as well as automatic generation.
A TextRef dataset must specify two things:
Each of these is specified using a simple CSV (Comma Separated Value) file. Each CSV file contains a single table of data, and these files can be easily created using spreadsheet software such as Microsoft Excel, as well as any other desired method.
Each dataset consists of a metadata file and a data file. Both files must be accessible online at a known location specified by URL, and these locations must be recorded in the metadata file as described below. Additionally:
A metadata file consists of two columns of data, labeled "Field" and "Value". Each row specifies a field name (case insensitive) and a value for the corresponding field. Defined fields are as follows:
| Field name | Value | Required/optional |
|---|---|---|
| MetaURL | Location (as HTTP or HTTPS URL) of this metadata file. | Required |
| DataURL | Location (as HTTP or HTTPS URL) of the corresponding data file. | Required |
| ShortName | A short (max 20 character) title for the dataset. | Required |
| LongName | A longer descriptive title for the dataset. | Required |
| ResourceTemplate | Template to transform a primary_id value into a URL for a specific resource. | Optional |
| SchemaURL | Schema file specifying what format the data file implements. | Optional |
| License | License applying to the data file. Possible values: "CC 0", "CC BY", "CC BY-SA", "CC BY-NC", "CC BY-NC", "CC BY-NC-SA". | Optional |
If a value for ResourceTemplate is specified, it must take the form of a URL containing the string "{primary_id}"; this string will be replaced with the primary ID of a specified resource, and the template must be chosen so that this creates a URL resolving to that resource.
A data file consists of columns of data as described below. Undefined column names are ignored; defined column names are as follows:
| Column name | Value | Required/optional |
|---|---|---|
| Primary_id | A unique (within this data file) identifier for this row | Required |
| Title | The title of the item | Required |
| Author | The author of the item | Required |
| Edition | The edition of the textual object | Optional |
| Collection | The title of the collection to which the textual object belongs | Optional |
| Fulltext_Read | Resource allows viewing of full-text content* | Optional |
| Fulltext_Search | Resource allows full-text search* | Optional |
| Fulltext_Download | Resource allows full-text export/download* | Optional |
| Image | This resource has online full-text functionality* | Optional |
* Value should be "y" if present, "n" if not present, left blank if unknown/not specified.