Feedback frontend detail page, order and display of properties

[jdittrich]

This is a review of the frontend detail page based on the OHLOOM, which seems to be our most richly populated item.

• [x] Put the functional description and the image to the top, I guess this is most relevant when calling up details, particularly because we can't put either in the table of results on the overview before.
• [ ] For the order of the properties I would suggest Functional Description/Image/Related URLS/Data Source/Owner/License/Designed parts/[rest]
• [x] License property should be linked if URL , ideally it also would have a non-URL name to the license (here, Creative Commons BY-SA-4.1)
• [x] Let’s spell out TsDC to Technology-specific Documentation Criteria (TsDC)
• [ ] What does the timestamp mean? Last change? Creation of the instructions? Creation of the item in our database? If we know that we can get it a better label
• [x] I don't know if we parse that but it would be much nicer if we could put cube(size = [400,350,150] as length: 400mm, width: 350mm, height: 150mm (or however else these map to the dimensions; thus we would also get rid of the "cube", since the shape defined seems to be actually a cuboid or just a (bounding) box) If there is an accompanying sphere type, it could be rendered as diameter:1234mm
• [x] Could we move the buttons "Download Bundle" and "To… repo" next to each other? (Download bundle could in larger screen sizes next to To…repo; otherwise they would be vertically next to each other – or we just go with vertically next to each other for all screen sizes.

[jdittrich]

@moedn , could you help us with the meaning of the timestamp and mapping of the values in cube(size = [400,350,150]) to width/length/height?

[moedn]

sure:

• timestamp is the timestamp of the commit this version of the OSH refers to. In this case, v1.0.0 is the tag for the commit 834222370f34ad2a07d0e41d09eb54378573b8c3 which was done on 27.7.2021
• cube(size = …) is a OpenSCAD primitive;
  • all outerDimensions are defined as OpenSCAD primitives
  • find the documentation here
  • there's no standard orientation of parts defined. width/length/height can be any of those values since one can rotate the part

[moedn]

My comment on the detail page:

• download button works, super cool!
• would be nice to move essentials (image, functional description,version, license, licensor, organisation) to the top of the page
• substitute Related URLs with Linked Files or something like that ('related URLs' sounds like 'further information', but those should be essential files)
• split licensor from organisation → 2 distinct fields
• can we display the full designation of the CPC patent class in brackets behind the ID (and link it to CPC)? like that:\ D03D 35/00 (Smallware looms, i.e. looms for weaving ribbons or other narrow fabrics)\ [D03D 35/00](https://worldwide.espacenet.com/patent/cpc-browser#!/CPC=D03D35/00) (Smallware looms, i.e. looms for weaving ribbons or other narrow fabrics)
  • CPC information is also available as linked open data (see https://data.epo.org/linked-data/def/patent/ ; the CPC Patent Class value is linked to classificationIPCInventive on their side (see ontology for detials))

[botoxparty]

• The item that we preview on the detail page has a URL for its spdxLicense value, in the CSV you provided they are not URLs, is this an error in the data on this item? What can i expect?
• The designation of the CPC class can be retrieved using the Linked open EP data API, however in this example the patent class is identified as D03D 35/00 whereas the API identifies it as D03D35-00 (see this API request), is it expected that all patent classes will follow a certain format that can be parsed to retrieve the full designation from the API?
• Is it possible to provide samples of the other OpenSCAD primitives and the expected outputs once they are parsed?

[moedn]

• SPDX: the items dissolve in RDF; we use SPDX license IDs only, including the CSV. so the last part of the URL is the same SPDX ID that you can find in the CSV
• CPC: presumingly yes, but I haven't looked into the CPC API specification
• OpenSCAD primitives: as from the documentation:
  • cube([18,18,18])
  • sphere(r = 1)
  • cylinder(h=15, r=10)

[botoxparty]

• The SPDX items don't all resolve as URLs, why does this one test item (Q438) return a URL?

• Ok i will make the assumption that all spaces should be removed and forward slashes converted to -.

[botoxparty]

@jdittrich How should those OpenSCAD primitives translate when parsed to a string?

[jdittrich]

@jdittrich How should those OpenSCAD primitives translate when parsed to a string?

cube([10,31,40]) → Outer Dimensions: 10mm×31mm×40mm sphere(r = 150) → Outer Dimensions: 15mm radius cylinder(h=15, r=10) → Outer Dimensions: 15mm height, 10mm radius.

For the cube, please use the × (multiplication sign) not the x

[moedn]

sorry for the late reply; I'm at a seminar since yesterday and there wasn't much internet access surprisingly…

regarding SPDX:

• not sure why other examples don't resolve to URLs. Do you have an example? Are they all e.g. from Wikifactory? then it could be that there's a bug in the RDF creation of those files. In principle, it should be an URL

regarding CPC: :ok_hand: :)

[botoxparty]

For an example of the SPDX issue, you can see the raw values for the spdxLicense field are rendered in the table on the test site:

You can find the OHLOOM on page 6.

---

I have updated the design to match the latest mock in Figma, mixed with some of the feedback about the order of the items.

I am off this project for the next week, when I return i'll be implementing the rest of the feedback regarding UI/UX as well as implementing a solution for the filtering and sorting.

In the mean time, it would be helpful if you would do review and finalise any feedback of the latest implementation (see OHLOOM here, verify some other items that aren't populated with as much data)

Download Bundle button With repositories hosted on Appropedia, I can't seem to find any download link to generate for the 'Download Bundle' button. Should this button appear on appropedia imported items?

[jdittrich]

• [ ] Could we move "Download Bundle" and "To… repo" next to each other? (Download bundle could in larger screen sizes next to To…repo; otherwise they would be vertically next to each other – or we just go with vertically next to each other for all screen sizes.

[moedn]

For an example of the SPDX issue, you can see the raw values for the spdxLicense field are rendered in the table on the test site:

You can find the OHLOOM on page 6.

Alright, thanks! Seems like there's a bug in the Crawler. Reported it and asked for a fix.

In the mean time, it would be helpful if you would do review and finalise any feedback of the latest implementation (see OHLOOM here, verify some other items that aren't populated with as much data)

• looks neat, thanks! :ok_hand:
• the Documentation Readiness Level seems to link to the wrong comment
  • ODRL-5 should link to the rdfs:comment of ODRL-5 (mature release), instead it seems to link to OTRL-5

Download Bundle button With repositories hosted on Appropedia, I can't seem to find any download link to generate for the 'Download Bundle' button. Should this button appear on appropedia imported items?

Good point. Appropedia changed it's structure a couple of weeks ago, so we're having trouble getting their data. I'm in exchange with their head to fix this. Not sure if we will get downloadable files TBH\ Suggestion: Can we gray out the Download Bundle button for projects with no downloadable files available?

--

another point:

• [ ] The entries under Designed parts should link to an own detail page of that part. That detail page would look almost exactly like this project detail page. The clamp ring gives a good example of which sort of data is expected for parts

[jdittrich]

Suggestion: Can we gray out the Download Bundle button for projects with no downloadable files available?

Or just don't have it, as the user can't change anything about this

[moedn]

whatever fits best from the UX perspective :)

[ckawohl-wmde]

This hasn't been touched in months. I will close it.