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

Add to file type information reported by the dashboard's backend #94

Open
penyuan opened this issue Mar 21, 2022 · 1 comment
Open

Add to file type information reported by the dashboard's backend #94

penyuan opened this issue Mar 21, 2022 · 1 comment
Assignees
Labels
enhancement New feature or request

Comments

@penyuan
Copy link
Contributor

penyuan commented Mar 21, 2022

After talking to @moedn, we can implement reporting by the dashboard for each file its open/proprietary, encoding (binary/text), and source/export. See this GitLab repository for a current implementation, which is to be used in the OSEG's OSH project linting tool.

According to @moedn's email 2022-03-14:

I'm afraid, there's no documentation available yet since we it yet only
for internal use

'source' means that the file format provides a lossless source of
information about the design. I guess it would be more clear to say
'native' than 'source'
'export' comes from converting source files into suitable exchange
formats (e.g. STP or PDF). However, these conversions are lossy

the distinction between open and proprietary is meant to provide an
indicator 1) whether there's FOSS available to modify those files and 2)
for the probability that this file format is accepted by other software
(e.g. it's unlikely that proprietary native files could be losslessly
modified with a software from another brand).
'open' means that anyone would be theoretically enabled to read & write
those files. this is the case for standardized formats (e.g. STP, PDF),
open specifications and (usually) all text-based file formats. We used
Wikipedia as a reference for the openness of a file format

'encoding' just whether the information is stored as plain text or in
binary form. it makes no assumption about e.g. the human-readability of
resulting files – e.g. SVG is text-based, but no one would ever
manipulate a SVG file in a text editor. this property is meant to
indicate the git-compatibility of the file format

@penyuan penyuan added the enhancement New feature or request label Mar 21, 2022
@penyuan penyuan self-assigned this Mar 21, 2022
@penyuan
Copy link
Contributor Author

penyuan commented Apr 15, 2022

Relevant article: Recommended File Formats for Sharing CAD Designs. It categorizes different CAD file types and explain their functions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant