W3C home > Mailing lists > Public > public-sdwig@w3.org > May 2021

[sdw] Merged Pull Request: Update SDWBP based on new version of DCAT

From: Linda van den Brink via GitHub <sysbot+gh@w3.org>
Date: Tue, 18 May 2021 14:35:27 +0000
To: public-sdwig@w3.org
Message-ID: <pull_request.closed-574498098-1621348525-sysbot+gh@w3.org>
lvdbrink has just merged andrea-perego's pull request 1247 for https://github.com/w3c/sdw:

== Update SDWBP based on new version of DCAT ==
Revision prepared as discussed during the last SDW call: https://www.w3.org/2021/02/04-sdw-minutes.html

Relevant issue: https://github.com/w3c/sdw/issues/1084

Preview: https://raw.githack.com/w3c/sdw/bp-issue-1084/bp/index.html

Diff: https://services.w3.org/htmldiff?doc1=https%3A%2F%2Fw3c.github.io%2Fsdw%2Fbp%2F&doc2=https%3A%2F%2Fraw.githack.com%2Fw3c%2Fsdw%2Fbp-issue-1084%2Fbp%2Findex.html

NB: All revisions are explained in the HTML via EDNOTEs and in CSS and JavaScript code with comments.

Summary of revisions:

The BPs has been updated based on the new version of [DCAT](https://www.w3.org/TR/vocab-dcat-2/) and [GeoDCAT-AP](https://semiceu.github.io/GeoDCAT-AP/releases/), which include a more extended support for the description of spatial / temporal aspects - in particular, for the specification of bounding boxes, centroids, spatial and temporal resolution (see summary in https://lists.w3.org/Archives/Public/public-sdwig/2019Jul/0000.html). 

The implemented revisions concern the following parts of the BP document:
- [Example 15](https://raw.githack.com/w3c/sdw/bp-issue-1084/bp/index.html#ex-geodcat-ap-bag-addresses) in BP5
- [Example 21](https://raw.githack.com/w3c/sdw/bp-issue-1084/bp/index.html#ex-anne-frank-building-centroid-and-bbox) in BP6
- Small revision in [BP13](https://raw.githack.com/w3c/sdw/bp-issue-1084/bp/index.html#spatial-info-dataset-metadata)'s "Possible Approach to Implementation"
- [Example 55](https://raw.githack.com/w3c/sdw/bp-issue-1084/bp/index.html#ex-geodcat-ap-dataset-spatial-representation-type) in BP13
- [Example 59](https://raw.githack.com/w3c/sdw/bp-issue-1084/bp/index.html#ex-dqv-dataset-quality) in BP14
- Text and examples added after [Example 59](https://raw.githack.com/w3c/sdw/bp-issue-1084/bp/index.html#ex-dqv-dataset-quality)
- Added column for DCAT in [the 2nd table](https://raw.githack.com/w3c/sdw/bp-issue-1084/bp/index.html#table-vocabs-matrix) in [┬žA. Applicability of common formats to implementation of best practices](https://raw.githack.com/w3c/sdw/bp-issue-1084/bp/index.html#applicability-formatVbp)

More details are documented in [the changelog](https://raw.githack.com/w3c/sdw/bp-issue-1084/bp/index.html#changes-since-20170928).

Additional revisions (mainly editorial) include the following:
- Updated the relevant examples to use the [QUDT Units Vocabulary](http://www.qudt.org/doc/DOC_VOCAB-UNITS.html) for the specification of units of measure instead of [OM 1.8](http://www.wurvoc.org/vocabularies/om-1.8/Unit_of_measure) (used in the SDWBP NOTE)
- Added link to BP-related GitHub issues
- Added `@id` to two examples to address issue https://github.com/w3c/sdw/issues/1037
- Revised bib references based on those now available in SpecRef
- Fixed typos.
- Editorial fixes, to ensure markup consistency.
- Changed order of entries in the changelog, to list first the most recent changes
- Added [new entry](https://raw.githack.com/w3c/sdw/bp-issue-1084/bp/index.html#changes-since-20170928) in changelog to summarise changes after the SDWBP NOTE

Finally, some fixes have been done based on the warnings raised by ReSpec:
- Switched to `respec-w3c`, as [`respec-w3c-common` is now deprecated](https://github.com/w3c/respec/wiki/respec-w3c-common-migration-guide).
- Fixed some issues raised by the new version of ReSpec - in particular, bib references specified with `@href` instead of using double square brackets.
- Revised CSS to avoid conflicts and unintended formatting results, following updates on ReSpec (including BPs, figures, tables).
- Revised script to cross-ref best practices, as ReSpec no longer supports jQuery (which was used in the original script). I also opened an issue to suggest providing native support in ReSpec for BP cross-referencing - see https://github.com/w3c/respec/issues/3279

There are still some open editorial issues following updates to ReSpec:
- ReSpec still returns a warning, saying: "Document uses RFC2119 keywords but lacks a conformance section. Please add a &lt;section id="conformance"&gt;.". So either the RFC2119 keywords are made lowercase, or a conformance section should be included.
- The OGC logo is misplaced - I reported the problem in https://github.com/w3c/respec/issues/3280
- There's a ReSpec bug in the BP summary, resulting in the duplication of the section heading - problem reported in https://github.com/w3c/respec/issues/3278
- [The current ReSpec markup and styling for BPs](https://respec.org/docs/#best-practice-documents) is, IMO, not optimal, and it causes some strange formatting results in the SDWBP, where the `SECTION` element is used for sections "Why", "Intended Outcome", etc.

See https://github.com/w3c/sdw/pull/1247


-- 
Sent via github-notify-ml as configured in https://github.com/w3c/github-notify-ml-config
Received on Tuesday, 18 May 2021 14:35:42 UTC

This archive was generated by hypermail 2.4.0 : Tuesday, 18 May 2021 14:36:05 UTC