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

Improve definition of property "encodingFormat" (vs "fileFormat") #1155

Closed
tfrancart opened this issue May 11, 2016 · 7 comments
Closed

Improve definition of property "encodingFormat" (vs "fileFormat") #1155

tfrancart opened this issue May 11, 2016 · 7 comments

Comments

@tfrancart
Copy link
Contributor

@tfrancart tfrancart commented May 11, 2016

Current definition of encodingFormat on schema:MediaObject : "mp3, mpeg4, etc."

Proposal :
"The encoding of the media object. A good practice is to use mime types codes listed at www.iana.org/assignments/media-types/media-types.xhtml, such as "audio/mpeg", "video/ogg", etc."

@vholland
Copy link
Contributor

@vholland vholland commented May 11, 2016

+1

@sballesteros
Copy link

@sballesteros sballesteros commented May 11, 2016

It may be good to clarify the difference with http://schema.org/fileFormat that explicitly asks for the MIME type.

@tfrancart
Copy link
Contributor Author

@tfrancart tfrancart commented May 11, 2016

Seems like encodingFormat is a duplicate of fileFormat ?

@danbri danbri changed the title Improve definition of property "encodingFormat" Improve definition of property "encodingFormat" (vs "fileFormat") Apr 11, 2018
@danbri
Copy link
Contributor

@danbri danbri commented Apr 11, 2018

Coming to this late, but yeah - it seems both properties are in use in much the same way. The "fileFormat" property always had a weird name in that HTTP-streamed content is generally not thought of as "files".

I suggest we converge them, by making encodingFormat the preferred term, and indicating fileFormat as supersededBy encodingFormat.

We would need to converge the textual definitions, and also

  • allow encodingFormat on CreativeWork, not just MediaObject
  • allow encodingFormat to take both Text and URL values; we allowed URLs to support scientific file formats on Dataset distributions i.e. DataDownload, when the format is well known and documented but doesn't have an IANA media type, see #1191.
  • we will need some wording to explain possible confusion around the "encoding" property, which relates the vaguer kinds of CreativeWork (like a Book or blog post) to specific digital representations e.g. particular ebook formats.
  • will also need to scan through our examples and update accordingly (see below)

@rvguha - does this make sense to you?

Examples that mention fileFormat

-bash-3.2$ find . -name \*examples.txt -exec grep -Hn fileFormat {} \;
./examples.txt:8857:TYPES: accessibilityFeature, accessibilityHazard, fileFormat
./examples.txt:8869: <meta itemprop="fileFormat" content="image/png">
./examples.txt:8880: <meta property="fileFormat" content="image/png">
./examples.txt:8889:TYPES: fileFormat, accessibilityHazard, accessibilityFeature, accessibilityControl, accessibilityAPI
./examples.txt:8902:   <meta itemprop="fileFormat" content="text/html"/>
./examples.txt:8903:   <meta itemprop="fileFormat" content="image/png"/>
./examples.txt:8904:   <meta itemprop="fileFormat" content="text/css"/>
./examples.txt:8905:   <meta itemprop="fileFormat" content="text/javascript"/>
./examples.txt:8923:   <meta property="fileFormat" content="text/html"/>
./examples.txt:8924:   <meta property="fileFormat" content="image/png"/>
./examples.txt:8925:   <meta property="fileFormat" content="text/css"/>
./examples.txt:8926:   <meta property="fileFormat" content="text/javascript"/>
./examples.txt:8948: "fileFormat" : [
danbri added a commit that referenced this issue Apr 26, 2018
We are converging these two properties. There is nothing wrong
with continuing to use fileFormat, but there is a gentle nudge towards
encodingFormat as the preferred term.
danbri added a commit that referenced this issue Apr 26, 2018
fileFormat to indicate it has been supersededBy encodingFormat.

/cc #1155
danbri added a commit that referenced this issue Apr 26, 2018
Updated definition to give a real example plus MDN link.
/cc #1155
@danbri
Copy link
Contributor

@danbri danbri commented Apr 26, 2018

Ok I have implemented this change, queued for review at http://webschemas.org/encodingFormat and http://webschemas.org/fileFormat . The phrasing is still a bit awkward, but we've effectively moved the definitions from fileFormat over to be the new preferred term encodingFormat. I've updated the examples to match, including changing values to be MIME style where needed.

@github-actions
Copy link

@github-actions github-actions bot commented Aug 31, 2020

This issue is being tagged as Stale due to inactivity.

@danbri
Copy link
Contributor

@danbri danbri commented Aug 31, 2020

We did it!

@danbri danbri closed this Aug 31, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
4 participants
You can’t perform that action at this time.