Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Beautify two word anchors #87

Merged
merged 1 commit into from
Jun 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions content/docs/standard/table-dialect.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ With this dialect definition:

Where `field1` and `field2` names are implementation-specific and used here only for illustrative purpose.

### `headerRows`
### `headerRows` {#headerRows}

A Table Dialect descriptor `MAY` have the `headerRows` property that `MUST` be an array of positive integers starting from 1 with default value `[1]`. This property specifies the row numbers for the header. It is `RECOMMENDED` to be used for multiline-header files.

Expand Down Expand Up @@ -194,7 +194,7 @@ With this dialect definition:
{"fruit id": 2, "fruit name": "orange"}
```

### `headerJoin`
### `headerJoin` {#headerJoin}

A Table Dialect descriptor `MAY` have the `headerJoin` property that `MUST` be a string with default value `" "`. This property specifies how multiline-header files have to join the resulting header rows.

Expand Down Expand Up @@ -223,7 +223,7 @@ With this dialect definition:
{"fruit-id": 2, "fruit-name": "orange"}
```

### `commentRows`
### `commentRows` {#commentRows}

A Table Dialect descriptor `MAY` have the `commentRows` property that `MUST` be an array of positive integers starting from 1; undefined by default. This property specifies what rows have to be omitted from the data.

Expand Down Expand Up @@ -251,7 +251,7 @@ With this dialect definition:
{id: 2, name: "orange"}
```

### `commentChar`
### `commentChar` {#commentChar}

A Table Dialect descriptor `MAY` have the `commentChar` property that `MUST` be a string of one or more characters; undefined by default. This property specifies what rows have to be omitted from the data based on the row's first characters.

Expand Down Expand Up @@ -306,7 +306,7 @@ With this dialect definition:
{id: 2, name: "orange"}
```

### `lineTerminator`
### `lineTerminator` {#lineTerminator}

A Table Dialect descriptor `MAY` have the `lineTerminator` property that `MUST` be a string; with default value `\r\n`. This property specifies the character sequence which terminates rows.

Expand All @@ -331,7 +331,7 @@ With this dialect definition:
{id: 2, name: "orange"}
```

### `quoteChar`
### `quoteChar` {#quoteChar}

A Table Dialect descriptor `MAY` have the `quoteChar` property that `MUST` be a string of one character length with default value `"` (double quote). This property specifies a character to use for quoting in case the `delimiter` needs to be used inside a data cell.

Expand All @@ -358,7 +358,7 @@ With this dialect definition:
{id: 2, name: "orange,fruits"}
```

### `doubleQuote`
### `doubleQuote` {#doubleQuote}

A Table Dialect descriptor `MAY` have the `doubleQuote` property that `MUST` be boolean with default value `true`. This property controls the handling of `quoteChar` inside data cells. If true, two consecutive quotes are interpreted as one.

Expand All @@ -385,7 +385,7 @@ With this dialect definition:
{id: 2, name: 'orange"fruits'}
```

### `escapeChar`
### `escapeChar` {#escapeChar}

A Table Dialect descriptor `MAY` have the `escapeChar` property that `MUST` be a string of one character length; undefined by default. This property specifies a one-character string to use for escaping, for example, `\`, mutually exclusive with `quoteChar`.

Expand All @@ -412,7 +412,7 @@ With this dialect definition:
{id: 2, name: "orange,fruits"}
```

### `nullSequence`
### `nullSequence` {#nullSequence}

A Table Dialect descriptor `MAY` have the `nullSequence` property that `MUST` be a string; undefined by default. This property specifies specifies the null sequence, for example, `\N`.

Expand All @@ -439,7 +439,7 @@ With this dialect definition:
{id: 2, name: null}
```

### `skipInitialSpace`
### `skipInitialSpace` {#skipInitialSpace}

A Table Dialect descriptor `MAY` have the `skipInitialSpace` property that `MUST` be boolean with default value `false`. This property specifies how to interpret whitespace which immediately follows a delimiter; if `false`, it means that whitespace immediately after a delimiter is treated as part of the following field.

Expand Down Expand Up @@ -496,7 +496,7 @@ With this dialect definition:
{id: 2, name: "orange"}
```

### `itemType`
### `itemType` {#itemType}

A Table Dialect descriptor `MAY` have the `itemType` property that `MUST` be a string with value `array` or `object`; undefined by default. This property specifies whether the data `property` contains an array of arrays or an array of objects.

Expand Down Expand Up @@ -525,7 +525,7 @@ With this dialect definition:
{id: 2, name: "orange"}
```

### `itemKeys`
### `itemKeys` {#itemKeys}

A Table Dialect descriptor `MAY` have the `itemKeys` property that `MUST` be array of strings; undefined by default. This property specifies the way of extracting rows from data arrays with `itemType` is `object`.

Expand Down Expand Up @@ -553,7 +553,7 @@ With this dialect definition:
{id: 2, name: "orange"}
```

### `sheetNumber`
### `sheetNumber` {#sheetNumber}

A Table Dialect descriptor `MAY` have the `sheetNumber` property that `MUST` be an integer with default value `1`. This property specifies a sheet number of a table in the spreadsheet file.

Expand All @@ -574,7 +574,7 @@ With this dialect definition:

`SHOULD` output the data from the second sheet.

### `sheetName`
### `sheetName` {#sheetName}

A Table Dialect descriptor `MAY` have the `sheetName` property that `MUST` be a string; undefined by default. This property specifies a sheet name of a table in the spreadsheet file.

Expand Down
26 changes: 13 additions & 13 deletions content/docs/standard/table-schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ A root level Table Schema descriptor `MAY` have a `$schema` property that `MUST`

