Skip to content

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

Open
@penyuan

Description

@penyuan

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

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions