Path Wiki Pages (Status)

Here's the place for discussion related to CAM/CNC and the development of the Path module.
User avatar
Kunda1
Posts: 7094
Joined: Thu Jan 05, 2017 9:03 pm

Path Wiki Pages (Status)

Postby Kunda1 » Thu Jan 16, 2020 5:45 pm

Fourth Axis - https://www.freecadweb.org/wiki/Fourth_Axis

Path Area - https://www.freecadweb.org/wiki/Path_Area (incomplete)
Path Area Workplane - https://www.freecadweb.org/wiki/Path_Area_Workplane (incomplete)
Image Path Array - https://www.freecadweb.org/wiki/Path_Array (incomplete)
Image Path Comment - https://www.freecadweb.org/wiki/Path_Comment
Image Path Contour - https://www.freecadweb.org/wiki/Path_Contour
Image Path Copy - https://www.freecadweb.org/wiki/Path_Copy
Image Path Custom - https://www.freecadweb.org/wiki/Path_Custom
Path DressupBoundary - https://www.freecadweb.org/wiki/Path_DressupBoundary
Path DressupDogbone - https://www.freecadweb.org/wiki/Path_DressupDogbone
Path DressupDragKnife - https://www.freecadweb.org/wiki/Path_DressupDragKnife
Image Path DressupLeadInOut - https://www.freecadweb.org/wiki/Path_DressupLeadInOut
Path DressupRampEntry - https://www.freecadweb.org/wiki/Path_DressupRampEntry
Path DressupTag - https://www.freecadweb.org/wiki/Path_DressupTag
Image Path Drilling - https://www.freecadweb.org/wiki/Path_Drilling
Image Path Engrave - https://www.freecadweb.org/wiki/Path_Engrave
Image Path ExportTemplate - https://www.freecadweb.org/wiki/Path_ExportTemplate
Path FAQ - https://www.freecadweb.org/wiki/Path_FAQ
Image Path Fixture - https://www.freecadweb.org/wiki/Path_Fixture
Image Path FromShapes - https://www.freecadweb.org/wiki/Path_FromShapes
Image Path Helix - https://www.freecadweb.org/wiki/Path_Helix
Image Path Inspect - https://www.freecadweb.org/wiki/Path_Inspect
Image Path Job - https://www.freecadweb.org/wiki/Path_Job
Image Path MillFace - https://www.freecadweb.org/wiki/Path_MillFace
Image Path OpActive - https://www.freecadweb.org/wiki/Path_OpActive
Path Pocket 3D - https://www.freecadweb.org/wiki/Path_Pocket_3D
Image Path Pocket Shape - https://www.freecadweb.org/wiki/Path_Pocket_Shape
Image Path Post - https://www.freecadweb.org/wiki/Path_Post
Path Preferences - https://www.freecadweb.org/wiki/Path_Preferences
Image Path Profile - https://www.freecadweb.org/wiki/Path_Profile
Image Path ProfileEdges - https://www.freecadweb.org/wiki/Path_ProfileEdges
Image Path ProfileFace - https://www.freecadweb.org/wiki/Path_ProfileFace
Path Sanity - https://www.freecadweb.org/wiki/Path_Sanity
Image Path SelectLoop - https://www.freecadweb.org/wiki/Path_SelectLoop
Image Path SimpleCopy - https://www.freecadweb.org/wiki/Path_SimpleCopy
Image Path Simulator - https://www.freecadweb.org/wiki/Path_Simulator
Image Path Stop - https://www.freecadweb.org/wiki/Path_Stop
Path Surface - https://www.freecadweb.org/wiki/Path_Surface
Image Path ToolLibraryEdit - https://www.freecadweb.org/wiki/Path_ToolLibraryEdit
Image Path Workbench - https://www.freecadweb.org/wiki/Path_Workbench

Image Path 3DPocket - https://www.freecadweb.org/wiki/Path_3DPocket (missing screenshot) Redirects to Path_Pocket_3D



Related Threads
Arch Wiki Pages - https://forum.freecadweb.org/viewtopic.php?f=23&t=42500
Draft Wiki Pages - https://forum.freecadweb.org/viewtopic.php?f=23&t=42501
FEM Wiki Pages - https://forum.freecadweb.org/viewtopic.php?f=18&t=20823
Sketcher Wiki Pages - https://forum.freecadweb.org/viewtopic. ... 2&p=360968
Want to contribute back to FC? Checkout:
#lowhangingfruit | Use the Source, Luke. | How to Help FreeCAD | How to report FC bugs and features
chrisb
Posts: 22579
Joined: Tue Mar 17, 2015 9:14 am

Re: Path Wiki Pages (Status)

Postby chrisb » Fri Jan 17, 2020 1:05 am

