Skip to content

Commit

Permalink
Merge pull request #287 from digital-land/content/lenient-field-naming
Browse files Browse the repository at this point in the history
Add guidance on the field names we accept
  • Loading branch information
stevenjmesser authored Aug 14, 2024
2 parents 7b9b72d + e53f994 commit dd4612a
Show file tree
Hide file tree
Showing 4 changed files with 63 additions and 16 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,19 @@ You can provide data in one of these formats:

These may be uploaded to a single URL, or served via an OGC WFS or ArcGIS API.

Field names
-----------

You can provide fields names using hyphens, underscores or spaces.

For example:

- `start-date`
- `start_date`
- `start date`

These are all valid, and any uppercase characters will be converted to lowercase.

---

## Article 4 direction dataset
Expand Down Expand Up @@ -64,7 +77,7 @@ Example: `http://www.LPAwebsite.org.uk/article4direction1.pdf`

The URL of the webpage on your website that introduces the document.

Each document should be linked to from a documentation webpage that includes a short description of the data and the document you’re linking to. Each article 4 direction should have a unique URL. This means you can create a separate page for each one, or you could list several on one page. If you do that, there must be a separate anchor link (fragment identifier) for each one.
Each document should be linked to from a documentation webpage that includes a short description of the data and the document you’re linking to. Each article 4 direction should have a unique URL. This means you can create a separate page for each one, or you could list several on one page. If you do that, there must be a separate anchor link (fragment identifier) for each one.

This means each section of your page should have its own URL. Most publishing systems will allow you to use a hashtag to create the identifiers for each article 4 direction you list - as in the examples shown.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ There are 2 datasets you must provide for conservation area data:

* [conservation area dataset](https://www.planning.data.gov.uk/guidance/specifications/conservation-area#conservation-area-dataset)
* [conservation area document dataset](https://www.planning.data.gov.uk/guidance/specifications/conservation-area#conservation-area-documents-dataset)

## Format

You can provide data in one of these formats:
Expand All @@ -11,9 +11,21 @@ You can provide data in one of these formats:
* GeoJSON
* GML
* Geopackage

These may be uploaded to a single URL, or served via an OGC WFS or ArcGIS API.

## Field names

You can provide fields names using hyphens, underscores or spaces.

For example:

* `start-date`
* `start_date`
* `start date`

These are all valid, and any uppercase characters will be converted to lowercase.

## Conservation area dataset

This dataset is about conservation areas. These are areas of special architectural or historic interest with a character or appearance that must be preserved or enhanced.
Expand Down Expand Up @@ -50,7 +62,7 @@ If you’re providing geometry in a GeoJSON, GML or Geopackage, use the associat

The date that the conservation area was officially designated, written in YYYY-MM-DD format.

Example:
Example:

`1984-03-28`

Expand Down Expand Up @@ -78,7 +90,7 @@ Examples:
One conservation area per page:
`http://www.LPAwebsite.org.uk/data/conservationareas/smithroad`

More than one conservation area per page with an anchor link for each one:
More than one conservation area per page with an anchor link for each one:

`http://www.LPAwebsite.org.uk/data/conservationareas#smithroad`

Expand All @@ -99,11 +111,11 @@ If the entity has never been updated, enter the same date as start-date.

Write in YYYY-MM-DD format.

Example:
Example:

`2022-12-20`

With dates, some data is better than no data, so:
With dates, some data is better than no data, so:

* `2022` is fine
* `2022-12` is better
Expand All @@ -113,7 +125,7 @@ With dates, some data is better than no data, so:

The date the validity of the record starts, written in YYYY-MM-DD format. Usually, this will be the same as the designation date. If anything about the conservation area has changed, for example, the boundary, it should be the date of that change.

Example:
Example:

`1984-04-25`

Expand All @@ -127,7 +139,7 @@ With dates, some data is better than no data, so:

Where the conservation area is no longer valid, this should be the date that it was no longer in effect, written in YYYY-MM-DD format. If this does not apply, leave the cell blank.

Example:
Example:

`1999-01-20`

Expand All @@ -151,7 +163,7 @@ These documents are the authoritative source and provide the context around the
* notices of conservation area designations
* management plans
* gazette entries

Don’t worry if you don’t have all the data we’ve asked for available right now. If you give us what you’ve got, we can help you fill in the gaps later.

A complete record should contain the following fields (columns):
Expand All @@ -162,7 +174,7 @@ A reference or ID for each document that is:

* unique within your dataset
* permanent - it doesn't change when the dataset is updated

If you don't use a reference already, you will need to create one. This can be a short set of letters or numbers.

Example: `CADOC01`
Expand Down Expand Up @@ -212,7 +224,7 @@ If the entity has never been updated, enter the same date as start-date.

Write in YYYY-MM-DD format.

Example:
Example:

`1984-03-28`

Expand All @@ -226,7 +238,7 @@ With dates, some data is better than no data, so:

The date the document was published, written in YYYY-MM-DD format.

Example:
Example:

`1984-03-28`

Expand All @@ -240,7 +252,7 @@ With dates, some data is better than no data, so:

The date the document was withdrawn or superseded by another document, written in YYYY-MM-DD format. Leave this blank if the document is still relevant to planning.

Example:
Example:

`1984-03-28`

Expand All @@ -249,5 +261,3 @@ With dates, some data is better than no data, so:
* `1984` is fine
* `1984-03` is better
* `1984-03-28` is brilliant


Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,18 @@ You can provide data in one of these formats:

These may be uploaded to a single URL, or served via an OGC WFS or ArcGIS API.

## Field names

You can provide fields names using hyphens, underscores or spaces.

For example:

* `start-date`
* `start_date`
* `start date`

These are all valid, and any uppercase characters will be converted to lowercase.

Listed buildings outline dataset
------------------------

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,18 @@ You can provide the zone and individual tree data in one of these formats:

These may be uploaded to a single URL, or served via an OGC WFS or ArcGIS API.

## Field names

You can provide fields names using hyphens, underscores or spaces.

For example:

* `start-date`
* `start_date`
* `start date`

These are all valid, and any uppercase characters will be converted to lowercase.

Tree preservation order dataset
-------------------------------

Expand Down

0 comments on commit dd4612a

Please sign in to comment.