specs icon indicating copy to clipboard operation
specs copied to clipboard

Add more linkable headings to the Table Schema spec

Open roll opened this issue 1 year ago • 3 comments

Overview

In v2 we have improved ability to link individual sections of the spec (https://datapackage.org/specifications/table-schema/) but some heading are still missing e.g. for field properties like decimalChar etc (the list needs to be collected first)

roll avatar May 07 '24 06:05 roll

I would also suggest to hardcode some of the anchors, rather than auto-generating them. For example:

Not: https://datapackage.org/specifications/table-schema/#fields-required Bug: https://datapackage.org/specifications/table-schema/#fields

Not: https://datapackage.org/specifications/table-schema/#schema-1 But: https://datapackage.org/specifications/table-schema/#dollar-schema

peterdesmet avatar May 07 '24 07:05 peterdesmet

Here's an overview of anchors I found that should be hardcoded imo:

  • [ ] https://datapackage.org/specifications/data-package/#resources-required -> resources
  • [ ] https://datapackage.org/specifications/data-package/#schema -> dollar-schema
  • [ ] https://datapackage.org/specifications/data-resource/#name-required -> name
  • [ ] https://datapackage.org/specifications/data-resource/#path-or-data-required -> path-or-data
  • [ ] https://datapackage.org/specifications/data-resource/#schema -> dollar-schema
  • [ ] https://datapackage.org/specifications/data-resource/#path-or-data-required-1 -> tabular-path-or-data
  • [ ] https://datapackage.org/specifications/data-resource/#schema-1 -> schema (will be automatic once dollar-schema is there?)
  • [ ] https://datapackage.org/specifications/table-dialect/#schema -> dollar-schema
  • [ ] https://datapackage.org/specifications/table-schema/#fields-required -> fields
  • [ ] https://datapackage.org/specifications/table-schema/#schema-1 -> dollar-schema
  • [ ] https://datapackage.org/specifications/table-schema/#name-required -> name

peterdesmet avatar Jun 20 '24 13:06 peterdesmet

Note that it is fairly urgent to update these anchors, since implementations (such as frictionless-r) will reference these.

peterdesmet avatar Jun 20 '24 13:06 peterdesmet