Volunteers: Unfinished Wiki pages for Part Workbench

[Kunda1]

Per https://wiki.freecadweb.org/index.php?t ... nishedDocu
the following Part WB wiki pages are marked incomplete:

• Part BoxSelection
• Part ElementCopy
• Part Ellipse
• Part Ellipsoid
• Part Helix
• Part Line
• Part Loft
• Part Mirror
• Part Offset
• Part Plane
• Part Point
• Part PointsFromMesh
• Part Prism
• Part RegularPolygon
• Part RuledSurface
• Part Spiral
• Part TransformedCopy
• Part Wedge

[Kunda1]

bump

TODO:
We need sections for
* scripting
* limitations
* notes

[Roy_043]

The pages that have been marked seem a somewhat arbitrary selection. I would say that the whole Part WB documentation needs to be reworked.

[onekk]

I hope that some of the work already done in this post could be a start for a new way of documenting FreeCAD.

https://forum.freecadweb.org/viewtopic. ... 81#p568581

Maybe here is OT, maybe not, as some more work could lead to some sort of automatic generation, or maybe some "poking" to the developer on making more "relevant" DocString could lead to a more quick update of existing pages when something change.

I've not experimented more with HTML generation from latex, but maybe it is feasible to put together some rules that will generate some decent starting point with many part automated in some way.

Regards

Carlo D.

[C4e]

I hope that some of the work already done in this post could be a start for a new way of documenting FreeCAD.

https://forum.freecadweb.org/viewtopic. ... 81#p568581

Maybe here is OT, maybe not, as some more work could lead to some sort of automatic generation, or maybe some "poking" to the developer on making more "relevant" DocString could lead to a more quick update of existing pages when something change.

I've not experimented more with HTML generation from latex, but maybe it is feasible to put together some rules that will generate some decent starting point with many part automated in some way.

Regards

Carlo D.

I think, that developer generated DocString comments is a good way or base to make a good wiki. Both parts are complete different kind of things.

And a cheat sheet for functions is although not a function documentation. Please do not stop your great work on the cheat sheet.

From my point of view, we need a good documentation template and a little set of basic rules to make a consistent and clear wiki inside a workbench.

[C4e]

bump

TODO:
We need sections for
* scripting
* limitations
* notes

Done.

[Roy_043]

Adding headings is a start. But you should avoid duplicate headings.

[Roy_043]

Part CompCompoundTools

This page should not be on the list. Can you remove it from the OP please? Thanks.

[Kunda1]

This page should not be on the list. Can you remove it from the OP please? Thanks.

Done

[C4e]

Adding headings is a start. But you should avoid duplicate headings.

Sorry for the circumstances. I missed that.

Is the Properties section of the Part Box wiki page a good example?

I inserted a scripting example to the Part Circle wiki page.