Did you really look at the documentation or is this some kind of a formal check? I'm afraid there is much more to do than what is suggested here.
User avatar
Kunda1
Posts: 7094
Joined: Thu Jan 05, 2017 9:03 pm

Re: Path Wiki Pages (Status)

Postby Kunda1 » Fri Jan 17, 2020 1:50 pm

chrisb wrote:
Fri Jan 17, 2020 1:05 am
Did you really look at the documentation or is this some kind of a formal check? I'm afraid there is much more to do than what is suggested here.
More like a Status Report. I'm trying to figure out a system that can be used to indicate if a wiki command page is complete.
There are several components to these pages:
  • GUIcommand Template
  • DocNavi Template
  • Screenshot
  • Sections
    • Description
    • How To Use
    • Limitations/Known Issues
    • Scripting
  • Translations
  • Categories
My idea is to somehow use emojis to indicate what is complete and/or incomplete.

Edit: Github AKA Markdown maybe a better way to do this
Want to contribute back to FC? Checkout:
#lowhangingfruit | Use the Source, Luke. | How to Help FreeCAD | How to report FC bugs and features
Russ4262
Posts: 376
Joined: Sat Jun 30, 2018 3:22 pm

Re: Path Wiki Pages (Status)

Postby Russ4262 » Fri Jan 17, 2020 3:34 pm

Use the wiki system itself.

We'll have to physically visit each page, paste missing section titles/templates. Within each empty section place a single link to a predetermined empty dummy page. Then, use wiki tools to find how many pages link to the dummy page; this would provide some sort of internal feedback, so long as contributors delete the link to the dummy page when they fill a section.

Just an idea.
This idea does have some flaws.

Russ
chrisb
Posts: 22579
Joined: Tue Mar 17, 2015 9:14 am

Re: Path Wiki Pages (Status)

Postby chrisb » Fri Jan 17, 2020 10:53 pm

I know you are a friend of emojis, while I have the feeling that they don't really make FreeCAD any better. All this organizing does not get the work done.
But I fully agree that we users should go for a big run on documentation improving before 0.19 gets stable.
User avatar
Kunda1
Posts: 7094
Joined: Thu Jan 05, 2017 9:03 pm

Re: Path Wiki Pages (Status)

Postby Kunda1 » Sat Jan 18, 2020 1:51 pm

chrisb wrote:
Fri Jan 17, 2020 10:53 pm
I know you are a friend of emojis, while I have the feeling that they don't really make FreeCAD any better. All this organizing does not get the work done.
But I fully agree that we users should go for a big run on documentation improving before 0.19 gets stable.
Emojis tracking the progress of completion of a Wiki FreeCAD command page is not useful?
It's an immediate visual queue showing if work needs to be done on said file. Which can be both informative and timesaving.
Want to contribute back to FC? Checkout:
#lowhangingfruit | Use the Source, Luke. | How to Help FreeCAD | How to report FC bugs and features
User avatar
Kunda1
Posts: 7094
Joined: Thu Jan 05, 2017 9:03 pm

Re: Path Wiki Pages (Status)

Postby Kunda1 » Sat Jan 18, 2020 1:52 pm

There are several Path commands that don't have dedicated icons. Can anyone confirm this?
Want to contribute back to FC? Checkout:
#lowhangingfruit | Use the Source, Luke. | How to Help FreeCAD | How to report FC bugs and features
chrisb
Posts: 22579
Joined: Tue Mar 17, 2015 9:14 am

Re: Path Wiki Pages (Status)

Postby chrisb » Sat Jan 18, 2020 2:00 pm

Kunda1 wrote:
Sat Jan 18, 2020 1:52 pm
There are several Path commands that don't have dedicated icons. Can anyone confirm this?
Yes, e.g. the dressups
Russ4262
Posts: 376
Joined: Sat Jun 30, 2018 3:22 pm

Re: Path Wiki Pages (Status)

Postby Russ4262 » Sat Jan 18, 2020 2:01 pm

Kunda1 wrote:
Sat Jan 18, 2020 1:51 pm
It's an immediate visual queue showing if work needs to be done on said file. Which can be both informative and timesaving.


Not to mention, they are also colorful and emotionally stimulating. In a world of boolean if statements, this goes a long way.

:D
JustinClift
Posts: 19
Joined: Tue Jan 14, 2020 12:58 pm
Location: Australia

Re: Path Wiki Pages (Status)

Postby JustinClift » Sat Jan 18, 2020 3:15 pm

Related to this, the "Depths and Heights" picture used in several Path wiki pages has a typo for an unfortunately important phrase.

"Save Height" should be "Safe Height"

@chrisb seems to be the author. Hopefully it's an easy fix? :)

Image

Source: https://www.freecadweb.org/wiki/File:Pa ... eights.gif