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

Compare with Wikibase tabular data model #1059

Merged
merged 5 commits into from
Dec 17, 2024
Merged

Conversation

nichtich
Copy link
Contributor

@nichtich nichtich commented Dec 9, 2024

fixes #990

Copy link
Member

@peterdesmet peterdesmet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good comparison. Cf. CSVW https://datapackage.org/guides/csvw-data-package/ I would write it a bit more from the viewpoint of someone that is familiar with MediaWiki Tabular Data (and discovers Data Package). Tables could then have 3 columns:

  • MediaWiki property I'm familiar with
  • Is it supported in Data Package
  • Details on how it is supported in Data Package

We could also do it differently (and update CSVW), but I would prefer to align how we write comparison guides.

content/docs/guides/mediawiki-tabular-data.md Outdated Show resolved Hide resolved
content/docs/guides/mediawiki-tabular-data.md Outdated Show resolved Hide resolved
content/docs/guides/mediawiki-tabular-data.md Outdated Show resolved Hide resolved

MediaWiki Tabular data has three required and two optional top-level fields. Most of these fields map to corresponding fields of a Data Resource:

Field | Data Resource | Tabular data
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://datapackage.org/guides/csvw-data-package/#columns compares properties for users that know CSVW, but want to know if it is supported in Data Package. I wonder if the same approach would make sense here? It would allow to combine the table with the differences.

For example (see source for markdown):

MediaWiki Tabular Data property Data Package support Details
name (implied from page)* Yes As resource.name
description Yes As resource.description, but without support for localized strings
data* Yes MediaWiki always requires an array of arrays, while Data Package supports other formats as well as data files referred to by path
license Yes As resource.licenses with a name (e.g. CC0-1.0)
schema* Yes As resource.schema, see further
sources Yes As resource.sources, but without support for Wiki markup

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If possible, I would also link the MediaWiki Tabular Data property

content/docs/guides/mediawiki-tabular-data.md Outdated Show resolved Hide resolved
content/docs/guides/mediawiki-tabular-data.md Outdated Show resolved Hide resolved
content/docs/guides/mediawiki-tabular-data.md Outdated Show resolved Hide resolved
content/docs/guides/mediawiki-tabular-data.md Outdated Show resolved Hide resolved
content/docs/guides/mediawiki-tabular-data.md Outdated Show resolved Hide resolved
@nichtich
Copy link
Contributor Author

Thanks, I'll adjust the commit but try to make it usable for both familiar with MediaWiki and Data Package, so there is no "supported yes or no".

@nichtich nichtich force-pushed the main branch 2 times, most recently from 972b437 to 272afc1 Compare December 13, 2024 06:59
Copy link
Member

@peterdesmet peterdesmet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Some minor comments on formats + typo corrections

content/docs/guides/mediawiki-tabular-data.md Outdated Show resolved Hide resolved
content/docs/guides/mediawiki-tabular-data.md Show resolved Hide resolved
content/docs/guides/mediawiki-tabular-data.md Outdated Show resolved Hide resolved
content/docs/guides/mediawiki-tabular-data.md Show resolved Hide resolved
content/docs/guides/mediawiki-tabular-data.md Outdated Show resolved Hide resolved
content/docs/guides/mediawiki-tabular-data.md Outdated Show resolved Hide resolved
content/docs/guides/mediawiki-tabular-data.md Show resolved Hide resolved
nichtich and others added 4 commits December 17, 2024 06:44
Co-authored-by: Peter Desmet <peter.desmet.work@gmail.com>
Co-authored-by: Peter Desmet <peter.desmet.work@gmail.com>
Co-authored-by: Peter Desmet <peter.desmet.work@gmail.com>
Co-authored-by: Peter Desmet <peter.desmet.work@gmail.com>
@peterdesmet peterdesmet self-requested a review December 17, 2024 08:21
@roll
Copy link
Member

roll commented Dec 17, 2024

Amazing work! Is it ready to merge?

@peterdesmet
Copy link
Member

Ok for me to merge!

@roll roll merged commit de8cd2e into frictionlessdata:main Dec 17, 2024
1 check failed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Compare with Wikibase tabular data model
3 participants