What to do with Draft_DXF (and similar)?

Discussions about the wiki documentation of FreeCAD and its translation.
Forum rules
Be nice to others! Respect the FreeCAD code of conduct!
Post Reply
User avatar
Roy_043
Veteran
Posts: 8578
Joined: Thu Dec 27, 2018 12:28 pm

What to do with Draft_DXF (and similar)?

Post by Roy_043 »

The pages listed below do not describe commands but software 'functions' that are used by Std_Open, Std_Import and Std_Export. I have started updating some of them but wonder if this is wise. The mentioned commands use many other software functions that do not have such dedicated pages, which makes me question these pages. Note: I am not suggesting the valuable information they contain should be scratched.

https://wiki.freecadweb.org/Arch_3DS
https://wiki.freecadweb.org/Arch_DAE
https://wiki.freecadweb.org/Arch_IFC
https://wiki.freecadweb.org/Arch_JSON
https://wiki.freecadweb.org/Arch_OBJ

https://wiki.freecadweb.org/Draft_DAT
https://wiki.freecadweb.org/Draft_DXF
https://wiki.freecadweb.org/Draft_OCA
https://wiki.freecadweb.org/Draft_SVG

Related: Some file formats (but only some...) have dedicated pages.

https://wiki.freecadweb.org/Bitmap
https://wiki.freecadweb.org/DXF
https://wiki.freecadweb.org/SVG
vocx
Veteran
Posts: 5197
Joined: Thu Oct 18, 2018 9:18 pm

Re: What to do with Draft_DXF (and similar)?

Post by vocx »

Roy_043 wrote: Tue Mar 03, 2020 9:39 am The pages listed below do not describe commands but software 'functions' that are used by Std_Open, Std_Import and Std_Export...
These pages describe formats that can be imported and exported by FreeCAD, by using the appropriate workbench. That is, Arch defines importers of 3DS, DAE, IFC, JSON, and OBJ, while Draft provides importers for DAT, DXF, OCA, and SVG. These pages should be listed in Arch Workbench and Draft Workbench.

I think the idea was to document how these files could be opened, and if there was other important information that the user should be aware of, like pre-requisites or limitations. I think every file type that can be opened by FreeCAD should have a page like this; it is disorganized at the moment, of course.

For example, why does Draft define the SVG importer? Why isn't it in a more central location? Or why does Arch define the DAE importer? Shouldn't it be in a central location, say, inside the Import module? Maybe. The problem is that a lot of this code is pretty old, and it is still a work in progress. We should probably update it at some point, but this will take time as we have a limited number of developers.
Related: Some file formats (but only some...) have dedicated pages.
https://wiki.freecadweb.org/Bitmap
https://wiki.freecadweb.org/DXF
https://wiki.freecadweb.org/SVG
I created these pages essentially so I could direct users from the forum to the documentation pages quickly. I can say Bitmap, DXF, and SVG, and that will lead them to the information they need. However, I haven't really used them much. I created these pages before I realized Draft_DXF, Draft_SVG, etc., already existed.

Maybe it makes sense to integrate that information in the corresponding pages, Draft_DXF, Draft_SVG, etc. If I'm not mistaken bitmaps are imported with the Image Workbench.
Always add the important information to your posts if you need help. Also see Tutorials and Video tutorials.
To support the documentation effort, and code development, your donation is appreciated: liberapay.com/FreeCAD.
User avatar
Roy_043
Veteran
Posts: 8578
Joined: Thu Dec 27, 2018 12:28 pm

Re: What to do with Draft_DXF (and similar)?

Post by Roy_043 »

@vocx: Thanks for your answer.
vocx wrote: Tue Mar 03, 2020 9:22 pm every file type that can be opened by FreeCAD should have a page like this
That would be a too ambitious target IMO. Both in terms of creating these pages and keeping them up to date.

But combining all info relating to the DXF format (f.e.) on fewer pages would be a good idea. This would make things more manageable.
vocx
Veteran
Posts: 5197
Joined: Thu Oct 18, 2018 9:18 pm

Re: What to do with Draft_DXF (and similar)?

Post by vocx »

Roy_043 wrote: Wed Mar 04, 2020 8:03 am That would be a too ambitious target IMO. Both in terms of creating these pages and keeping them up to date.
I don't think it's too ambitious, as the different file formats are handled by different workbenches. Therefore, the author of the particular code to read and export that format should take the initiative of creating these pages. The reason these Draft_ and Arch_ pages exist at all is precisely because the Draft and Arch author created them to track this.

Also, once the pages are created, they don't need to be updated very frequently as popular file formats are generally stable.
Always add the important information to your posts if you need help. Also see Tutorials and Video tutorials.
To support the documentation effort, and code development, your donation is appreciated: liberapay.com/FreeCAD.
Post Reply