Skip to content
Merged
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
29 changes: 10 additions & 19 deletions metadata/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1091,75 +1091,66 @@ <h2>Inherited Properties</h2>
<p>
A <a href="http://w3c.github.io/csvw/syntax/#dfn-cell" class="externalDFN">cell</a> may be assigned annotations based on properties on the description objects for the <a title="table group description">group of tables</a>, <a title="table description">table</a>, <a title="schema description">schema</a>, or <a title="column description">column</a> that it appears in. These properties are known as <dfn title="inherited property">inherited properties</dfn> and are listed below. To ascertain a value for certain annotations on cells, an application MUST identify the relevant property in the descriptions of the group of tables, table, schema, or column.
</p>
<p>
Applications MUST raise an error if the value of a property in a <a>table description</a> is not <a>compatible with</a> the value of that property on the <a>table group description</a> it appears in. Applications MUST raise an error if the value of a property in a <a>schema description</a> is not <a>compatible with</a> the value of that property on the <a>table description</a> and <a>table group description</a> it appears in. Applications MUST raise an error if the value of a property in a <a>column description</a> is not <a>compatible with</a> the value of that property in the <a>schema description</a>, <a>table description</a>, and/or <a>table group description</a> it appears in.
</p>
<p>
A value for an <a>inherited property</a> on a column or table description is <dfn>compatible with</dfn> with an inherited value on the same property on a table or table group description if they are the same value or if the first value is a sub-value of the second value. The definitions of individual <a title="inherited property">inherited properties</a> indicate what values count as sub-values of others.
</p>
<dl>
<dt id="cell-aboutUrl"><code>aboutUrl</code></dt>
<dd>
<p>A <a>URI template property</a> that MAY be used to create a unique identifier for each cell within a row when mapping data to other formats. There are no <a title="compatible with">compatibility restrictions</a> on this property. The value of this property becomes the <a href="http://w3c.github.io/csvw/syntax/#dfn-column-about-url" class="externalDFN">about URL</a> annotation for the described <a href="http://w3c.github.io/csvw/syntax/#dfn-column" class="externalDFN">column</a>,.</p>
<p>A <a>URI template property</a> that MAY be used to create a unique identifier for each cell within a row when mapping data to other formats. The value of this property becomes the <a href="http://w3c.github.io/csvw/syntax/#dfn-column-about-url" class="externalDFN">about URL</a> annotation for the described <a href="http://w3c.github.io/csvw/syntax/#dfn-column" class="externalDFN">column</a>,.</p>
<p class="note"><code>aboutUrl</code> is typically defined on a <a>schema description</a> or <a>table description</a>. If defined on individual <a title="column description">column descriptions</a>, care must be taken to ensure that transformed cell values maintain a semantic relationship.</p>
</dd>
<dt id="cell-datatype"><code>datatype</code></dt>
<dd>
<p>
An <a>atomic property</a> that contains either a single string that is the main datatype of the values of the cell or a <a>datatype description</a> object. If the value of this property is a string, it MUST be one of the built-in datatypes defined in <a href="#built-in-datatypes" class="sectionRef"></a>; if it is an object then it describes a more specialised datatype. If a cell contains a sequence (ie the <code>separator</code> property is specified and not <code>null</code>) then this property specifies the datatype of each value within that sequence. See <a href="#datatypes"></a> for more details.
</p>
<p>
A value for this property is <a>compatible with</a> an inherited value if they are identical, or if the value is a subtype within the datatype hierarchy defined in <a href="#datatypes" class="sectionRef"></a>, including if the inherited value is explicitly specified as the <a href="#datatype-base"><code>base</code></a> of this value.
</p>
<p>The <a title="normalization">normalized</a> value of this property becomes the <a href="http://w3c.github.io/csvw/syntax/#dfn-column-datatype" class="externalDFN">datatype</a> annotation for the described <a href="http://w3c.github.io/csvw/syntax/#dfn-column" class="externalDFN">column</a>.</p>
<p class="issue" data-number="223">We invite comment on whether <a href="#cell-datatype"><code>datatype</code></a> should allow for a "union" of types for a cell; this would allow for a set of datatypes that could be matched against the <a href="http://w3c.github.io/csvw/syntax/#dfn-cell-string-value" class="externalDFN">string value</a> of a cell, choosing the first match; e.g., to match either a <code>date</code> or <code>datetime</code>.</p>
</dd>
<dt id="cell-default"><code>default</code></dt>
<dd>
<p>
An <a>atomic property</a> holding a single string that is used to create a default <a href="http://w3c.github.io/csvw/syntax/#dfn-cell-value" class="externalDFN">value</a> for the cell in cases where the original <a href="http://w3c.github.io/csvw/syntax/#dfn-cell-string-value" class="externalDFN">string value</a> is an empty string. This default value MAY be used when converting the table into other formats, or when the table is displayed. If not specified, the default for the <code>default</code> property is the empty string, <code>""</code>. A value for this property is <a>compatible with</a> an inherited value only if they are identical. The value of this property becomes the <a href="http://w3c.github.io/csvw/syntax/#dfn-column-default" class="externalDFN">default</a> annotation for the described <a href="http://w3c.github.io/csvw/syntax/#dfn-column" class="externalDFN">column</a>.
An <a>atomic property</a> holding a single string that is used to create a default <a href="http://w3c.github.io/csvw/syntax/#dfn-cell-value" class="externalDFN">value</a> for the cell in cases where the original <a href="http://w3c.github.io/csvw/syntax/#dfn-cell-string-value" class="externalDFN">string value</a> is an empty string. This default value MAY be used when converting the table into other formats, or when the table is displayed. If not specified, the default for the <code>default</code> property is the empty string, <code>""</code>. The value of this property becomes the <a href="http://w3c.github.io/csvw/syntax/#dfn-column-default" class="externalDFN">default</a> annotation for the described <a href="http://w3c.github.io/csvw/syntax/#dfn-column" class="externalDFN">column</a>.
</p>
</dd>
<dt id="cell-language"><code>lang</code></dt>
<dd>
<p>
An <a>atomic property</a> giving a single string language code as defined by [[!BCP47]]. Indicates the language of the value within the cell. A value for this property is <a>compatible with</a> an inherited value if it is a sub-language of the inherited value; for example <code>en-US</code> is compatible with <code>en</code> but not <code>fr</code>. The value of this property becomes the <a href="http://w3c.github.io/csvw/syntax/#dfn-column-lang" class="externalDFN">lang</a> annotation for the described <a href="http://w3c.github.io/csvw/syntax/#dfn-column" class="externalDFN">column</a>.
An <a>atomic property</a> giving a single string language code as defined by [[!BCP47]]. Indicates the language of the value within the cell. The value of this property becomes the <a href="http://w3c.github.io/csvw/syntax/#dfn-column-lang" class="externalDFN">lang</a> annotation for the described <a href="http://w3c.github.io/csvw/syntax/#dfn-column" class="externalDFN">column</a>.
</p>
</dd>
<dt id="cell-null"><code>null</code></dt>
<dd>
<p>
An <a>atomic property</a> giving the string or strings used for null values within the data. If the <a href="http://w3c.github.io/csvw/syntax/#dfn-cell-string-value" class="externalDFN">string value</a> of the cell is equal to any one of these values, the <a href="http://w3c.github.io/csvw/syntax/#dfn-cell-value" class="externalDFN">cell value</a> is <code>null</code>. If not specified, the default for the <code>null</code> property is the empty string. A value for this property is <a>compatible with</a> an inherited value if it is a subset of the inherited value. The value of this property becomes the <a href="http://w3c.github.io/csvw/syntax/#dfn-column-null" class="externalDFN">null</a> annotation for the described <a href="http://w3c.github.io/csvw/syntax/#dfn-column" class="externalDFN">column</a>.
An <a>atomic property</a> giving the string or strings used for null values within the data. If the <a href="http://w3c.github.io/csvw/syntax/#dfn-cell-string-value" class="externalDFN">string value</a> of the cell is equal to any one of these values, the <a href="http://w3c.github.io/csvw/syntax/#dfn-cell-value" class="externalDFN">cell value</a> is <code>null</code>. If not specified, the default for the <code>null</code> property is the empty string. The value of this property becomes the <a href="http://w3c.github.io/csvw/syntax/#dfn-column-null" class="externalDFN">null</a> annotation for the described <a href="http://w3c.github.io/csvw/syntax/#dfn-column" class="externalDFN">column</a>.
</p>
</dd>
<dt id="cell-ordered"><code>ordered</code></dt>
<dd>
<p>A boolean <a>atomic property</a> taking a single value which indicates whether a list that is the value of the cell is ordered (if <code>true</code>) or unordered (if <code>false</code>). The default is <code>false</code>. This property is irrelevant if the <a href="#cell-separator"><code>separator</code></a> is <code>null</code> or undefined, but this is not an error. A value for this property is <a>compatible with</a> an inherited value only if they are identical. The value of this property becomes the <a href="http://w3c.github.io/csvw/syntax/#dfn-column-ordered" class="externalDFN">ordered</a> annotation for the described <a href="http://w3c.github.io/csvw/syntax/#dfn-column" class="externalDFN">column</a>, and the <a href="http://w3c.github.io/csvw/syntax/#dfn-cell-ordered" class="externalDFN">ordered</a> annotation for the described <a href="http://w3c.github.io/csvw/syntax/#dfn-cell" class="externalDFN">cell</a>.</p>
<p>A boolean <a>atomic property</a> taking a single value which indicates whether a list that is the value of the cell is ordered (if <code>true</code>) or unordered (if <code>false</code>). The default is <code>false</code>. This property is irrelevant if the <a href="#cell-separator"><code>separator</code></a> is <code>null</code> or undefined, but this is not an error. The value of this property becomes the <a href="http://w3c.github.io/csvw/syntax/#dfn-column-ordered" class="externalDFN">ordered</a> annotation for the described <a href="http://w3c.github.io/csvw/syntax/#dfn-column" class="externalDFN">column</a>, and the <a href="http://w3c.github.io/csvw/syntax/#dfn-cell-ordered" class="externalDFN">ordered</a> annotation for the described <a href="http://w3c.github.io/csvw/syntax/#dfn-cell" class="externalDFN">cell</a>.</p>
</dd>
<dt id="cell-propertyUrl"><code>propertyUrl</code></dt>
<dd>
<p>An <a>URI template property</a> that MAY be used to create a URI for a property if the table is mapped to another format. There are no <a title="compatible with">compatibility restrictions</a> on this property. The value of this property becomes the <a href="http://w3c.github.io/csvw/syntax/#dfn-column-property-url" class="externalDFN">property URL</a> annotation for the described <a href="http://w3c.github.io/csvw/syntax/#dfn-column" class="externalDFN">column</a>.</p>
<p>An <a>URI template property</a> that MAY be used to create a URI for a property if the table is mapped to another format. The value of this property becomes the <a href="http://w3c.github.io/csvw/syntax/#dfn-column-property-url" class="externalDFN">property URL</a> annotation for the described <a href="http://w3c.github.io/csvw/syntax/#dfn-column" class="externalDFN">column</a>.</p>
<p class="note"><code>propertyUrl</code> is typically defined on a <a title="column description">column description</a>. If defined on a <a>schema description</a>, <a>table description</a> or <a>table group description</a>, care must be taken to ensure that transformed cell values maintain an appropriate semantic relationship, for example by including the <a href="http://w3c.github.io/csvw/syntax/#dfn-column-name" class="externalDFN">name</a> of the column in the generated URL by using <code>_name</code> in the template.</p>
</dd>
<dt id="cell-required"><code>required</code></dt>
<dd>
<p>A boolean <a>atomic property</a> taking a single value which indicates whether the cell must have a non-null value. The default is <code>false</code>. A value for this property is <a>compatible with</a> an inherited value only if they are identical. The value of this property becomes the <a href="http://w3c.github.io/csvw/syntax/#dfn-column-required" class="externalDFN">required</a> annotation for the described <a href="http://w3c.github.io/csvw/syntax/#dfn-column" class="externalDFN">column</a>.</p>
<p>A boolean <a>atomic property</a> taking a single value which indicates whether the cell must have a non-null value. The default is <code>false</code>. The value of this property becomes the <a href="http://w3c.github.io/csvw/syntax/#dfn-column-required" class="externalDFN">required</a> annotation for the described <a href="http://w3c.github.io/csvw/syntax/#dfn-column" class="externalDFN">column</a>.</p>
</dd>
<dt id="cell-separator"><code>separator</code></dt>
<dd>
<p>
An <a>atomic property</a> that MUST have a single string value that is the character used to separate items in the string value of the cell. If <code>null</code> or unspecified, the cell does not contain a list. Otherwise, application MUST split the string value of the cell on the specified separator character and parse each of the resulting strings separately. The cell's value will then be a list. Conversion specifications MUST use the separator to determine the conversion of a cell into the target format. See <cite><a href="http://w3c.github.io/csvw/syntax/#parsing-cells">Parsing Cells</a></cite> in [[!tabular-data-model]] for more details. A value for this property is <a>compatible with</a> an inherited value only if they are identical. The value of this property becomes the <a href="http://w3c.github.io/csvw/syntax/#dfn-column-separator" class="externalDFN">separator</a> annotation for the described <a href="http://w3c.github.io/csvw/syntax/#dfn-column" class="externalDFN">column</a>.
An <a>atomic property</a> that MUST have a single string value that is the character used to separate items in the string value of the cell. If <code>null</code> or unspecified, the cell does not contain a list. Otherwise, application MUST split the string value of the cell on the specified separator character and parse each of the resulting strings separately. The cell's value will then be a list. Conversion specifications MUST use the separator to determine the conversion of a cell into the target format. See <cite><a href="http://w3c.github.io/csvw/syntax/#parsing-cells">Parsing Cells</a></cite> in [[!tabular-data-model]] for more details. The value of this property becomes the <a href="http://w3c.github.io/csvw/syntax/#dfn-column-separator" class="externalDFN">separator</a> annotation for the described <a href="http://w3c.github.io/csvw/syntax/#dfn-column" class="externalDFN">column</a>.
</p>
</dd>
<dt id="cell-textDirection"><code>textDirection</code></dt>
<dd>
<p>
An <a>atomic property</a> that MUST have a single string value that is one of <code>"rtl"</code> or <code>"ltr"</code> (the default). Indicates whether the text within cells should be displayed by default as left-to-right or right-to-left text. The value of this property becomes the <a href="http://w3c.github.io/csvw/syntax/#dfn-column-text-direction" class="externalDFN">text direction</a> annotation for the <a href="http://w3c.github.io/csvw/syntax/#dfn-column" class="externalDFN">column</a>. A value for this property is <a>compatible with</a> an inherited value only if they are identical. See <cite><a href="http://w3c.github.io/csvw/syntax/index.html#bidirectional-tables">Bidirectional Tables</a></cite> in [[!tabular-data-model]] for details.
An <a>atomic property</a> that MUST have a single string value that is one of <code>"rtl"</code> or <code>"ltr"</code> (the default). Indicates whether the text within cells should be displayed by default as left-to-right or right-to-left text. The value of this property becomes the <a href="http://w3c.github.io/csvw/syntax/#dfn-column-text-direction" class="externalDFN">text direction</a> annotation for the <a href="http://w3c.github.io/csvw/syntax/#dfn-column" class="externalDFN">column</a>. See <cite><a href="http://w3c.github.io/csvw/syntax/index.html#bidirectional-tables">Bidirectional Tables</a></cite> in [[!tabular-data-model]] for details.
</p>
</dd>
<dt id="cell-valueUrl"><code>valueUrl</code></dt>
<dd>
<p>An <a>URI template property</a> that is used to map the values to the cells into URLs. See <cite><a href="http://w3c.github.io/csvw/syntax/#parsing-cells">Parsing Cells</a></cite> in [[!tabular-data-model]] for details. There are no <a title="compatible with">compatibility restrictions</a> on this property. The value of this property becomes the <a href="http://w3c.github.io/csvw/syntax/#dfn-column-value-url" class="externalDFN">value URL</a> annotation for the described <a href="http://w3c.github.io/csvw/syntax/#dfn-column" class="externalDFN">column</a>.</p>
<p>An <a>URI template property</a> that is used to map the values to the cells into URLs. See <cite><a href="http://w3c.github.io/csvw/syntax/#parsing-cells">Parsing Cells</a></cite> in [[!tabular-data-model]] for details. The value of this property becomes the <a href="http://w3c.github.io/csvw/syntax/#dfn-column-value-url" class="externalDFN">value URL</a> annotation for the described <a href="http://w3c.github.io/csvw/syntax/#dfn-column" class="externalDFN">column</a>.</p>
<p class="note">
This allows a <a href="http://w3c.github.io/csvw/syntax/#dfn-cell-value" class="externalDFN">cell value</a> to define one or more RDF <cite><a href="http://www.w3.org/TR/rdf11-concepts/#dfn-resource">resources</a></cite> value of a cell instead of a literal values, as defined in [[rdf-concepts]]. For example, if the value were <code>"{#reference}"</code>, each cell value of a column named <em>reference</em> would be used to create a URI such as <code>http://example.com/#1234</code>, if <code>1234</code> were a cell value of that column.</p>
<p class="note"><code>valueUrl</code> is typically defined on a <a title="column description">column description</a>. If defined on a <a>schema description</a>, <a>table description</a> or <a>table group description</a>, care must be taken to ensure that transformed cell values maintain an appropriate semantic relationship.</p>
Expand Down