Spec / ovs-avoid-token-index
Open Values Avoid Token Index v0.1
For each company a person can choose to avoid, the lowercase names of the company and the brands it owns, for matching against text on other web pages. The data build writes it for a planned browser extension and other tools.
- Files built from other files
- Status: stable
- Version: 0.1
- Format name in the file:
ovs-avoid-token-index
Stable. A change that breaks existing files needs a new version. A file a build step makes from other files. Change the sources, not this file.
Who writes it and who reads it
Written by pipeline/build_nodes.js. Read by future browser extension, line tooling.
Fields
| Field | What it means | Type |
|---|---|---|
format required | Names this file's format, so a reader can check it before reading the rest of the file. | always "ovs-avoid-token-index" |
version required | The version of the format this file follows, such as "0.1". | string |
built required | The date of the source data this file was built from, as YYYY-MM-DD. | string |
source required | The files the token lists were built from, as paths in the repository. | see sourceList |
purpose required | One sentence on what this file is for and how its tokens are made. | string |
matching required | How a tool should compare page text with the tokens. | see matching |
families required | One family per avoid line. An avoid line, from content/lines.json, lets a person hide a company and the brands it owns. | list |
stats required | Counts of families, tokens, unique tokens, and the file's size in bytes. | see stats |
A reader MUST ignore fields it does not know, so a file can carry more than this list and still be read. A writer MUST NOT change what a listed field means.
The schema
Its address is https://openvaluesstandard.org/schema/avoid-token-index-v0.1.schema.json. Validators can fetch it there; the file is also in the repository at app/data/standard/schemas/avoid-token-index.schema.json.
The key words MUST, MUST NOT, SHOULD, SHOULD NOT and MAY are used as described in RFC 2119 and RFC 8174 when, and only when, they appear in capitals.
Whether this format fits your app is your call. The spec says what a file MUST hold. Which formats you read and write, and what your app does with them, is yours to decide.