The default value is `https://datapackage.org/profiles/1.0/tableschema.json` and the recommended value is `https://datapackage.org/profiles/2.0/tableschema.json`.

#### `fieldsMatch`
#### `fieldsMatch` {#fieldsMatch}

A Table Schema descriptor `MAY` contain a property `fieldsMatch` that `MUST` be a string with the following possible values and the `exact` value by default:

Expand All @@ -84,7 +84,7 @@ A Table Schema descriptor `MAY` contain a property `fieldsMatch` that `MUST` be
- **superset**: The data source `MUST` only have fields defined in the `fields` array, but `MAY` have fewer. Fields `MUST` be mapped by their names.
- **partial**: The data source `MUST` have at least one field defined in the `fields` array. Fields `MUST` be mapped by their names.

#### `missingValues`
#### `missingValues` {#missingValues}

Many datasets arrive with missing data values, either because a value was not collected or it never existed. Missing values may be indicated simply by the value being empty in other cases a special value may have been used e.g. `-`, `NaN`, `0`, `-9999` etc.

Expand Down Expand Up @@ -113,7 +113,7 @@ Examples:

When implementations choose to convert missing values to null, this conversion to `null` `MUST` be done before any other attempted type-specific string conversion. The default value `[ "" ]` means that empty strings will be converted to null before any other processing takes place. Providing the empty list `[]` means that no conversion to null will be done, on any value.

#### `primaryKey`
#### `primaryKey` {#primaryKey}

A primary key is a field or set of fields that uniquely identifies each row in the table. Per SQL standards, the fields cannot be `null`, so their use in the primary key is equivalent to adding `required: true` to their [`constraints`](#constraints).

Expand Down Expand Up @@ -145,7 +145,7 @@ Here's an example:
Data consumer MUST support the `primaryKey` property in a form of a single string e.g. `primaryKey: a` which was a part of the `v1.0` of the specification.
:::

#### `uniqueKeys`
#### `uniqueKeys` {#uniqueKeys}

A unique key is a field or a set of fields that are required to have unique logical values in each row in the table. It is directly modeled on the concept of unique constraint in SQL.

Expand Down Expand Up @@ -186,7 +186,7 @@ All the field values that are on the logical level are considered to be `null` v

In contrast with `field.constraints.unique`, `uniqueKeys` allows to define uniqueness as a combination of fields. Both properties `SHOULD` be assessed separately.

#### `foreignKeys`
#### `foreignKeys` {#foreignKeys}

A foreign key is a reference where values in a field (or fields) on the table ('resource' in data package terminology) described by this Table Schema connect to values a field (or fields) on this or a separate table (resource). They are directly modelled on the concept of foreign keys in SQL.

Expand Down Expand Up @@ -357,7 +357,7 @@ If `categories` is (b) an array of objects, each object `MAY` also have a `label

An `enum` constraint `MAY` be added to a field with a `categories` property, but if so, the `enum` values `MUST` be a subset of the values in `categories`.

#### `categoriesOrdered`
#### `categoriesOrdered` {#categoriesOrdered}

When the `categories` property is defined, it `MAY` be accompanied by a `categoriesOrdered` property in the field definition. When present, the `categoriesOrdered` property `MUST` be `boolean`. When `categoriesOrdered` is `true`, implementations `SHOULD` regard the order of appearance of the values in the `categories` property as their natural order. For example:

Expand All @@ -378,7 +378,7 @@ When the `categories` property is defined, it `MAY` be accompanied by a `categor

When the property `categoriesOrdered` is `false`, implementations `SHOULD` assume that the categories do not have a natural order; when the property is not present, no assumption about the ordered nature of the values `SHOULD` be made.

#### `missingValues`
#### `missingValues` {#field-missingValues}

A list of missing values for this field as per [Missing Values](#missingvalues) definition. If this property is defined, it takes precedence over the schema-level property and completely replaces it for the field without combining the values.

Expand All @@ -402,7 +402,7 @@ A data consumer `MUST`:
- interpret `""` and `NA` as missing values for `column1`
- interpret only `-` as a missing value for `column2`

#### `rdfType`
#### `rdfType` {#rdfType}

A richer, "semantic", description of the "type" of data in a given column `MAY` be provided using a `rdfType` property on a field descriptor.

Expand Down Expand Up @@ -644,14 +644,14 @@ Indicates whether this field cannot be `null`. If required is `false` (the defau

If `true`, then all values for that field `MUST` be unique within the data file in which it is found.

### `minLength`
### `minLength` {#minLength}

- **Type**: integer
- **Fields**: collections (string, array, object)

An integer that specifies the minimum length of a value.

### `maxLength`
### `maxLength` {#maxLength}

- **Type**: integer
- **Fields**: collections (string, array, object)
Expand All @@ -672,21 +672,21 @@ Specifies a minimum value for a field. This is different to `minLength` which ch

As for `minimum`, but specifies a maximum value for a field.

### `exclusiveMinimum`
### `exclusiveMinimum` {#exclusiveMinimum}

- **Type**: integer, number, date, time, datetime, duration, year, yearmonth
- **Fields**: integer, number, date, time, datetime, duration, year, yearmonth

As for `minimum`, but for expressing exclusive range.

### `exclusiveMaximum`
### `exclusiveMaximum` {#exclusiveMaximum}

- **Type**: integer, number, date, time, datetime, duration, year, yearmonth
- **Fields**: integer, number, date, time, datetime, duration, year, yearmonth

As for `maximum`, but for expressing exclusive range.

### `jsonSchema`
### `jsonSchema` {#jsonSchema}

- **Type**: object
- **Fields**: array, object
Expand Down