Cura 5555 ufp specification #12
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Changed style of the text.
ChrisTerBeke
suggested changes
Aug 24, 2018
docs/ufp.md
Outdated
| @@ -0,0 +1,25 @@ | |||
| Ultimaker Format Package (UFP) | |||
There was a problem hiding this comment.
It's cleaner to use the # annotation for headers (# = h1, ## = h2, etc).
docs/ufp.md
Outdated
| Ultimaker Format Package (UFP) | ||
| ============ | ||
|
|
||
| Purpose: |
docs/ufp.md
Outdated
| -------- | ||
| The goal of this file type is to provide required data for the 3D printer to perform a print job. | ||
|
|
||
| Structure: |
docs/ufp.md
Outdated
|
|
||
| Structure: | ||
| -------- | ||
| A UFP file contains the following files:</br> |
There was a problem hiding this comment.
In Markdown you can use the following format for a list:
- item 1
- item 2
- item 3
- subitem
docs/ufp.md
Outdated
| - The thumbnail.png is a medium sized rendering of the 3D shape to show during file selection. There can be only one thumbnail. | ||
| - The model.gcode describes how a 3D printer should print a job. | ||
| - Possible content of Cura folder :</br> | ||
| *.xml.fdm_material – files describe materials specifications which might be needed for a print job. |
There was a problem hiding this comment.
Subitem instead of hardcodes spaces.
docs/ufp.md
Outdated
|
|
||
| Notes: | ||
| ------------- | ||
| - For the interchange of files between the Slicer and Printers, currently, ASCII GCODE files are used, in a specific Ultimaker flavor. |
There was a problem hiding this comment.
You can use > to make a nice indented 'quote' annotation for stuff like this.
ChrisTerBeke
suggested changes
Aug 27, 2018
docs/ufp.md
Outdated
| @@ -1,25 +1,30 @@ | |||
| Ultimaker Format Package (UFP) | |||
| ============ | |||
| <h1>Ultimaker Format Package (UFP)</h1> | |||
There was a problem hiding this comment.
:(
I meant Use '#' for h1, '##' for h2, etc.
docs/ufp.md
Outdated
| </ul> | ||
|
|
||
| <h3>Notes:</h3> | ||
|
|
There was a problem hiding this comment.
Just use this:
- item 1
- item 2
etc.
Changed the format "ufp.md" CURA-5555
ChrisTerBeke
suggested changes
Aug 28, 2018
docs/ufp.md
Outdated
| ## Structure: | ||
|
|
||
| A UFP file contains the following files:</br> | ||
| `\.rels`</br> |
docs/ufp.md
Outdated
|
|
||
| ## Structure: | ||
|
|
||
| A UFP file contains the following files:</br> |
There was a problem hiding this comment.
Why not make 1 list with the file path and description per list item?
docs/ufp.md
Outdated
| * The thumbnail.png is a medium sized rendering of the 3D shape to show during file selection. There can be only one thumbnail. | ||
| * The model.gcode describes how a 3D printer should print a job. | ||
| * Possible content of Cura folder : | ||
| * *.xml.fdm_material – files describe materials specifications which might be needed for a print job. |
There was a problem hiding this comment.
Missing the material signature file (which is why this whole thing is needed).
docs/ufp.md
Outdated
| ## Notes: | ||
|
|
||
| * For the interchange of files between the Slicer and Printers, currently, ASCII GCODE files are used, in a specific Ultimaker flavor. | ||
| * In future development, the content of folder Cura might be changed. |
There was a problem hiding this comment.
This is kind of vague. In documentation you don't want to be vague.
| @@ -0,0 +1,25 @@ | |||
| # Ultimaker Format Package (UFP) | |||
There was a problem hiding this comment.
Overall the documentation is very marginal. I'm missing things like:
- The fact that it is based on the Open Packaging Convention
- More elaborate goal of the format (combine tool path + preview images + metadata)
- Backwards compatibility policy
- Versioning policy
- Implementation details in the libCharon library
- The plan to make this the default filetype for all UM printers
- Why it is different than 3MF (which could also have been an option, but we decided to not add the original 3D file which is a 3MF requirement)
- The plan to make it forward-compatible with 3MF if we ever decide to add the original 3D model anyways (for example for cloud based re-slicing)
- What is this Ultimaker G-code flavour?
- The allowed file type and size for the thumbnail
- Future support for multiple thumbnails (this was in the original spec iirc)
- A representative example?
- Probably some more things...
|
@nallath ping |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
So far as we do not have any documentation for UFP file extension I created a raw/simple version what it contains/might contain.